Skip to content

Edits to text in Completion Suggester doc #38980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 15, 2019
Merged

Edits to text in Completion Suggester doc #38980

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/reference/search/suggesters/completion-suggest.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ PUT music

Mapping supports the following parameters:

[horizontal]
`analyzer`::
The index analyzer to use, defaults to `simple`.
In case you are wondering why we did not opt for the `standard`
Expand Down Expand Up @@ -72,7 +73,7 @@ Mapping supports the following parameters:
Limits the length of a single input, defaults to `50` UTF-16 code points.
This limit is only used at index time to reduce the total number of
characters per input string in order to prevent massive inputs from
bloating the underlying datastructure. Most usecases won't be influenced
bloating the underlying datastructure. Most use cases won't be influenced
by the default value since prefix completions seldom grow beyond prefixes longer
than a handful of characters.

Expand All @@ -99,6 +100,7 @@ PUT music/_doc/1?refresh

The following parameters are supported:

[horizontal]
`input`::
The input to store, this can be an array of strings or just
a string. This field is mandatory.
Expand Down Expand Up @@ -284,6 +286,7 @@ Which should look like:

The basic completion suggester query supports the following parameters:

[horizontal]
`field`:: The name of the field on which to run the query (required).
`size`:: The number of suggestions to return (defaults to `5`).
`skip_duplicates`:: Whether duplicate suggestions should be filtered out (defaults to `false`).
Expand Down Expand Up @@ -325,13 +328,13 @@ POST music/_search?pretty
--------------------------------------------------
// CONSOLE

WARNING: when set to true this option can slow down search because more suggestions
WARNING: When set to true, this option can slow down search because more suggestions
need to be visited to find the top N.

[[fuzzy]]
==== Fuzzy queries

The completion suggester also supports fuzzy queries - this means,
The completion suggester also supports fuzzy queries -- this means
you can have a typo in your search and still get results back.

[source,js]
Expand Down