AnalyzeTextOptions Class

Definition

Specifies some text and analysis components used to break that text into tokens.

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

Constructors

Name Description
AnalyzeTextOptions(String, LexicalAnalyzerName)

Initializes a new instance of AnalyzeRequest.

AnalyzeTextOptions(String, LexicalTokenizerName)

Initializes a new instance of AnalyzeRequest.

AnalyzeTextOptions(String)

Initializes a new instance of AnalyzeTextOptions.

Properties

Name Description
AnalyzerName

The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive.

CharFilters

An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.

NormalizerName

The name of the normalizer to use to normalize the given text.

Text

The text to break into tokens.

TokenFilters

An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter.

TokenizerName

The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive.

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)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AnalyzeTextOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AnalyzeTextOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AnalyzeTextOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AnalyzeTextOptions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to