honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-03-25 09:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Reformat suggesters page. (#47010)

Browse Source
This commit is contained in:
István Zoltán Szabó 2019-09-25 14:38:47 +02:00
parent 9e17b78fee
commit 83365e94ba
1 changed files with 25 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/reference/search/suggesters.asciidoc
View File

@ -1,16 +1,8 @@
[[search-suggesters]]
=== Suggesters
The suggest feature suggests similar looking terms based on a provided
text by using a suggester. Parts of the suggest feature are still under
development.
The suggest request part is defined alongside the query part in a `_search`
request. If the query part is left out, only suggestions are returned.
NOTE: `_suggest` endpoint has been deprecated in favour of using suggest via
`_search` endpoint. In 5.0, the `_search` endpoint has been optimized for
suggest only search requests.
Suggests similar looking terms based on a provided text by using a suggester.
Parts of the suggest feature are still under development.
[source,console]
--------------------------------------------------
@ -33,10 +25,27 @@ POST twitter/_search
--------------------------------------------------
// TEST[setup:twitter]
Several suggestions can be specified per request. Each suggestion is
identified with an arbitrary name. In the example below two suggestions
are requested. Both `my-suggest-1` and `my-suggest-2` suggestions use
the `term` suggester, but have a different `text`.
[[search-suggesters-api-request]]
==== {api-request-title}
The suggest feature suggests similar looking terms based on a provided text by
using a suggester. The suggest request part is defined alongside the query part
in a `_search` request. If the query part is left out, only suggestions are
returned.
NOTE: `_suggest` endpoint has been deprecated in favour of using suggest via
`_search` endpoint. In 5.0, the `_search` endpoint has been optimized for
suggest only search requests.
[[search-suggesters-api-example]]
==== {api-examples-title}
Several suggestions can be specified per request. Each suggestion is identified
with an arbitrary name. In the example below two suggestions are requested. Both
`my-suggest-1` and `my-suggest-2` suggestions use the `term` suggester, but have
a different `text`.
[source,console]
--------------------------------------------------
@ -60,6 +69,7 @@ POST _search
--------------------------------------------------
// TEST[setup:twitter]
The below suggest response example includes the suggestion response for
`my-suggest-1` and `my-suggest-2`. Each suggestion part contains
entries. Each entry is effectively a token from the suggest text and
@ -107,7 +117,7 @@ term suggester's score is based on the edit distance.
[float]
[[global-suggest]]
==== Global suggest text
===== Global suggest text
To avoid repetition of the suggest text, it is possible to define a
global text. In the example below the suggest text is defined globally