Class TermVectorsRequest<TDocument>

Request for TermVectors

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<TermVectorsRequestParameters>
PlainRequestBase<TermVectorsRequestParameters>
TermVectorsRequest<TDocument>
Implements
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 Source

TermVectorsRequest()

/{index}/_termvectors

Declaration
public TermVectorsRequest()
| Edit this page View Source

TermVectorsRequest(Id)

/{index}/_termvectors/{id}

Declaration
public TermVectorsRequest(Id id)
Parameters
Type Name Description
Id id

Optional, accepts null
| Edit this page View Source

TermVectorsRequest(IndexName)

/{index}/_termvectors

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

this parameter is required
| Edit this page View Source

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
| Edit this page View Source

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 Source

Document

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
| 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

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
| Edit this page View Source

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
| 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

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
| 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 the operation should be performed on. Random by default.

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 ITermVectorsRequest<TDocument> Self { get; }
Property Value
Type Description
ITermVectorsRequest<TDocument>
| 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

Specific version type.

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

Implements

Extension Methods