Skip to content

Commit ac4ec2b

Browse files
jrodewigyudidi
andauthored
[DOCs] Add tip for index_options parameter (#70450) (#70500)
Co-authored-by: James Rodewig <[email protected]> Co-authored-by: yudidi <[email protected]>
1 parent c32409d commit ac4ec2b

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/reference/mapping/params/index-options.asciidoc

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,27 @@ The `index_options` parameter is intended for use with <<text,`text`>> fields
1010
only. Avoid using `index_options` with other field data types.
1111
====
1212

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

1517
`docs`::
16-
Only the doc number is indexed. Can answer the question _Does this term
17-
exist in this field?_
18+
Only the doc number is indexed. Can answer the question _Does this term exist in
19+
this field?_
1820

1921
`freqs`::
20-
Doc number and term frequencies are indexed. Term frequencies are used to
21-
score repeated terms higher than single terms.
22+
Doc number and term frequencies are indexed. Term frequencies are used to score
23+
repeated terms higher than single terms.
2224

2325
`positions` (default)::
2426
Doc number, term frequencies, and term positions (or order) are indexed.
25-
Positions can be used for
26-
<<query-dsl-match-query-phrase,proximity or phrase queries>>.
27+
Positions can be used for <<query-dsl-match-query-phrase,proximity or phrase
28+
queries>>.
2729

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

3335
[source,console]
3436
--------------------------------------------------

0 commit comments

Comments
 (0)