PhoneticTokenFilter Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

PhoneticTokenFilter.cs

Create tokens for phonetic matches. This token filter is implemented using Apache Lucene. https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html

[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.PhoneticTokenFilter")]
public class PhoneticTokenFilter : Microsoft.Azure.Search.Models.TokenFilter

[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.PhoneticTokenFilter")>]
type PhoneticTokenFilter = class
    inherit TokenFilter

Public Class PhoneticTokenFilter
Inherits TokenFilter

Inheritance

Object

TokenFilter

PhoneticTokenFilter

Attributes

Newtonsoft.Json.JsonObjectAttribute

Constructors

PhoneticTokenFilter()	Initializes a new instance of the PhoneticTokenFilter class.
PhoneticTokenFilter(String, Nullable<PhoneticEncoder>, Nullable<Boolean>)	Initializes a new instance of the PhoneticTokenFilter class.

Properties

Encoder	Gets or sets the phonetic encoder to use. Default is "metaphone". Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse'
Name	Gets or sets 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. (Inherited from TokenFilter)
ReplaceOriginalTokens	Gets or sets a value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.

Methods

Validate()

Validate the object.