Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions docs/reference/elasticsearch/mapping-reference/semantic-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,34 @@ POST test-index/_search
```

1. Specifies the maximum number of fragments to return.
2. Sorts highlighted fragments by score when set to `score`. By default, fragments will be output in the order they appear in the field (order: none).
2. Sorts the most relevant highlighted fragments by score when set to `score`. By default,
fragments will be output in the order they appear in the field (order: none).

To use the `semantic` highlighter to view chunks in the order which they were indexed with no scoring,
use the `match_all` query to retrieve them in the order they appear in the document:

Highlighting is supported on fields other than semantic_text. However, if you want to restrict highlighting to the semantic highlighter and return no fragments when the field is not of type semantic_text, you can explicitly enforce the `semantic` highlighter in the query:
```console
POST test-index/_search
{
"query": {
"match_all": {}
},
"highlight": {
"fields": {
"my_semantic_field": {
"number_of_fragments": 5 <1>
}
}
}
}
```

1. This will return the first 5 chunks, set this number higher to retrieve more chunks.

Highlighting is supported on fields other than semantic_text. However, if you
want to restrict highlighting to the semantic highlighter and return no
fragments when the field is not of type semantic_text, you can explicitly
enforce the `semantic` highlighter in the query:

```console
PUT test-index
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/elasticsearch/rest-apis/highlighting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ applies_to:

# Highlighting [highlighting]

Highlighters enable you to get highlighted snippets from one or more fields in your search results so you can show users where the query matches are. When you request highlights, the response contains an additional `highlight` element for each search hit that includes the highlighted fields and the highlighted fragments.
Highlighters enable you to retrieve the best-matching highlighted snippets from one or more fields in your search results so you can show users where the query matches are. When you request highlights, the response contains an additional `highlight` element for each search hit that includes the highlighted fields and the highlighted fragments.

::::{note}
Highlighters don’t reflect the boolean logic of a query when extracting terms to highlight. Thus, for some complex boolean queries (e.g nested boolean queries, queries using `minimum_should_match` etc.), parts of documents may be highlighted that don’t correspond to query matches.
Expand Down