PathHierarchyTokenizer interface

Package:

@azure/search-documents

Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.

Extends

BaseLexicalTokenizer

Properties

delimiter	The delimiter character to use. Default is "/".
maxTokenLength	The maximum token length. Default and maximum is 300.
numberOfTokensToSkip	The number of initial tokens to skip. Default is 0.
odatatype	Polymorphic discriminator, which specifies the different types this object can be
replacement	A value that, if set, replaces the delimiter character. Default is "/".
reverseTokenOrder	A value indicating whether to generate tokens in reverse order. Default is false.

Inherited Properties

name	The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

Property Details

delimiter

The delimiter character to use. Default is "/".

delimiter?: string

Property Value

string

maxTokenLength

The maximum token length. Default and maximum is 300.

maxTokenLength?: number

Property Value

number

numberOfTokensToSkip

The number of initial tokens to skip. Default is 0.

numberOfTokensToSkip?: number

Property Value

number

odatatype

Polymorphic discriminator, which specifies the different types this object can be

odatatype: "#Microsoft.Azure.Search.PathHierarchyTokenizerV2"

Property Value

"#Microsoft.Azure.Search.PathHierarchyTokenizerV2"

replacement

A value that, if set, replaces the delimiter character. Default is "/".

replacement?: string

Property Value

string

reverseTokenOrder

A value indicating whether to generate tokens in reverse order. Default is false.

reverseTokenOrder?: boolean

Property Value

boolean

Inherited Property Details

name

The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

name: string

Property Value

string

Inherited From BaseLexicalTokenizer.name