OpenSearch/docs/reference/search/suggesters
Jim Ferenczi 18866c4c0b
Make hits.total an object in the search response (#35849)
This commit changes the format of the `hits.total` in the search response to be an object with
a `value` and a `relation`. The `value` indicates the number of hits that match the query and the
`relation` indicates whether the number is accurate (in which case the relation is equals to `eq`)
or a lower bound of the total (in which case it is equals to `gte`).
This change also adds a parameter called `rest_total_hits_as_int` that can be used in the
search APIs to opt out from this change (retrieve the total hits as a number in the rest response).
Note that currently all search responses are accurate (`track_total_hits: true`) or they don't contain
`hits.total` (`track_total_hits: true`). We'll add a way to get a lower bound of the total hits in a
follow up (to allow numbers to be passed to `track_total_hits`).

Relates #33028
2018-12-05 19:49:06 +01:00
..
completion-suggest.asciidoc Make hits.total an object in the search response (#35849) 2018-12-05 19:49:06 +01:00
context-suggest.asciidoc Clarify context suggestions filtering and boosting (#33601) 2018-09-12 08:47:32 +02:00
misc.asciidoc
phrase-suggest.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
term-suggest.asciidoc Deprecate `jarowinkler` in favor of `jaro_winkler` (#27526) 2017-11-30 12:49:34 +00:00