elasticsearch-js/docs/reference/api/TermvectorsRequest.md

TermvectorsRequest [interface-TermvectorsRequest]

Name	Type	Description
body	string	({ [key: string]: any; } & { index?: never; id?: never; preference?: never; realtime?: never; doc?: never; filter?: never; per_field_analyzer?: never; fields?: never; field_statistics?: never; offsets?: never; payloads?: never; positions?: never; term_statistics?: never; routing?: never; version?: never; version_type?: never; })
doc	TDocument	An artificial document (a document not present in the index) for which you want to retrieve term vectors.
field_statistics	boolean	If true, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field).
fields	Fields	A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.
filter	TermvectorsFilter	Filter terms based on their tf-idf scores. This could be useful in order find out a good characteristic vector of a document. This feature works in a similar manner to the second phase of the More Like This Query.
id	Id	A unique identifier for the document.
index	IndexName	The name of the index that contains the document.
offsets	boolean	If true, the response includes term offsets.
payloads	boolean	If true, the response includes term payloads.
per_field_analyzer	Record<Field, string>	Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.
positions	boolean	If true, the response includes term positions.
preference	string	The node or shard the operation should be performed on. It is random by default.
querystring	{ [key: string]: any; } & { index?: never; id?: never; preference?: never; realtime?: never; doc?: never; filter?: never; per_field_analyzer?: never; fields?: never; field_statistics?: never; offsets?: never; payloads?: never; positions?: never; term_statistics?: never; routing?: never; version?: never; version_type?: never; }	All values in querystring will be added to the request querystring.
realtime	boolean	If true, the request is real-time as opposed to near-real-time.
routing	Routing	A custom value that is used to route operations to a specific shard.
term_statistics	boolean	If true, the response includes: * The total term frequency (how often a term occurs in all documents). * The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact.
version_type	VersionType	The version type.
version	VersionNumber	If true, returns the document version as part of a hit.