|
2 | 2 | === `index_options`
|
3 | 3 |
|
4 | 4 | The `index_options` parameter controls what information is added to the
|
5 |
| -inverted index, for search and highlighting purposes. It accepts the |
6 |
| -following settings: |
| 5 | +inverted index for search and highlighting purposes. |
7 | 6 |
|
8 |
| -[horizontal] |
9 |
| -`docs`:: |
10 |
| - |
11 |
| - Only the doc number is indexed. Can answer the question _Does this term |
12 |
| - exist in this field?_ |
| 7 | +[WARNING] |
| 8 | +==== |
| 9 | +The `index_options` parameter is intended for use with <<text,`text`>> fields |
| 10 | +only. Avoid using `index_options` with other field datatypes. |
| 11 | +==== |
13 | 12 |
|
14 |
| -`freqs`:: |
| 13 | +It accepts the following values: |
15 | 14 |
|
16 |
| - Doc number and term frequencies are indexed. Term frequencies are used to |
17 |
| - score repeated terms higher than single terms. |
| 15 | +`docs`:: |
| 16 | +Only the doc number is indexed. Can answer the question _Does this term |
| 17 | +exist in this field?_ |
18 | 18 |
|
19 |
| -`positions`:: |
| 19 | +`freqs`:: |
| 20 | +Doc number and term frequencies are indexed. Term frequencies are used to |
| 21 | +score repeated terms higher than single terms. |
20 | 22 |
|
21 |
| - Doc number, term frequencies, and term positions (or order) are indexed. |
22 |
| - Positions can be used for |
23 |
| - <<query-dsl-match-query-phrase,proximity or phrase queries>>. |
| 23 | +`positions` (default):: |
| 24 | +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>>. |
24 | 27 |
|
25 | 28 | `offsets`::
|
26 |
| - |
27 |
| - Doc number, term frequencies, positions, and start and end character |
28 |
| - offsets (which map the term back to the original string) are indexed. |
29 |
| - Offsets are used by the <<unified-highlighter,unified highlighter>> to speed up highlighting. |
30 |
| - |
31 |
| -NOTE: <<number,Numeric fields>> don't support the `index_options` parameter any longer. |
32 |
| - |
33 |
| -<<text,`text`>> fields use `positions` as the default, and all other fields use |
34 |
| -`docs` as the default. |
| 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. |
35 | 32 |
|
36 | 33 | [source,console]
|
37 | 34 | --------------------------------------------------
|
|
0 commit comments