Class MultiTermVectorsRequest
A Multi termvectors API request
Inheritance
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class MultiTermVectorsRequest : PlainRequestBase<MultiTermVectorsRequestParameters>, IMultiTermVectorsRequest, IRequest<MultiTermVectorsRequestParameters>, IRequest
Constructors
| Edit this page View SourceMultiTermVectorsRequest()
/_mtermvectors
Declaration
public MultiTermVectorsRequest()
MultiTermVectorsRequest(IndexName)
/{index}/_mtermvectors
Declaration
public MultiTermVectorsRequest(IndexName index)
Parameters
Type | Name | Description |
---|---|---|
Index |
index | Optional, accepts null |
Properties
| Edit this page View SourceDocuments
The documents for which to generate term vectors
Declaration
public IEnumerable<IMultiTermVectorOperation> Documents { get; set; }
Property Value
Type | Description |
---|---|
IEnumerable<IMulti |
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? |
Fields
Comma-separated list or wildcard expressions of 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 |
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> |
Offsets
If true
, the response includes term offsets.
Declaration
public bool? Offsets { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Payloads
If true
, the response includes term payloads.
Declaration
public bool? Payloads { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Positions
If true
, the response includes term positions.
Declaration
public bool? Positions { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Preference
Specifies the node or shard the operation should be performed on. Random by default.
Declaration
public string Preference { get; set; }
Property Value
Type | Description |
---|---|
string |
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? |
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 Join
Declaration
public Routing Routing { get; set; }
Property Value
Type | Description |
---|---|
Routing |
Self
Declaration
protected IMultiTermVectorsRequest Self { get; }
Property Value
Type | Description |
---|---|
IMulti |
TermStatistics
If true
, the response includes term frequency and document frequency.
Declaration
public bool? TermStatistics { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Version
If true
, returns the document version as part of a hit.
Declaration
public long? Version { get; set; }
Property Value
Type | Description |
---|---|
long? |
VersionType
Specific version type.
Declaration
public VersionType? VersionType { get; set; }
Property Value
Type | Description |
---|---|
Version |