PhoneticTokenFilter interface

Package:

@azure/search-documents

Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.

Extends

BaseTokenFilter

Properties

encoder	The phonetic encoder to use. Default is "metaphone".
odatatype	Polymorphic discriminator, which specifies the different types this object can be
replaceOriginalTokens	A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.

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

encoder

The phonetic encoder to use. Default is "metaphone".

encoder?: PhoneticEncoder

Property Value

PhoneticEncoder

odatatype

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

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

Property Value

"#Microsoft.Azure.Search.PhoneticTokenFilter"

replaceOriginalTokens

A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.

replaceOriginalTokens?: boolean

Property Value

boolean

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