Skip to content

[DOCs] Add tip for index_options parameter #70450

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 4 commits into from
Mar 17, 2021
Merged

[DOCs] Add tip for index_options parameter #70450

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53744b2
Add tip for progressive relationship.
yudidi Mar 16, 2021
55514dd
Reformat
jrodewig Mar 17, 2021
7da014a
Remove tip
jrodewig Mar 17, 2021
af08faa
Reword
jrodewig Mar 17, 2021
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
22 changes: 12 additions & 10 deletions docs/reference/mapping/params/index-options.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,27 @@ The `index_options` parameter is intended for use with <<text,`text`>> fields
only. Avoid using `index_options` with other field data types.
====

It accepts the following values:
The parameter accepts one of the following values. Each value retrieves
information from the previous listed values. For example, `freqs` contains
`docs`; `positions` contains both `freqs` and `docs`.

`docs`::
Only the doc number is indexed. Can answer the question _Does this term
exist in this field?_
Only the doc number is indexed. Can answer the question _Does this term exist in
this field?_

`freqs`::
Doc number and term frequencies are indexed. Term frequencies are used to
score repeated terms higher than single terms.
Doc number and term frequencies are indexed. Term frequencies are used to score
repeated terms higher than single terms.

`positions` (default)::
Doc number, term frequencies, and term positions (or order) are indexed.
Positions can be used for
<<query-dsl-match-query-phrase,proximity or phrase queries>>.
Positions can be used for <<query-dsl-match-query-phrase,proximity or phrase
queries>>.

`offsets`::
Doc number, term frequencies, positions, and start and end character
offsets (which map the term back to the original string) are indexed.
Offsets are used by the <<unified-highlighter,unified highlighter>> to speed up highlighting.
Doc number, term frequencies, positions, and start and end character offsets
(which map the term back to the original string) are indexed. Offsets are used
by the <<unified-highlighter,unified highlighter>> to speed up highlighting.

[source,console]
--------------------------------------------------
Expand Down