Class PhoneticTokenFilter

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

Inheritance
object
TokenFilterBase
PhoneticTokenFilter
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PhoneticTokenFilter : TokenFilterBase, IPhoneticTokenFilter, ITokenFilter
Remarks

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

Constructors

| Edit this page View Source

PhoneticTokenFilter()

Declaration
public PhoneticTokenFilter()

Properties

| Edit this page View Source

Encoder

The type of phonetic encoding to use

Declaration
public PhoneticEncoder? Encoder { get; set; }
Property Value
Type Description
PhoneticEncoder?
| Edit this page View Source

LanguageSet

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

Declaration
public IEnumerable<PhoneticLanguage> LanguageSet { get; set; }
Property Value
Type Description
IEnumerable<PhoneticLanguage>
Remarks

Valid for Beidermorse only

| Edit this page View Source

MaxCodeLength

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

Declaration
public int? MaxCodeLength { get; set; }
Property Value
Type Description
int?
Remarks

Valid for DoubleMetaphone only

| Edit this page View Source

NameType

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

Declaration
public PhoneticNameType? NameType { get; set; }
Property Value
Type Description
PhoneticNameType?
Remarks

Valid for Beidermorse only

| Edit this page View Source

Replace

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 bool? Replace { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

RuleType

Whether matching should be exact or approximate. Defaults to approximate

Declaration
public PhoneticRuleType? RuleType { get; set; }
Property Value
Type Description
PhoneticRuleType?
Remarks

Valid for Beidermorse only

Implements

Extension Methods