Files
elasticsearch-js/docs/reference-shared-types-explain.asciidoc

118 lines
4.5 KiB
Plaintext

[[reference-shared-types-explain]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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 Explain types
[discrete]
[[ExplainExplanation]]
=== ExplainExplanation
[pass]
++++
<pre>
++++
interface ExplainExplanation {
description: string
details: <<ExplainExplanationDetail>>[]
value: <<float>>
}
[pass]
++++
</pre>
++++
[discrete]
[[ExplainExplanationDetail]]
=== ExplainExplanationDetail
[pass]
++++
<pre>
++++
interface ExplainExplanationDetail {
description: string
details?: <<ExplainExplanationDetail>>[]
value: <<float>>
}
[pass]
++++
</pre>
++++
[discrete]
[[ExplainRequest]]
=== ExplainRequest
[pass]
++++
<pre>
++++
interface ExplainRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
analyzer?: string
analyze_wildcard?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
lenient?: boolean
preference?: string
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
q?: string
query?: <<QueryDslQueryContainer>>
}
[pass]
++++
</pre>
++++
[discrete]
[[ExplainResponse]]
=== ExplainResponse
[pass]
++++
<pre>
++++
interface ExplainResponse<TDocument = unknown> {
_index: <<IndexName>>
_id: <<Id>>
matched: boolean
explanation?: <<ExplainExplanationDetail>>
get?: <<InlineGet>><TDocument>
}
[pass]
++++
</pre>
++++