Class PhoneticTokenFilterDescriptor

A token filter that converts tokens to their phonetic representation using Soundex, Metaphone, and a variety of other algorithms.

Inheritance
object
DescriptorBase<PhoneticTokenFilterDescriptor, IPhoneticTokenFilter>
TokenFilterDescriptorBase<PhoneticTokenFilterDescriptor, IPhoneticTokenFilter>
PhoneticTokenFilterDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PhoneticTokenFilterDescriptor : TokenFilterDescriptorBase<PhoneticTokenFilterDescriptor, IPhoneticTokenFilter>, IDescriptor, IPhoneticTokenFilter, ITokenFilter
Remarks

Requires the Phonetic Analysis plugin be installed (analysis-phonetic)

Properties

| Edit this page View Source

Type

Declaration
protected override string Type { get; }
Property Value
Type Description
string
Overrides

Methods

| Edit this page View Source

Encoder(PhoneticEncoder?)

The type of phonetic encoding to use

Declaration
public PhoneticTokenFilterDescriptor Encoder(PhoneticEncoder? encoder)
Parameters
Type Name Description
PhoneticEncoder? encoder
Returns
Type Description
PhoneticTokenFilterDescriptor
| Edit this page View Source

LanguageSet(params PhoneticLanguage[])

An array of languages to check. If not specified, then the language will be guessed

Declaration
public PhoneticTokenFilterDescriptor LanguageSet(params PhoneticLanguage[] languageSet)
Parameters
Type Name Description
PhoneticLanguage[] languageSet
Returns
Type Description
PhoneticTokenFilterDescriptor
Remarks

Valid for Beidermorse only

| Edit this page View Source

LanguageSet(IEnumerable<PhoneticLanguage>)

An array of languages to check. If not specified, then the language will be guessed

Declaration
public PhoneticTokenFilterDescriptor LanguageSet(IEnumerable<PhoneticLanguage> languageSet)
Parameters
Type Name Description
IEnumerable<PhoneticLanguage> languageSet
Returns
Type Description
PhoneticTokenFilterDescriptor
Remarks

Valid for Beidermorse only

| Edit this page View Source

MaxCodeLength(int?)

The maximum length of the emitted metaphone token. Defaults to 4

Declaration
public PhoneticTokenFilterDescriptor MaxCodeLength(int? maxCodeLength)
Parameters
Type Name Description
int? maxCodeLength
Returns
Type Description
PhoneticTokenFilterDescriptor
Remarks

Valid for DoubleMetaphone only

| Edit this page View Source

NameType(PhoneticNameType?)

Whether names are ashkenazi, sephardic, or generic. Defaults to generic

Declaration
public PhoneticTokenFilterDescriptor NameType(PhoneticNameType? nameType)
Parameters
Type Name Description
PhoneticNameType? nameType
Returns
Type Description
PhoneticTokenFilterDescriptor
Remarks

Valid for Beidermorse only

| Edit this page View Source

Replace(bool?)

The replace parameter (defaults to true) controls if the token processed should be replaced with the encoded one (set it to true), or added (set it to false).

Declaration
public PhoneticTokenFilterDescriptor Replace(bool? replace = true)
Parameters
Type Name Description
bool? replace
Returns
Type Description
PhoneticTokenFilterDescriptor
| Edit this page View Source

RuleType(PhoneticRuleType?)

Whether matching should be exact or approximate. Defaults to approximate

Declaration
public PhoneticTokenFilterDescriptor RuleType(PhoneticRuleType? ruleType)
Parameters
Type Name Description
PhoneticRuleType? ruleType
Returns
Type Description
PhoneticTokenFilterDescriptor
Remarks

Valid for Beidermorse only

Implements

Extension Methods