Class AnalyzeRequest

Request for Analyze

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

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

Constructors

| Edit this page View Source

AnalyzeRequest()

/_analyze

Declaration
public AnalyzeRequest()
| Edit this page View Source

AnalyzeRequest(IndexName)

/{index}/_analyze

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

Optional, accepts null
| Edit this page View Source

AnalyzeRequest(IndexName, string)

Declaration
public AnalyzeRequest(IndexName indices, string textToAnalyze)
Parameters
Type Name Description
IndexName indices
string textToAnalyze

Properties

| Edit this page View Source

Analyzer

The name of the analyzer to use

Declaration
public string Analyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Attributes

Filter only certain token attributes to be returned

Declaration
public 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
public 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
public 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
public 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
public AnalyzeTokenFilters Filter { get; set; }
Property Value
Type Description
AnalyzeTokenFilters
| Edit this page View Source

Normalizer

The name of the normalizer to use

Declaration
public string Normalizer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Self

Declaration
protected IAnalyzeRequest Self { get; }
Property Value
Type Description
IAnalyzeRequest
| Edit this page View Source

Text

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

Declaration
public 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
public Union<string, ITokenizer> Tokenizer { get; set; }
Property Value
Type Description
Union<string, ITokenizer>

Implements

Extension Methods