PhoneticTokenFilter Class

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

All required parameters must be populated in order to send to Azure.

Inheritance

azure.search.documents.indexes._generated.models._models_py3.TokenFilter

PhoneticTokenFilter

Constructor

PhoneticTokenFilter(*, name: str, encoder: Optional[Union[str, azure.search.documents.indexes._generated.models._search_client_enums.PhoneticEncoder]] = None, replace_original_tokens: Optional[bool] = True, **kwargs)

Parameters

odata_type

str

Required

Required. Identifies the concrete type of the token filter.Constant filled by server.

name

str

Required

Required. 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.

encoder

str or PhoneticEncoder

Required

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

replace_original_tokens

bool

Required

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