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 |
---|---|---|
IndexName | 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<IMultiTermVectorOperation> |
FieldStatistics
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public bool? FieldStatistics { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Fields
A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
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
Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public bool? Offsets { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Payloads
Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public bool? Payloads { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Positions
Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public bool? Positions { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Preference
Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public string Preference { get; set; }
Property Value
Type | Description |
---|---|
string |
Realtime
Specifies if requests are real-time as opposed to near-real-time (default: true).
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 OSC 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 |
Self
Declaration
protected IMultiTermVectorsRequest Self { get; }
Property Value
Type | Description |
---|---|
IMultiTermVectorsRequest |
TermStatistics
Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
Declaration
public bool? TermStatistics { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Version
Explicit version number for concurrency control
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 |
---|---|
VersionType? |