Skip to content

Commit f7eb20e

Browse files
Add positions info into term_vector doc (#44379)
1 parent 3e6add5 commit f7eb20e

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/reference/mapping/params/term-vector.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Term vectors contain information about the terms produced by the
88
* the position (or order) of each term.
99
* the start and end character offsets mapping the term to its
1010
origin in the original string.
11+
* payloads (if they are available) — user-defined binary data
12+
associated with each term position.
1113

1214
These term vectors can be stored so that they can be retrieved for a
1315
particular document.
@@ -20,9 +22,11 @@ The `term_vector` setting accepts:
2022
`with_positions`:: Terms and positions are stored.
2123
`with_offsets`:: Terms and character offsets are stored.
2224
`with_positions_offsets`:: Terms, positions, and character offsets are stored.
25+
`with_positions_payloads`:: Terms, positions, and payloads are stored.
26+
`with_positions_offsets_payloads`:: Terms, positions, offsets and payloads are stored.
2327

24-
The fast vector highlighter requires `with_positions_offsets`. The term
25-
vectors API can retrieve whatever is stored.
28+
The fast vector highlighter requires `with_positions_offsets`.
29+
<<docs-termvectors, The term vectors API>> can retrieve whatever is stored.
2630

2731
WARNING: Setting `with_positions_offsets` will double the size of a field's
2832
index.

0 commit comments

Comments
 (0)