PhoneticTokenFilter | @azure/search

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

Hierarchy

PhoneticTokenFilter

Index

Properties

encoder
name
odatatype
replaceOriginalTokens

Properties

Optional encoder

encoder: PhoneticEncoder

The phonetic encoder to use. Default is "metaphone". Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse'

name

name: string

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.

odatatype

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

Polymorphic Discriminator

Optional replaceOriginalTokens

replaceOriginalTokens: undefined | false | true

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