Skip to content

Commit

Permalink
[DOCs] Add tip for index_options parameter (#70450) (#70498)
Browse files Browse the repository at this point in the history
Co-authored-by: James Rodewig <[email protected]>

Co-authored-by: yudidi <[email protected]>
  • Loading branch information
jrodewig and yudidi authored Mar 17, 2021
1 parent a6ab061 commit d8a78b9
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/reference/mapping/params/index-options.asciidoc
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

0 comments on commit d8a78b9

Please sign in to comment.