Skip to content

[DOCS] Clarify max_shingle_size parm def #53480

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 2 commits into from
Mar 13, 2020
Merged

[DOCS] Clarify max_shingle_size parm def #53480

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd3a9be
[DOCS] Clarify `max_shingle_size` parm def
jrodewig Mar 12, 2020
f889895
iter
jrodewig Mar 12, 2020
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
15 changes: 9 additions & 6 deletions docs/reference/mapping/types/search-as-you-type.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,15 +162,18 @@ GET my_index/_search
The following parameters are accepted in a mapping for the `search_as_you_type`
field and are specific to this field type

[horizontal]

`max_shingle_size`::
+
--
(Optional, integer)
Largest shingle size to create. Valid values are `2` (inclusive) to `4`
(inclusive). Defaults to `3`.

The largest shingle size to index the input with and create subfields for,
creating one subfield for each shingle size between 2 and
`max_shingle_size`. Accepts integer values between 2 and 4 inclusive. This
option defaults to 3.
A subfield is created for each integer between `2` and this value. For example,
a value of `3` creates two subfields: `my_field._2gram` and `my_field._3gram`

More subfields enables more specific queries but increases index size.
--

[[general-params]]
==== Parameters of the field type as a text field
Expand Down