Class TermVectorsRequest<TDocument>
Request for TermVectors
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class TermVectorsRequest<TDocument> : PlainRequestBase<TermVectorsRequestParameters>, ITermVectorsRequest<TDocument>, IRequest<TermVectorsRequestParameters>, IRequest where TDocument : class
Type Parameters
Name | Description |
---|---|
TDocument |
Constructors
| Edit this page View SourceTermVectorsRequest()
/{index}/_termvectors
Declaration
public TermVectorsRequest()
TermVectorsRequest(Id)
/{index}/_termvectors/{id}
Declaration
public TermVectorsRequest(Id id)
Parameters
Type | Name | Description |
---|---|---|
Id | id | Optional, accepts null |
TermVectorsRequest(IndexName)
/{index}/_termvectors
Declaration
public TermVectorsRequest(IndexName index)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | this parameter is required |
TermVectorsRequest(IndexName, Id)
/{index}/_termvectors/{id}
Declaration
public TermVectorsRequest(IndexName index, Id id)
Parameters
Type | Name | Description |
---|---|---|
IndexName | index | this parameter is required |
Id | id | Optional, accepts null |
TermVectorsRequest(TDocument, IndexName, Id)
/{index}/_termvectors/{id}
Declaration
public TermVectorsRequest(TDocument documentWithId, IndexName index = null, Id id = null)
Parameters
Type | Name | Description |
---|---|---|
TDocument | documentWithId | |
IndexName | index | |
Id | id | The document used to resolve the path from |
Properties
| Edit this page View SourceDocument
An optional document to get term vectors for instead of using an already indexed document
Declaration
public TDocument Document { get; set; }
Property Value
Type | Description |
---|---|
TDocument |
FieldStatistics
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
Declaration
public bool? FieldStatistics { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Fields
A comma-separated list of fields to return.
Declaration
public Fields Fields { get; set; }
Property Value
Type | Description |
---|---|
Fields |
Filter
Filter the terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.
Declaration
public ITermVectorFilter Filter { get; set; }
Property Value
Type | Description |
---|---|
ITermVectorFilter |
Offsets
Specifies if term offsets should be returned.
Declaration
public bool? Offsets { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Payloads
Specifies if term payloads should be returned.
Declaration
public bool? Payloads { get; set; }
Property Value
Type | Description |
---|---|
bool? |
PerFieldAnalyzer
Provide a different analyzer than the one at the field. This is useful in order to generate term vectors in any fashion, especially when using artificial documents.
Declaration
public IPerFieldAnalyzer PerFieldAnalyzer { get; set; }
Property Value
Type | Description |
---|---|
IPerFieldAnalyzer |
Positions
Specifies if term positions should be returned.
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).
Declaration
public string Preference { get; set; }
Property Value
Type | Description |
---|---|
string |
Realtime
Specifies if request is 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 ITermVectorsRequest<TDocument> Self { get; }
Property Value
Type | Description |
---|---|
ITermVectorsRequest<TDocument> |
TermStatistics
Specifies if total term frequency and document frequency should be returned.
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? |