Lingua

AnalyzeTextOptions Class

Definition

The text analysis request.

public class AnalyzeTextOptions
public class AnalyzeTextOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.ContentSafety.AnalyzeTextOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.ContentSafety.AnalyzeTextOptions>
type AnalyzeTextOptions = class
type AnalyzeTextOptions = class
    interface IJsonModel<AnalyzeTextOptions>
    interface IPersistableModel<AnalyzeTextOptions>
Public Class AnalyzeTextOptions
Public Class AnalyzeTextOptions
Implements IJsonModel(Of AnalyzeTextOptions), IPersistableModel(Of AnalyzeTextOptions)
Inheritance
AnalyzeTextOptions
Implements

Constructors

Name Description
AnalyzeTextOptions(String)

Initializes a new instance of AnalyzeTextOptions.

Properties

Name Description
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".

Text

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

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Implicit(AnalyzeTextOptions to RequestContent)

Explicit Interface Implementations

Name Description
IJsonModel<AnalyzeTextOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AnalyzeTextOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AnalyzeTextOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AnalyzeTextOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AnalyzeTextOptions>.Write(ModelReaderWriterOptions)

Applies to