187 lines
6.2 KiB
Plaintext
187 lines
6.2 KiB
Plaintext
[[reference-shared-types--global-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> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
|
|
|
|
== Shared Termvectors types
|
|
|
|
|
|
[discrete]
|
|
[[TermvectorsFieldStatistics]]
|
|
=== TermvectorsFieldStatistics
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TermvectorsFieldStatistics {
|
|
doc_count: <<integer>>
|
|
sum_doc_freq: <<long>>
|
|
sum_ttf: <<long>>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[TermvectorsFilter]]
|
|
=== TermvectorsFilter
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TermvectorsFilter {
|
|
pass:[/**] @property max_doc_freq Ignore words which occur in more than this many docs. Defaults to unbounded. */
|
|
max_doc_freq?: <<integer>>
|
|
pass:[/**] @property max_num_terms Maximum number of terms that must be returned per field. */
|
|
max_num_terms?: <<integer>>
|
|
pass:[/**] @property max_term_freq Ignore words with more than this frequency in the source doc. Defaults to unbounded. */
|
|
max_term_freq?: <<integer>>
|
|
pass:[/**] @property max_word_length The maximum word length above which words will be ignored. Defaults to unbounded. */
|
|
max_word_length?: <<integer>>
|
|
pass:[/**] @property min_doc_freq Ignore terms which do not occur in at least this many docs. */
|
|
min_doc_freq?: <<integer>>
|
|
pass:[/**] @property min_term_freq Ignore words with less than this frequency in the source doc. */
|
|
min_term_freq?: <<integer>>
|
|
pass:[/**] @property min_word_length The minimum word length below which words will be ignored. */
|
|
min_word_length?: <<integer>>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[TermvectorsRequest]]
|
|
=== TermvectorsRequest
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TermvectorsRequest<TDocument = unknown> extends <<RequestBase>> {
|
|
index: <<IndexName>>
|
|
id?: <<Id>>
|
|
fields?: <<Fields>>
|
|
field_statistics?: boolean
|
|
offsets?: boolean
|
|
payloads?: boolean
|
|
positions?: boolean
|
|
preference?: string
|
|
realtime?: boolean
|
|
routing?: <<Routing>>
|
|
term_statistics?: boolean
|
|
version?: <<VersionNumber>>
|
|
version_type?: <<VersionType>>
|
|
doc?: TDocument
|
|
filter?: <<TermvectorsFilter>>
|
|
per_field_analyzer?: Record<<<Field>>, string>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[TermvectorsResponse]]
|
|
=== TermvectorsResponse
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TermvectorsResponse {
|
|
found: boolean
|
|
_id?: <<Id>>
|
|
_index: <<IndexName>>
|
|
term_vectors?: Record<<<Field>>, <<TermvectorsTermVector>>>
|
|
took: <<long>>
|
|
_version: <<VersionNumber>>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[TermvectorsTerm]]
|
|
=== TermvectorsTerm
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TermvectorsTerm {
|
|
doc_freq?: <<integer>>
|
|
score?: <<double>>
|
|
term_freq: <<integer>>
|
|
tokens?: <<TermvectorsToken>>[]
|
|
ttf?: <<integer>>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[TermvectorsTermVector]]
|
|
=== TermvectorsTermVector
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TermvectorsTermVector {
|
|
field_statistics?: <<TermvectorsFieldStatistics>>
|
|
terms: Record<string, <<TermvectorsTerm>>>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
|
|
[discrete]
|
|
[[TermvectorsToken]]
|
|
=== TermvectorsToken
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface TermvectorsToken {
|
|
end_offset?: <<integer>>
|
|
payload?: string
|
|
position: <<integer>>
|
|
start_offset?: <<integer>>
|
|
}
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|