mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
b98606e712
* [docs] Migrate docs from AsciiDoc to Markdown (#123507) * delete asciidoc files * add migrated files * fix errors * Disable docs tests * Clarify release notes page titles * Revert "Clarify release notes page titles" This reverts commit8be688648d. * Comment out edternal URI images * Clean up query languages landing pages, link to conceptual docs * Add .md to url * Fixes inference processor nesting. --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Co-authored-by: Liam Thompson <leemthompo@gmail.com> Co-authored-by: Martijn Laarman <Mpdreamz@gmail.com> Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com> (cherry picked from commitb7e3a1e14b) # Conflicts: # docs/build.gradle # docs/reference/migration/index.asciidoc # docs/reference/migration/migrate_9_0.asciidoc # docs/reference/release-notes.asciidoc # docs/reference/release-notes/9.0.0.asciidoc # docs/reference/release-notes/highlights.asciidoc * Fix build file * Really fix build file --------- Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
---
|
|
mapped_pages:
|
|
- https://www.elastic.co/guide/en/elasticsearch/plugins/current/mapper-annotated-text-highlighter.html
|
|
---
|
|
|
|
# Using the annotated highlighter [mapper-annotated-text-highlighter]
|
|
|
|
The `annotated-text` plugin includes a custom highlighter designed to mark up search hits in a way which is respectful of the original markup:
|
|
|
|
```console
|
|
# Example documents
|
|
PUT my-index-000001/_doc/1
|
|
{
|
|
"my_field": "The cat sat on the [mat](sku3578)"
|
|
}
|
|
|
|
GET my-index-000001/_search
|
|
{
|
|
"query": {
|
|
"query_string": {
|
|
"query": "cats"
|
|
}
|
|
},
|
|
"highlight": {
|
|
"fields": {
|
|
"my_field": {
|
|
"type": "annotated", <1>
|
|
"require_field_match": false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
1. The `annotated` highlighter type is designed for use with annotated_text fields
|
|
|
|
|
|
The annotated highlighter is based on the `unified` highlighter and supports the same settings but does not use the `pre_tags` or `post_tags` parameters. Rather than using html-like markup such as `<em>cat</em>` the annotated highlighter uses the same markdown-like syntax used for annotations and injects a key=value annotation where `_hit_term` is the key and the matched search term is the value e.g.
|
|
|
|
```
|
|
The [cat](_hit_term=cat) sat on the [mat](sku3578)
|
|
```
|
|
The annotated highlighter tries to be respectful of any existing markup in the original text:
|
|
|
|
* If the search term matches exactly the location of an existing annotation then the `_hit_term` key is merged into the url-like syntax used in the `(...)` part of the existing annotation.
|
|
* However, if the search term overlaps the span of an existing annotation it would break the markup formatting so the original annotation is removed in favour of a new annotation with just the search hit information in the results.
|
|
* Any non-overlapping annotations in the original text are preserved in highlighter selections
|
|
|