AnalyzeRequest interface

  • Reference
Package:
@azure/search-documents

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

Properties

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. KnownAnalyzerNames is an enum containing built-in analyzer names. NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.
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.
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. KnownTokenizerNames is an enum containing built-in tokenizer names. NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.

Property Details

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. KnownAnalyzerNames is an enum containing built-in analyzer names. NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.

analyzerName?: string

Property Value

string

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.

charFilters?: string[]

Property Value

string[]

text

The text to break into tokens.

text: string

Property Value

string

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.

tokenFilters?: string[]

Property Value

string[]

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. KnownTokenizerNames is an enum containing built-in tokenizer names. NOTE: Either analyzerName or tokenizerName is required in an AnalyzeRequest.

tokenizerName?: string

Property Value

string