AnalyzeTextOptions interface

Package:

@azure-rest/ai-content-safety

The analysis request of the text.

Properties

blocklistNames	The names of blocklists.
breakByBlocklists	When set to true, further analyses of harmful content will not be performed in cases where blocklists are hit. When set to false, all analyses of harmful content will be performed, whether or not blocklists are hit.
categories	The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.
text	The text needs to be scanned. We support at most 1000 characters (unicode code points) in text of one request.

Property Details

blocklistNames

The names of blocklists.

blocklistNames?: string[]

Property Value

string[]

breakByBlocklists

When set to true, further analyses of harmful content will not be performed in cases where blocklists are hit. When set to false, all analyses of harmful content will be performed, whether or not blocklists are hit.

breakByBlocklists?: boolean

Property Value

boolean

categories

The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.

categories?: string[]

Property Value

string[]

text

The text needs to be scanned. We support at most 1000 characters (unicode code points) in text of one request.

text: string

Property Value

string