SearchModelFactory.PhoneticTokenFilter Method

Definition

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

public static Azure.Search.Documents.Indexes.Models.PhoneticTokenFilter PhoneticTokenFilter(string name = default, Azure.Search.Documents.Indexes.Models.PhoneticEncoder? encoder = default, bool? replaceOriginalTokens = default);
static member PhoneticTokenFilter : string * Nullable<Azure.Search.Documents.Indexes.Models.PhoneticEncoder> * Nullable<bool> -> Azure.Search.Documents.Indexes.Models.PhoneticTokenFilter
Public Shared Function PhoneticTokenFilter (Optional name As String = Nothing, Optional encoder As Nullable(Of PhoneticEncoder) = Nothing, Optional replaceOriginalTokens As Nullable(Of Boolean) = Nothing) As PhoneticTokenFilter

Parameters

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.

encoder
Nullable<PhoneticEncoder>

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

replaceOriginalTokens
Nullable<Boolean>

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

Returns

A new PhoneticTokenFilter instance for mocking.

Applies to