ShingleTokenFilter interface

  • Reference
Package:
@azure/search-documents

Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.

Extends
BaseTokenFilter

Properties

filterToken

The string to insert for each position at which there is no token. Default is an underscore ("_").
maxShingleSize

The maximum shingle size. Default and minimum value is 2.
minShingleSize

The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize.
odatatype

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

A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true.
outputUnigramsIfNoShingles

A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false.
tokenSeparator

The string to use when joining adjacent tokens to form a shingle. Default is a single space (" ").

Inherited Properties

name

The name of the token filter. 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

filterToken

The string to insert for each position at which there is no token. Default is an underscore ("_").

filterToken?: string

Property Value

string

maxShingleSize

The maximum shingle size. Default and minimum value is 2.

maxShingleSize?: number

Property Value

number

minShingleSize

The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize.

minShingleSize?: number

Property Value

number

odatatype

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

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

Property Value

"#Microsoft.Azure.Search.ShingleTokenFilter"

outputUnigrams

A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true.

outputUnigrams?: boolean

Property Value

boolean

outputUnigramsIfNoShingles

A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false.

outputUnigramsIfNoShingles?: boolean

Property Value

boolean

tokenSeparator

The string to use when joining adjacent tokens to form a shingle. Default is a single space (" ").

tokenSeparator?: string

Property Value

string

Inherited Property Details

name

The name of the token filter. 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 BaseTokenFilter.name