83 lines
4.6 KiB
Plaintext
83 lines
4.6 KiB
Plaintext
[[reference-termvectors]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
=== client.termvectors
|
|
|
|
Get term vector information. Get information and statistics about terms in the fields of a particular document.
|
|
|
|
{ref}/docs-termvectors.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(TermvectorsRequest, options?): Promise<TermvectorsResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `TermvectorsRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface TermvectorsRequest<TDocument = unknown> extends <<shared-type-request-base, RequestBase>> {
|
|
index: <<shared-type-index-name, IndexName>>
|
|
id?: <<shared-type-id, Id>>
|
|
fields?: <<shared-type-fields, Fields>>
|
|
field_statistics?: boolean
|
|
offsets?: boolean
|
|
payloads?: boolean
|
|
positions?: boolean
|
|
preference?: string
|
|
realtime?: boolean
|
|
routing?: <<shared-type-routing, Routing>>
|
|
term_statistics?: boolean
|
|
version?: <<shared-type-version-number, VersionNumber>>
|
|
version_type?: <<shared-type-version-type, VersionType>>
|
|
doc?: TDocument
|
|
filter?: TermvectorsFilter
|
|
per_field_analyzer?: Record<<<shared-type-field, Field>>, string>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `TermvectorsResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface TermvectorsResponse {
|
|
found: boolean
|
|
_id?: <<shared-type-id, Id>>
|
|
_index: <<shared-type-index-name, IndexName>>
|
|
term_vectors?: Record<<<shared-type-field, Field>>, TermvectorsTermVector>
|
|
took: <<shared-type-long, long>>
|
|
_version: <<shared-type-version-number, VersionNumber>>
|
|
}
|
|
----
|
|
|