Skip to content

Commit

Permalink
Add docs for the include_named_queries_score param (elastic#103155)
Browse files Browse the repository at this point in the history
The only docs for this _search param were mentioned in the bool query docs. While it makes contextual sense to have it there, we should also add it as a _search parameter in the search API docs.

It was introduced in 8.8.
  • Loading branch information
benwtrent authored Dec 8, 2023
1 parent 690a8a2 commit 47b5753
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/reference/search/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ By default, you cannot page through more than 10,000 hits using the `from` and

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]

`include_named_queries_score`::
(Optional, Boolean) If `true`, includes the score contribution from any named queries.
This functionality reruns each named query on every hit in a search
response. Typically, this adds a small overhead to a request. However, using
computationally expensive named queries on a large number of hits may add
significant overhead. Defaults to `false`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient]
Expand Down

0 comments on commit 47b5753

Please sign in to comment.