AnalyzedTokenInfo interface

Package:

@azure/search-documents

Information about a token returned by an analyzer.

Properties

endOffset	The index of the last character of the token in the input text. NOTE: This property will not be serialized. It can only be populated by the server.
position	The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other. NOTE: This property will not be serialized. It can only be populated by the server.
startOffset	The index of the first character of the token in the input text. NOTE: This property will not be serialized. It can only be populated by the server.
token	The token returned by the analyzer. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

endOffset

The index of the last character of the token in the input text. NOTE: This property will not be serialized. It can only be populated by the server.

endOffset: number

Property Value

number

position

The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other. NOTE: This property will not be serialized. It can only be populated by the server.

position: number

Property Value

number

startOffset

The index of the first character of the token in the input text. NOTE: This property will not be serialized. It can only be populated by the server.

startOffset: number

Property Value

number

token

The token returned by the analyzer. NOTE: This property will not be serialized. It can only be populated by the server.

token: string

Property Value

string