Class SynonymTokenFilterDescriptor

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

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

Expand(bool?)

Declaration
public SynonymTokenFilterDescriptor Expand(bool? expand = true)
Parameters
Type Name Description
bool? expand
Returns
Type Description
SynonymTokenFilterDescriptor
| Edit this page View Source

Format(SynonymFormat?)

Declaration
public SynonymTokenFilterDescriptor Format(SynonymFormat? format)
Parameters
Type Name Description
SynonymFormat? format
Returns
Type Description
SynonymTokenFilterDescriptor
| Edit this page View Source

Lenient(bool?)

If true ignores exceptions while parsing the synonym configuration. It is important to note that only those synonym rules which cannot get parsed are ignored.

Declaration
public SynonymTokenFilterDescriptor Lenient(bool? lenient = true)
Parameters
Type Name Description
bool? lenient
Returns
Type Description
SynonymTokenFilterDescriptor
| Edit this page View Source

Synonyms(IEnumerable<string>)

Declaration
public SynonymTokenFilterDescriptor Synonyms(IEnumerable<string> synonyms)
Parameters
Type Name Description
IEnumerable<string> synonyms
Returns
Type Description
SynonymTokenFilterDescriptor
| Edit this page View Source

Synonyms(params string[])

Declaration
public SynonymTokenFilterDescriptor Synonyms(params string[] synonyms)
Parameters
Type Name Description
string[] synonyms
Returns
Type Description
SynonymTokenFilterDescriptor
| Edit this page View Source

SynonymsPath(string)

a path a synonyms file relative to the node's config location.

Declaration
public SynonymTokenFilterDescriptor SynonymsPath(string path)
Parameters
Type Name Description
string path
Returns
Type Description
SynonymTokenFilterDescriptor
| Edit this page View Source

Tokenizer(string)

Declaration
public SynonymTokenFilterDescriptor Tokenizer(string tokenizer)
Parameters
Type Name Description
string tokenizer
Returns
Type Description
SynonymTokenFilterDescriptor
| Edit this page View Source

Updateable(bool?)

Whether this token filter can reload changes to synonym files on demand. Marking as updateable means this component is only usable at search time

Declaration
public SynonymTokenFilterDescriptor Updateable(bool? updateable = true)
Parameters
Type Name Description
bool? updateable
Returns
Type Description
SynonymTokenFilterDescriptor

Implements

Extension Methods