elasticsearch/docs/reference/query-dsl
Ryan Ernst d8b4556e2d
Add explanations to script score queries (#46693)
While function scores using scripts do allow explanations, they are only
creatable with an expert plugin. This commit improves the situation for
the newer script score query by adding the ability to set the
explanation from the script itself.

To set the explanation, a user would check for `explanation != null` to
indicate an explanation is needed, and then call
`explanation.set("some description")`.
2019-10-03 19:35:59 -07:00
..
bool-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
boosting-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
compound-queries.asciidoc [DOCS] Make Query DSL titles consistent (#43935) 2019-07-18 10:18:11 -04:00
constant-score-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
dis-max-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
distance-feature-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
exists-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
full-text-queries.asciidoc [DOCS] Make Query DSL titles consistent (#43935) 2019-07-18 10:18:11 -04:00
function-score-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
fuzzy-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
geo-bounding-box-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
geo-distance-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
geo-polygon-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
geo-queries.asciidoc [DOCS] Make Query DSL titles consistent (#43935) 2019-07-18 10:18:11 -04:00
geo-shape-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
has-child-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
has-parent-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
ids-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
intervals-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
joining-queries.asciidoc [DOCS] Make Query DSL titles consistent (#43935) 2019-07-18 10:18:11 -04:00
match-all-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
match-bool-prefix-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
match-phrase-prefix-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
match-phrase-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
match-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
minimum-should-match.asciidoc [Docs] Fix typo in minimum-should-match.asciidoc (#46472) 2019-09-09 14:17:49 +02:00
mlt-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
multi-match-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
multi-term-rewrite.asciidoc [DOCS] Make Query DSL titles consistent (#43935) 2019-07-18 10:18:11 -04:00
nested-query.asciidoc [DOCS] Add multi-level nested query example to nested query docs (#46986) 2019-09-25 00:56:15 -04:00
parent-id-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
percolate-query.asciidoc Remove _type from SearchHit (#46942) 2019-09-23 19:14:54 +01:00
pinned-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
prefix-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
query-string-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
query-string-syntax.asciidoc [DOCS] Correct snippet in query string syntax 2019-09-30 11:25:13 -04:00
query_filter_context.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
range-query.asciidoc [DOCS] Correct date math ex for gt and gte parms in range query docs (#46873) 2019-09-19 16:38:42 -04:00
rank-feature-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
regexp-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
regexp-syntax.asciidoc [DOCS] Rewrite regexp query (#42711) 2019-07-24 08:37:37 -04:00
script-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
script-score-query.asciidoc Add explanations to script score queries (#46693) 2019-10-03 19:35:59 -07:00
shape-queries.asciidoc [SPATIAL] New ShapeQueryBuilder for querying indexed cartesian geometry (#45108) 2019-08-08 15:28:35 -05:00
shape-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
simple-query-string-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-containing-query.asciidoc [DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] (#46449) 2019-09-06 14:05:36 -04:00
span-field-masking-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-first-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-multi-term-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-near-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-not-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-or-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-queries.asciidoc [DOCS] Make Query DSL titles consistent (#43935) 2019-07-18 10:18:11 -04:00
span-term-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
span-within-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
special-queries.asciidoc Search enhancement: pinned queries (#44345) 2019-08-16 14:46:06 +01:00
term-level-queries.asciidoc [DOCS] Make Query DSL titles consistent (#43935) 2019-07-18 10:18:11 -04:00
term-query.asciidoc Remove _type from SearchHit (#46942) 2019-09-23 19:14:54 +01:00
terms-query.asciidoc Remove _type from SearchHit (#46942) 2019-09-23 19:14:54 +01:00
terms-set-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
wildcard-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
wrapper-query.asciidoc [DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00