Class MultiTermVectorsRequest

A Multi termvectors API request

Inheritance
object
RequestBase<MultiTermVectorsRequestParameters>
PlainRequestBase<MultiTermVectorsRequestParameters>
MultiTermVectorsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class MultiTermVectorsRequest : PlainRequestBase<MultiTermVectorsRequestParameters>, IMultiTermVectorsRequest, IRequest<MultiTermVectorsRequestParameters>, IRequest

Constructors

| Edit this page View Source

MultiTermVectorsRequest()

/_mtermvectors

Declaration
public MultiTermVectorsRequest()
| Edit this page View Source

MultiTermVectorsRequest(IndexName)

/{index}/_mtermvectors

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

Optional, accepts null

Properties

| Edit this page View Source

Documents

The documents for which to generate term vectors

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

Ids

The ids of documents within the same index and type for which to generate term vectors. Must be used in conjunction with Index and Type

Declaration
public IEnumerable<Id> Ids { get; set; }
Property Value
Type Description
IEnumerable<Id>
| 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

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 document is routed to a particular shard in an index using the following formula

shard_num = hash(_routing) % num_primary_shards

OpenSearch will use the document id if not provided.

For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

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

Self

Declaration
protected IMultiTermVectorsRequest Self { get; }
Property Value
Type Description
IMultiTermVectorsRequest
| 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