Class AnalyzeDescriptor

Descriptor for Analyze

https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/

Inheritance
object
RequestBase<AnalyzeRequestParameters>
RequestDescriptorBase<AnalyzeDescriptor, AnalyzeRequestParameters, IAnalyzeRequest>
AnalyzeDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AnalyzeDescriptor : RequestDescriptorBase<AnalyzeDescriptor, AnalyzeRequestParameters, IAnalyzeRequest>, IDescriptor, IAnalyzeRequest, IRequest<AnalyzeRequestParameters>, IRequest

Constructors

| Edit this page View Source

AnalyzeDescriptor()

/_analyze

Declaration
public AnalyzeDescriptor()
| Edit this page View Source

AnalyzeDescriptor(IndexName)

/{index}/_analyze

Declaration
public AnalyzeDescriptor(IndexName index)
Parameters
Type Name Description
IndexName index

Optional, accepts null

Methods

| Edit this page View Source

Analyzer(string)

The name of the analyzer to use

Declaration
public AnalyzeDescriptor Analyzer(string analyser)
Parameters
Type Name Description
string analyser
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Attributes(IEnumerable<string>)

Filter only certain token attributes to be returned

Declaration
public AnalyzeDescriptor Attributes(IEnumerable<string> attributes)
Parameters
Type Name Description
IEnumerable<string> attributes
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Attributes(params string[])

Filter only certain token attributes to be returned

Declaration
public AnalyzeDescriptor Attributes(params string[] attributes)
Parameters
Type Name Description
string[] attributes
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

CharFilter(IEnumerable<string>)

A collection of character filters to use for the analysis

Declaration
public AnalyzeDescriptor CharFilter(IEnumerable<string> charFilter)
Parameters
Type Name Description
IEnumerable<string> charFilter
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

CharFilter(Func<AnalyzeCharFiltersDescriptor, IPromise<AnalyzeCharFilters>>)

A collection of character filters to use for the analysis

Declaration
public AnalyzeDescriptor CharFilter(Func<AnalyzeCharFiltersDescriptor, IPromise<AnalyzeCharFilters>> charFilters)
Parameters
Type Name Description
Func<AnalyzeCharFiltersDescriptor, IPromise<AnalyzeCharFilters>> charFilters
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

CharFilter(params string[])

A collection of character filters to use for the analysis

Declaration
public AnalyzeDescriptor CharFilter(params string[] charFilter)
Parameters
Type Name Description
string[] charFilter
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Explain(bool?)

Return more details, and output the analyzer chain per step in the process

Declaration
public AnalyzeDescriptor Explain(bool? explain = true)
Parameters
Type Name Description
bool? explain
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Field(Field)

Use the analyzer configured for this field (instead of passing the analyzer name)

Declaration
public AnalyzeDescriptor Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Field<T>(Expression<Func<T, object>>)

Use the analyzer configured for this field (instead of passing the analyzer name)

Declaration
public AnalyzeDescriptor Field<T>(Expression<Func<T, object>> field)
Parameters
Type Name Description
Expression<Func<T, object>> field
Returns
Type Description
AnalyzeDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Field<T, TValue>(Expression<Func<T, TValue>>)

Use the analyzer configured for this field (instead of passing the analyzer name)

Declaration
public AnalyzeDescriptor Field<T, TValue>(Expression<Func<T, TValue>> field)
Parameters
Type Name Description
Expression<Func<T, TValue>> field
Returns
Type Description
AnalyzeDescriptor
Type Parameters
Name Description
T
TValue
| Edit this page View Source

Filter(IEnumerable<string>)

A collection of filters to use for the analysis

Declaration
public AnalyzeDescriptor Filter(IEnumerable<string> filter)
Parameters
Type Name Description
IEnumerable<string> filter
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Filter(Func<AnalyzeTokenFiltersDescriptor, IPromise<AnalyzeTokenFilters>>)

A collection of filters to use for the analysis

Declaration
public AnalyzeDescriptor Filter(Func<AnalyzeTokenFiltersDescriptor, IPromise<AnalyzeTokenFilters>> tokenFilters)
Parameters
Type Name Description
Func<AnalyzeTokenFiltersDescriptor, IPromise<AnalyzeTokenFilters>> tokenFilters
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Filter(params string[])

A collection of filters to use for the analysis

Declaration
public AnalyzeDescriptor Filter(params string[] filter)
Parameters
Type Name Description
string[] filter
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Index(IndexName)

Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.

Declaration
public AnalyzeDescriptor Index(IndexName index)
Parameters
Type Name Description
IndexName index
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public AnalyzeDescriptor Index<TOther>() where TOther : class
Returns
Type Description
AnalyzeDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

Normalizer(string)

The name of the normalizer to use

Declaration
public AnalyzeDescriptor Normalizer(string normalizer)
Parameters
Type Name Description
string normalizer
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Text(IEnumerable<string>)

The text on which the analysis should be performed

Declaration
public AnalyzeDescriptor Text(IEnumerable<string> text)
Parameters
Type Name Description
IEnumerable<string> text
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Text(params string[])

The text on which the analysis should be performed

Declaration
public AnalyzeDescriptor Text(params string[] text)
Parameters
Type Name Description
string[] text
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Tokenizer(Func<AnalyzeTokenizersSelector, ITokenizer>)

An inline definition of a tokenizer

Declaration
public AnalyzeDescriptor Tokenizer(Func<AnalyzeTokenizersSelector, ITokenizer> tokenizer)
Parameters
Type Name Description
Func<AnalyzeTokenizersSelector, ITokenizer> tokenizer
Returns
Type Description
AnalyzeDescriptor
| Edit this page View Source

Tokenizer(string)

The name of the tokenizer to use for the analysis

Declaration
public AnalyzeDescriptor Tokenizer(string tokenizer)
Parameters
Type Name Description
string tokenizer
Returns
Type Description
AnalyzeDescriptor

Implements

Extension Methods