Interface IAnalyzeRequest

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IAnalyzeRequest : IRequest<AnalyzeRequestParameters>, IRequest

Properties

| Edit this page View Source

Analyzer

The name of the analyzer to use

Declaration
[DataMember(Name = "analyzer")]
string Analyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Attributes

Filter only certain token attributes to be returned

Declaration
[DataMember(Name = "attributes")]
IEnumerable<string> Attributes { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

CharFilter

A collection of character filters to use for the analysis

Declaration
[DataMember(Name = "char_filter")]
AnalyzeCharFilters CharFilter { get; set; }
Property Value
Type Description
AnalyzeCharFilters
| Edit this page View Source

Explain

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

Declaration
[DataMember(Name = "explain")]
bool? Explain { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Field

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

Declaration
[DataMember(Name = "field")]
Field Field { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

Filter

A collection of filters to use for the analysis

Declaration
[DataMember(Name = "filter")]
AnalyzeTokenFilters Filter { get; set; }
Property Value
Type Description
AnalyzeTokenFilters
| Edit this page View Source

Index

Declaration
[IgnoreDataMember]
IndexName Index { get; }
Property Value
Type Description
IndexName
| Edit this page View Source

Normalizer

The name of the normalizer to use

Declaration
[DataMember(Name = "normalizer")]
string Normalizer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Text

The text on which the analysis should be performed (when request body is not used)

Declaration
[DataMember(Name = "text")]
IEnumerable<string> Text { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

Tokenizer

The name of the tokenizer to use for the analysis

Declaration
[DataMember(Name = "tokenizer")]
Union<string, ITokenizer> Tokenizer { get; set; }
Property Value
Type Description
Union<string, ITokenizer>

Extension Methods