honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Edits to text & formatting in Term Suggester doc (#38963)

This commit is contained in:
Darren Meiss 2019-02-15 15:51:33 -05:00 committed by Mayya Sharipova
parent 56997bf53d
commit dc0e657091
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/reference/search/suggesters/term-suggest.asciidoc
View File

@ -18,7 +18,7 @@ doesn't take the query into account that is part of request.
`field`:: `field`::
The field to fetch the candidate suggestions from. This is The field to fetch the candidate suggestions from. This is
an required option that either needs to be set globally or per a required option that either needs to be set globally or per
suggestion. suggestion.
`analyzer`:: `analyzer`::
@ -54,17 +54,17 @@ doesn't take the query into account that is part of request.
[horizontal] [horizontal]
`lowercase_terms`:: `lowercase_terms`::
Lower cases the suggest text terms after text analysis. Lowercases the suggest text terms after text analysis.
`max_edits`:: `max_edits`::
The maximum edit distance candidate suggestions can The maximum edit distance candidate suggestions can
have in order to be considered as a suggestion. Can only be a value have in order to be considered as a suggestion. Can only be a value
between 1 and 2. Any other value result in an bad request error being between 1 and 2. Any other value results in a bad request error being
thrown. Defaults to 2. thrown. Defaults to 2.
`prefix_length`:: `prefix_length`::
The number of minimal prefix characters that must The number of minimal prefix characters that must
match in order be a candidate suggestions. Defaults to 1. Increasing match in order be a candidate for suggestions. Defaults to 1. Increasing
this number improves spellcheck performance. Usually misspellings don't this number improves spellcheck performance. Usually misspellings don't
occur in the beginning of terms. (Old name "prefix_len" is deprecated) occur in the beginning of terms. (Old name "prefix_len" is deprecated)
@ -85,7 +85,7 @@ doesn't take the query into account that is part of request.
`max_inspections`:: `max_inspections`::
A factor that is used to multiply with the A factor that is used to multiply with the
`shards_size` in order to inspect more candidate spell corrections on `shards_size` in order to inspect more candidate spelling corrections on
the shard level. Can improve accuracy at the cost of performance. the shard level. Can improve accuracy at the cost of performance.
Defaults to 5. Defaults to 5.
@ -94,29 +94,29 @@ doesn't take the query into account that is part of request.
suggestion should appear in. This can be specified as an absolute number suggestion should appear in. This can be specified as an absolute number
or as a relative percentage of number of documents. This can improve or as a relative percentage of number of documents. This can improve
quality by only suggesting high frequency terms. Defaults to 0f and is quality by only suggesting high frequency terms. Defaults to 0f and is
not enabled. If a value higher than 1 is specified then the number not enabled. If a value higher than 1 is specified, then the number
cannot be fractional. The shard level document frequencies are used for cannot be fractional. The shard level document frequencies are used for
this option. this option.
`max_term_freq`:: `max_term_freq`::
The maximum threshold in number of documents a The maximum threshold in number of documents in which a
suggest text token can exist in order to be included. Can be a relative suggest text token can exist in order to be included. Can be a relative
percentage number (e.g 0.4) or an absolute number to represent document percentage number (e.g., 0.4) or an absolute number to represent document
frequencies. If an value higher than 1 is specified then fractional can frequencies. If a value higher than 1 is specified, then fractional can
not be specified. Defaults to 0.01f. This can be used to exclude high not be specified. Defaults to 0.01f. This can be used to exclude high
frequency terms from being spellchecked. High frequency terms are frequency terms -- which are usually spelled correctly -- from being spellchecked.
usually spelled correctly on top of this also improves the spellcheck This also improves the spellcheck performance. The shard level document frequencies
performance. The shard level document frequencies are used for this are used for this option.
option.
`string_distance`:: `string_distance`::
Which string distance implementation to use for comparing how similar Which string distance implementation to use for comparing how similar
suggested terms are. Five possible values can be specified: suggested terms are. Five possible values can be specified:
`internal` - The default based on damerau_levenshtein but highly optimized
** `internal`: The default based on damerau_levenshtein but highly optimized
for comparing string distance for terms inside the index. for comparing string distance for terms inside the index.
`damerau_levenshtein` - String distance algorithm based on ** `damerau_levenshtein`: String distance algorithm based on
Damerau-Levenshtein algorithm. Damerau-Levenshtein algorithm.
`levenshtein` - String distance algorithm based on Levenshtein edit distance ** `levenshtein`: String distance algorithm based on Levenshtein edit distance
algorithm. algorithm.
`jaro_winkler` - String distance algorithm based on Jaro-Winkler algorithm. ** `jaro_winkler`: String distance algorithm based on Jaro-Winkler algorithm.
`ngram` - String distance algorithm based on character n-grams. ** `ngram`: String distance algorithm based on character n-grams.