AnalyzeTextOptionsOutput interface

The text analysis request.

Properties

blocklistNames

The names of blocklists.

categories

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

haltOnBlocklistHit

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.

outputType

This refers to the type of text analysis output. If no value is assigned, the default value will be "FourSeverityLevels".

Possible values: FourSeverityLevels, EightSeverityLevels

text

The text needs to be analyzed. We support a maximum of 10k Unicode characters (Unicode code points) in the text of one request.

Property Details

blocklistNames

The names of blocklists.

blocklistNames?: string[]

Property Value

string[]

categories

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

categories?: string[]

Property Value

string[]

haltOnBlocklistHit

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.

haltOnBlocklistHit?: boolean

Property Value

boolean

outputType

This refers to the type of text analysis output. If no value is assigned, the default value will be "FourSeverityLevels".

Possible values: FourSeverityLevels, EightSeverityLevels

outputType?: string

Property Value

string

text

The text needs to be analyzed. We support a maximum of 10k Unicode characters (Unicode code points) in the text of one request.

text: string

Property Value

string