Class AnalyzersDescriptor

Inheritance

object

DescriptorPromiseBase<AnalyzersDescriptor, IAnalyzers>

IsADictionaryDescriptorBase<AnalyzersDescriptor, IAnalyzers, string, IAnalyzer>

AnalyzersDescriptor

Implements

IDescriptor

IPromise<IAnalyzers>

Inherited Members

IsADictionaryDescriptorBase<AnalyzersDescriptor, IAnalyzers, string, IAnalyzer>.Assign(string, IAnalyzer)

DescriptorPromiseBase<AnalyzersDescriptor, IAnalyzers>.Self

DescriptorPromiseBase<AnalyzersDescriptor, IAnalyzers>.Assign(Action<IAnalyzers>)

DescriptorPromiseBase<AnalyzersDescriptor, IAnalyzers>.Assign<TNewValue>(TNewValue, Action<IAnalyzers, TNewValue>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class AnalyzersDescriptor : IsADictionaryDescriptorBase<AnalyzersDescriptor, IAnalyzers, string, IAnalyzer>, IDescriptor, IPromise<IAnalyzers>

Constructors

AnalyzersDescriptor()

Declaration

public AnalyzersDescriptor()

Methods

Custom(string, Func<CustomAnalyzerDescriptor, ICustomAnalyzer>)

An analyzer of type custom that allows to combine a Tokenizer with zero or more Token Filters, and zero or more Char Filters.

The custom analyzer accepts a logical/registered name of the tokenizer to use, and a list of logical/registered names of token filters.

Declaration

public AnalyzersDescriptor Custom(string name, Func<CustomAnalyzerDescriptor, ICustomAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<CustomAnalyzerDescriptor, ICustomAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Fingerprint(string, Func<FingerprintAnalyzerDescriptor, IFingerprintAnalyzer>)

An analyzer of type fingerprint that implements a fingerprinting algorithm which is used by the OpenRefine project to assist in clustering.

Declaration

public AnalyzersDescriptor Fingerprint(string name, Func<FingerprintAnalyzerDescriptor, IFingerprintAnalyzer> selector = null)

Parameters

Type	Name	Description
string	name
Func<FingerprintAnalyzerDescriptor, IFingerprintAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Icu(string, Func<IcuAnalyzerDescriptor, IIcuAnalyzer>)

An ICU analyzer that performs basic normalization, tokenization and character folding, using the IIcuNormalizationCharFilter char filter, IIcuTokenizer and IcuNormalizationTokenFilter token filter

Declaration

public AnalyzersDescriptor Icu(string name, Func<IcuAnalyzerDescriptor, IIcuAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<IcuAnalyzerDescriptor, IIcuAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Remarks

Requires analysis-icu plugin to be installed

Keyword(string, Func<KeywordAnalyzerDescriptor, IKeywordAnalyzer>)

An analyzer of type keyword that “tokenizes” an entire stream as a single token. This is useful for data like zip codes, ids and so on.

Note, when using mapping definitions, it make more sense to simply mark the field as not_analyzed.

Declaration

public AnalyzersDescriptor Keyword(string name, Func<KeywordAnalyzerDescriptor, IKeywordAnalyzer> selector = null)

Parameters

Type	Name	Description
string	name
Func<KeywordAnalyzerDescriptor, IKeywordAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Kuromoji(string, Func<KuromojiAnalyzerDescriptor, IKuromojiAnalyzer>)

An analyzer tailored for japanese that is bootstrapped with defaults. Part of the analysis-kuromoji plugin:

Declaration

public AnalyzersDescriptor Kuromoji(string name, Func<KuromojiAnalyzerDescriptor, IKuromojiAnalyzer> selector = null)

Parameters

Type	Name	Description
string	name
Func<KuromojiAnalyzerDescriptor, IKuromojiAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Language(string, Func<LanguageAnalyzerDescriptor, ILanguageAnalyzer>)

A set of analyzers aimed at analyzing specific language text.

Declaration

public AnalyzersDescriptor Language(string name, Func<LanguageAnalyzerDescriptor, ILanguageAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<LanguageAnalyzerDescriptor, ILanguageAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Nori(string, Func<NoriAnalyzerDescriptor, INoriAnalyzer>)

The nori analyzer consists of the following tokenizer and token filters:

- nori_tokenizer

- nori_part_of_speech token filter

- nori_readingform token filter

- nori_number token filter

- lowercase token filter

Declaration

public AnalyzersDescriptor Nori(string name, Func<NoriAnalyzerDescriptor, INoriAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<NoriAnalyzerDescriptor, INoriAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Pattern(string, Func<PatternAnalyzerDescriptor, IPatternAnalyzer>)

An analyzer of type pattern that can flexibly separate text into terms via a regular expression.

Declaration

public AnalyzersDescriptor Pattern(string name, Func<PatternAnalyzerDescriptor, IPatternAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<PatternAnalyzerDescriptor, IPatternAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Simple(string, Func<SimpleAnalyzerDescriptor, ISimpleAnalyzer>)

An analyzer of type simple that is built using a Lower Case Tokenizer.

Declaration

public AnalyzersDescriptor Simple(string name, Func<SimpleAnalyzerDescriptor, ISimpleAnalyzer> selector = null)

Parameters

Type	Name	Description
string	name
Func<SimpleAnalyzerDescriptor, ISimpleAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Snowball(string, Func<SnowballAnalyzerDescriptor, ISnowballAnalyzer>)

An analyzer of type snowball that uses the standard tokenizer, with standard filter, lowercase filter, stop filter, and snowball filter.

The Snowball Analyzer is a stemming analyzer from Lucene that is originally based on the snowball project from snowball.tartarus.org.

Declaration

public AnalyzersDescriptor Snowball(string name, Func<SnowballAnalyzerDescriptor, ISnowballAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<SnowballAnalyzerDescriptor, ISnowballAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Standard(string, Func<StandardAnalyzerDescriptor, IStandardAnalyzer>)

An analyzer of type standard that is built of using Standard Tokenizer, with Standard Token Filter, Lower Case Token Filter, and Stop Token Filter.

Declaration

public AnalyzersDescriptor Standard(string name, Func<StandardAnalyzerDescriptor, IStandardAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<StandardAnalyzerDescriptor, IStandardAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Stop(string, Func<StopAnalyzerDescriptor, IStopAnalyzer>)

An analyzer of type stop that is built using a Lower Case Tokenizer, with Stop Token Filter.

Declaration

public AnalyzersDescriptor Stop(string name, Func<StopAnalyzerDescriptor, IStopAnalyzer> selector)

Parameters

Type	Name	Description
string	name
Func<StopAnalyzerDescriptor, IStopAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

UserDefined(string, IAnalyzer)

Declaration

public AnalyzersDescriptor UserDefined(string name, IAnalyzer analyzer)

Parameters

Type	Name	Description
string	name
IAnalyzer	analyzer

Returns

Type	Description
AnalyzersDescriptor

Whitespace(string, Func<WhitespaceAnalyzerDescriptor, IWhitespaceAnalyzer>)

An analyzer of type whitespace that is built using a Whitespace Tokenizer.

Declaration

public AnalyzersDescriptor Whitespace(string name, Func<WhitespaceAnalyzerDescriptor, IWhitespaceAnalyzer> selector = null)

Parameters

Type	Name	Description
string	name
Func<WhitespaceAnalyzerDescriptor, IWhitespaceAnalyzer>	selector

Returns

Type	Description
AnalyzersDescriptor

Implements

IDescriptor

IPromise<TValue>

Extension Methods

SuffixExtensions.Suffix(object, string)