OpenSearch/docs/reference/search/request/explain.asciidoc

[[request-body-search-explain]]
==== Explain

Enables explanation for each hit on how its score was computed.

[source,console]
--------------------------------------------------
GET /_search
{
    "explain": true,
    "query" : {
        "term" : { "user" : "kimchy" }
    }
}
--------------------------------------------------
[DOCS] Move Elasticsearch APIs to REST APIs section. (#44238) (#44372) Moves the following API sections under the REST APIs navigations: - API Conventions - Document APIs - Search APIs - Index APIs (previously named Indices APIs) - cat APIs - Cluster APIs Other supporting changes: - Removes the previous index APIs page under REST APIs. Adds a redirect for the removed page. - Removes several [partintro] macros so the docs build correctly. - Changes anchors for pages that become sections of a parent page. - Adds several redirects for existing pages that become sections of a parent page. This commit re-applies changes from #44238. Changes from that PR were reverted due to broken links in several repos. This commit adds redirects for those broken links. 2019-07-17 08:49:22 -04:00			`[[request-body-search-explain]]`
[DOCS] Remove heading offsets for REST APIs (#44568) Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case. 2019-07-19 14:35:36 -04:00			`==== Explain`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
			`Enables explanation for each hit on how its score was computed.`

[DOCS] Change // CONSOLE comments to [source,console] (#46440) (#46494) 2019-09-09 12:35:50 -04:00			`[source,console]`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`--------------------------------------------------`
Add CONSOLE to several trivial search request docs. Relates to #18160 Touches explain, fielddata-fields, fields, index-boost, min-score, named-queries-and-filters, query 2016-05-18 07:15:19 -04:00			`GET /_search`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`{`
			`"explain": true,`
			`"query" : {`
			`"term" : { "user" : "kimchy" }`
			`}`
			`}`
			`--------------------------------------------------`