Class TermVectorsRequestParameters

Request options for TermVectors

<p>https://docs.opensearch.org/latest/</p>
Inheritance
object
RequestParameters<TermVectorsRequestParameters>
TermVectorsRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class TermVectorsRequestParameters : RequestParameters<TermVectorsRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

FieldStatistics

If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.

Declaration
public bool? FieldStatistics { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Fields

A comma-separated list or a wildcard expression specifying the fields to include in the statistics. Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

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

Offsets

If true, the response includes term offsets.

Declaration
public bool? Offsets { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

Payloads

If true, the response includes term payloads.

Declaration
public bool? Payloads { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Positions

If true, the response includes term positions.

Declaration
public bool? Positions { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Preference

Specifies the node or shard on which the operation should be performed. See preference query parameter for a list of available options. By default the requests are routed randomly to available shard copies (primary or replica), with no guarantee of consistency across repeated queries.

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

Realtime

If true, the request is real time as opposed to near real time.

Declaration
public bool? Realtime { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Routing

A custom value used to route operations to a specific shard.

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

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

TermStatistics

If true, the response includes term frequency and document frequency.

Declaration
public bool? TermStatistics { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Version

If true, returns the document version as part of a hit.

Declaration
public long? Version { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

VersionType

The specific version type.

Declaration
public VersionType? VersionType { get; set; }
Property Value
Type Description
VersionType?

Implements

Extension Methods