habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
docs/reference-mtermvectors.asciidoc Normal file
View File

@ -0,0 +1,75 @@
[[reference-mtermvectors]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.mtermvectors
Get multiple term vectors. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a `docs` array with all the fetched termvectors. Each element has the structure provided by the termvectors API.
{ref}/docs-multi-termvectors.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MtermvectorsRequest, options?): Promise<MtermvectorsResponse>
----
[discrete]
===== `MtermvectorsRequest`
[source,ts]
----
interface MtermvectorsRequest extends <<shared-type-request-base, RequestBase>> {
index?: <<shared-type-index-name, IndexName>>
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>>
docs?: MtermvectorsOperation[]
ids?: <<shared-type-id, Id>>[]
}
----
[discrete]
===== `MtermvectorsResponse`
[source,ts]
----
interface MtermvectorsResponse {
docs: MtermvectorsTermVectorsResult[]
}
----