Class SynonymGraphTokenFilterDescriptor

Inheritance
object
DescriptorBase<SynonymGraphTokenFilterDescriptor, ISynonymGraphTokenFilter>
TokenFilterDescriptorBase<SynonymGraphTokenFilterDescriptor, ISynonymGraphTokenFilter>
SynonymGraphTokenFilterDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SynonymGraphTokenFilterDescriptor : TokenFilterDescriptorBase<SynonymGraphTokenFilterDescriptor, ISynonymGraphTokenFilter>, IDescriptor, ISynonymGraphTokenFilter, 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 SynonymGraphTokenFilterDescriptor Expand(bool? expand = true)
Parameters
Type Name Description
bool? expand
Returns
Type Description
SynonymGraphTokenFilterDescriptor
| Edit this page View Source

Format(SynonymFormat?)

Declaration
public SynonymGraphTokenFilterDescriptor Format(SynonymFormat? format)
Parameters
Type Name Description
SynonymFormat? format
Returns
Type Description
SynonymGraphTokenFilterDescriptor
| 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 SynonymGraphTokenFilterDescriptor Lenient(bool? lenient = true)
Parameters
Type Name Description
bool? lenient
Returns
Type Description
SynonymGraphTokenFilterDescriptor
| Edit this page View Source

Synonyms(IEnumerable<string>)

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

Synonyms(params string[])

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

SynonymsPath(string)

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

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

Tokenizer(string)

Declaration
public SynonymGraphTokenFilterDescriptor Tokenizer(string tokenizer)
Parameters
Type Name Description
string tokenizer
Returns
Type Description
SynonymGraphTokenFilterDescriptor
| 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 SynonymGraphTokenFilterDescriptor Updateable(bool? updateable = true)
Parameters
Type Name Description
bool? updateable
Returns
Type Description
SynonymGraphTokenFilterDescriptor

Implements

Extension Methods