OpenSearch/docs/reference
Luca Cavanna 48ac9747a8 Added third highlighter type based on lucene postings highlighter
Requires field index_options set to "offsets" in order to store positions and offsets in the postings list.
Considerably faster than the plain highlighter since it doesn't require to reanalyze the text to be highlighted: the larger the documents the better the performance gain should be.
Requires less disk space than term_vectors, needed for the fast_vector_highlighter.
Breaks the text into sentences and highlights them. Uses a BreakIterator to find sentences in the text. Plays really well with natural text, not quite the same if the text contains html markup for instance.
Treats the document as the whole corpus, and scores individual sentences as if they were documents in this corpus, using the BM25 algorithm.

Uses forked version of lucene postings highlighter to support:
- per value discrete highlighting for fields that have multiple values, needed when number_of_fragments=0 since we want to return a snippet per value
- manually passing in query terms to avoid calling extract terms multiple times, since we use a different highlighter instance per doc/field, but the query is always the same

The lucene postings highlighter api is  quite different compared to the existing highlighters api, the main difference being that it allows to highlight multiple fields in multiple docs with a single call, ensuring sequential IO.
The way it is introduced in elasticsearch in this first round is a compromise trying not to change the current highlight api, which works per document, per field. The main disadvantage is that we lose the sequential IO, but we can always refactor the highlight api to work with multiple documents.

Supports pre_tag, post_tag, number_of_fragments (0 highlights the whole field), require_field_match, no_match_size, order by score and html encoding.

Closes #3704
2013-10-24 23:38:00 +02:00
..
analysis Add support for Lucene SuggestStopFilter 2013-10-15 16:12:02 +02:00
cluster Clean up wording to reduce confusion 2013-10-21 12:37:50 +01:00
docs [Docs] update reference to remove documentation about percolating during an index, bulk or update request. 2013-10-16 16:31:36 +02:00
images add docs on new service.bat facility 2013-09-23 18:24:31 +03:00
index-modules [DOCS] Added compound_on_flush docs and updated compound_format 2013-10-15 13:30:56 +02:00
indices [DOCS] Added compound_on_flush docs and updated compound_format 2013-10-15 13:30:56 +02:00
mapping Document strict dynamic type mapping. 2013-10-18 08:29:31 -07:00
modules [DOCS] Added script.disable_dynamic to the scripting page 2013-10-15 12:25:07 +02:00
query-dsl [Docs] update reference to remove documentation about percolating during an index, bulk or update request. 2013-10-16 16:31:36 +02:00
search Added third highlighter type based on lucene postings highlighter 2013-10-24 23:38:00 +02:00
setup [DOCS] How to check max_file_descriptors 2013-10-17 11:54:36 +02:00
analysis.asciidoc Add more anchor links to documentation 2013-09-30 13:13:16 -06:00
api-conventions.asciidoc [DOCS] Reorganised common API conventions 2013-10-13 16:46:56 +02:00
cluster.asciidoc [DOCS] Reorganised common API conventions 2013-10-13 16:46:56 +02:00
docs.asciidoc [DOCS] Reorganised common API conventions 2013-10-13 16:46:56 +02:00
glossary.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
index-modules.asciidoc [DOCS] Added compound_on_flush docs and updated compound_format 2013-10-15 13:30:56 +02:00
index.asciidoc [DOCS] Reorganised common API conventions 2013-10-13 16:46:56 +02:00
indices.asciidoc Add more anchor links to documentation 2013-09-30 13:13:16 -06:00
mapping.asciidoc Uniquify anchor links to fix asciidoc/docbook generation 2013-09-30 15:32:00 -06:00
modules.asciidoc [DOCS] Removed outdated new/deprecated version notices 2013-09-03 21:28:31 +02:00
query-dsl.asciidoc Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00
search.asciidoc [Docs] update reference to remove documentation about percolating during an index, bulk or update request. 2013-10-16 16:31:36 +02:00
setup.asciidoc add docs on new service.bat facility 2013-09-23 18:24:31 +03:00