@@ -18,7 +18,7 @@ doesn't take the query into account that is part of request.
18
18
19
19
`field`::
20
20
The field to fetch the candidate suggestions from. This is
21
- an required option that either needs to be set globally or per
21
+ a required option that either needs to be set globally or per
22
22
suggestion.
23
23
24
24
`analyzer`::
@@ -54,17 +54,17 @@ doesn't take the query into account that is part of request.
54
54
55
55
[horizontal]
56
56
`lowercase_terms`::
57
- Lower cases the suggest text terms after text analysis.
57
+ Lowercases the suggest text terms after text analysis.
58
58
59
59
`max_edits`::
60
60
The maximum edit distance candidate suggestions can
61
61
have in order to be considered as a suggestion. Can only be a value
62
- between 1 and 2. Any other value result in an bad request error being
62
+ between 1 and 2. Any other value results in a bad request error being
63
63
thrown. Defaults to 2.
64
64
65
65
`prefix_length`::
66
66
The number of minimal prefix characters that must
67
- match in order be a candidate suggestions. Defaults to 1. Increasing
67
+ match in order be a candidate for suggestions. Defaults to 1. Increasing
68
68
this number improves spellcheck performance. Usually misspellings don't
69
69
occur in the beginning of terms. (Old name "prefix_len" is deprecated)
70
70
@@ -85,7 +85,7 @@ doesn't take the query into account that is part of request.
85
85
86
86
`max_inspections`::
87
87
A factor that is used to multiply with the
88
- `shards_size` in order to inspect more candidate spell corrections on
88
+ `shards_size` in order to inspect more candidate spelling corrections on
89
89
the shard level. Can improve accuracy at the cost of performance.
90
90
Defaults to 5.
91
91
@@ -94,29 +94,29 @@ doesn't take the query into account that is part of request.
94
94
suggestion should appear in. This can be specified as an absolute number
95
95
or as a relative percentage of number of documents. This can improve
96
96
quality by only suggesting high frequency terms. Defaults to 0f and is
97
- not enabled. If a value higher than 1 is specified then the number
97
+ not enabled. If a value higher than 1 is specified, then the number
98
98
cannot be fractional. The shard level document frequencies are used for
99
99
this option.
100
100
101
101
`max_term_freq`::
102
- The maximum threshold in number of documents a
102
+ The maximum threshold in number of documents in which a
103
103
suggest text token can exist in order to be included. Can be a relative
104
- percentage number (e.g 0.4) or an absolute number to represent document
105
- frequencies. If an value higher than 1 is specified then fractional can
104
+ percentage number (e.g., 0.4) or an absolute number to represent document
105
+ frequencies. If a value higher than 1 is specified, then fractional can
106
106
not be specified. Defaults to 0.01f. This can be used to exclude high
107
- frequency terms from being spellchecked. High frequency terms are
108
- usually spelled correctly on top of this also improves the spellcheck
109
- performance. The shard level document frequencies are used for this
110
- option.
107
+ frequency terms -- which are usually spelled correctly -- from being spellchecked.
108
+ This also improves the spellcheck performance. The shard level document frequencies
109
+ are used for this option.
111
110
112
111
`string_distance`::
113
112
Which string distance implementation to use for comparing how similar
114
113
suggested terms are. Five possible values can be specified:
115
- `internal` - The default based on damerau_levenshtein but highly optimized
114
+
115
+ ** `internal`: The default based on damerau_levenshtein but highly optimized
116
116
for comparing string distance for terms inside the index.
117
- `damerau_levenshtein` - String distance algorithm based on
117
+ ** `damerau_levenshtein`: String distance algorithm based on
118
118
Damerau-Levenshtein algorithm.
119
- `levenshtein` - String distance algorithm based on Levenshtein edit distance
119
+ ** `levenshtein`: String distance algorithm based on Levenshtein edit distance
120
120
algorithm.
121
- `jaro_winkler` - String distance algorithm based on Jaro-Winkler algorithm.
122
- `ngram` - String distance algorithm based on character n-grams.
121
+ ** `jaro_winkler`: String distance algorithm based on Jaro-Winkler algorithm.
122
+ ** `ngram`: String distance algorithm based on character n-grams.
0 commit comments