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

IAnalyzeRequest

IRequest<AnalyzeRequestParameters>

IRequest

Inherited Members

PlainRequestBase<AnalyzeRequestParameters>.RequestConfiguration

PlainRequestBase<AnalyzeRequestParameters>.ErrorTrace

PlainRequestBase<AnalyzeRequestParameters>.FilterPath

PlainRequestBase<AnalyzeRequestParameters>.Human

PlainRequestBase<AnalyzeRequestParameters>.Pretty

PlainRequestBase<AnalyzeRequestParameters>.SourceQueryString

RequestBase<AnalyzeRequestParameters>.HttpMethod

RequestBase<AnalyzeRequestParameters>.RequestState

RequestBase<AnalyzeRequestParameters>.ContentType

RequestBase<AnalyzeRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<AnalyzeRequestParameters>.RequestDefaults(AnalyzeRequestParameters)

RequestBase<AnalyzeRequestParameters>.Q<TOut>(string)

RequestBase<AnalyzeRequestParameters>.Q(string, object)

RequestBase<AnalyzeRequestParameters>.SetAcceptHeader(string)

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 AnalyzeRequest : PlainRequestBase<AnalyzeRequestParameters>, IAnalyzeRequest, IRequest<AnalyzeRequestParameters>, IRequest

Constructors

AnalyzeRequest()

/_analyze

Declaration

public AnalyzeRequest()

AnalyzeRequest(IndexName)

/{index}/_analyze

Declaration

public AnalyzeRequest(IndexName index)

Parameters

Type	Name	Description
IndexName	index	Optional, accepts null

AnalyzeRequest(IndexName, string)

Declaration

public AnalyzeRequest(IndexName indices, string textToAnalyze)

Parameters

Type	Name	Description
IndexName	indices
string	textToAnalyze

Properties

Analyzer

The name of the analyzer to use

Declaration

public string Analyzer { get; set; }

Property Value

Type	Description
string

Attributes

Filter only certain token attributes to be returned

Declaration

public IEnumerable<string> Attributes { get; set; }

Property Value

Type	Description
IEnumerable<string>

CharFilter

A collection of character filters to use for the analysis

Declaration

public AnalyzeCharFilters CharFilter { get; set; }

Property Value

Type	Description
AnalyzeCharFilters

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?

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

Filter

A collection of filters to use for the analysis

Declaration

public AnalyzeTokenFilters Filter { get; set; }

Property Value

Type	Description
AnalyzeTokenFilters

Normalizer

The name of the normalizer to use

Declaration

public string Normalizer { get; set; }

Property Value

Type	Description
string

Self

Declaration

protected IAnalyzeRequest Self { get; }

Property Value

Type	Description
IAnalyzeRequest

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>

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

IAnalyzeRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)