mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
075d08eb64
This commit updates the `dense_vector` docs to include information on the new `index`, `similarity`, and `index_options` parameters. It also tries to clarify the difference between `similarity` and `index_options` with the existing parameters that have the same name. Relates to #78473.
65 lines
1.7 KiB
Text
65 lines
1.7 KiB
Text
[[index-options]]
|
|
=== `index_options`
|
|
|
|
The `index_options` parameter controls what information is added to the
|
|
inverted index for search and highlighting purposes. Only term-based field
|
|
types like <<text,`text`>> and <<keyword,`keyword`>> support this
|
|
configuration.
|
|
|
|
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?_
|
|
|
|
`freqs`::
|
|
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>>.
|
|
|
|
`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.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT my-index-000001
|
|
{
|
|
"mappings": {
|
|
"properties": {
|
|
"text": {
|
|
"type": "text",
|
|
"index_options": "offsets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my-index-000001/_doc/1
|
|
{
|
|
"text": "Quick brown fox"
|
|
}
|
|
|
|
GET my-index-000001/_search
|
|
{
|
|
"query": {
|
|
"match": {
|
|
"text": "brown fox"
|
|
}
|
|
},
|
|
"highlight": {
|
|
"fields": {
|
|
"text": {} <1>
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
|
|
<1> The `text` field will use the postings for the highlighting by default because `offsets` are indexed.
|