From d8a78b9d26f88174b8161c5c1fbb94692290bdb5 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Wed, 17 Mar 2021 10:43:41 -0400 Subject: [PATCH] [DOCs] Add tip for `index_options` parameter (#70450) (#70498) Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> Co-authored-by: yudidi <972656027@qq.com> --- .../mapping/params/index-options.asciidoc | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/reference/mapping/params/index-options.asciidoc b/docs/reference/mapping/params/index-options.asciidoc index 87178e6fc6493..b66de828f3c35 100644 --- a/docs/reference/mapping/params/index-options.asciidoc +++ b/docs/reference/mapping/params/index-options.asciidoc @@ -10,25 +10,27 @@ The `index_options` parameter is intended for use with <> 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 -<>. +Positions can be used for <>. `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 <> 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 <> to speed up highlighting. [source,console] --------------------------------------------------