index_options
The index_options parameter controls what information is added to the inverted index for search and highlighting purposes.
The index_options parameter is intended for use with text fields only. Avoid using index_options with other field data types.
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 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 to speed up highlighting.
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": {}
}
}
} | The |
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/index-options.html
