honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Reorganised the highlight_query docs and added a version flag

This commit is contained in:
Clinton Gormley 2013-10-18 18:03:31 +02:00
parent b7d8c275eb
commit b2d82d7e75
1 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/reference/search/request/highlighting.asciidoc
View File

@ -27,14 +27,14 @@ required. If the field in question is stored (has `store` set to `yes`
in the mapping), it will be used, otherwise, the actual `_source` will in the mapping), it will be used, otherwise, the actual `_source` will
be loaded and the relevant field will be extracted from it. be loaded and the relevant field will be extracted from it.
If `term_vector` information is provided by setting `term_vector` to If `term_vector` information is provided by setting `term_vector` to
`with_positions_offsets` in the mapping then the fast vector `with_positions_offsets` in the mapping then the fast vector
highlighter will be used instead of the plain highlighter. The fast vector highlighter: highlighter will be used instead of the plain highlighter. The fast vector highlighter:
* Is faster especially for large fields (> `1MB`) * Is faster especially for large fields (> `1MB`)
* Can be customized with `boundary_chars`, `boundary_max_scan`, and * Can be customized with `boundary_chars`, `boundary_max_scan`, and
`fragment_offset` (see below) `fragment_offset` (see below)
* Requires setting `term_vector` to `with_positions_offsets` which * Requires setting `term_vector` to `with_positions_offsets` which
increases the size of the index increases the size of the index
Here is an example of setting the `content` field to allow for Here is an example of setting the `content` field to allow for
@ -142,6 +142,30 @@ order by score:
} }
-------------------------------------------------- --------------------------------------------------
If the `number_of_fragments` value is set to 0 then no fragments are
produced, instead the whole content of the field is returned, and of
course it is highlighted. This can be very handy if short texts (like
document title or address) need to be highlighted but no fragmentation
is required. Note that `fragment_size` is ignored in this case.
[source,js]
--------------------------------------------------
{
"query" : {...},
"highlight" : {
"fields" : {
"_all" : {},
"bio.title" : {"number_of_fragments" : 0}
}
}
}
--------------------------------------------------
When using `fast-vector-highlighter` one can use `fragment_offset`
parameter to control the margin to start highlighting from.
==== Highlight query
It is also possible to highlight against a query other than the search It is also possible to highlight against a query other than the search
query by setting `highlight_query`. This is especially useful if you query by setting `highlight_query`. This is especially useful if you
use a rescore query because those are not taken into account by use a rescore query because those are not taken into account by
@ -213,28 +237,6 @@ Note the score of text fragment in this case is calculated by Lucene
highlighting framework. For implementation details you can check highlighting framework. For implementation details you can check
`ScoreOrderFragmentsBuilder.java` class. `ScoreOrderFragmentsBuilder.java` class.
If the `number_of_fragments` value is set to 0 then no fragments are
produced, instead the whole content of the field is returned, and of
course it is highlighted. This can be very handy if short texts (like
document title or address) need to be highlighted but no fragmentation
is required. Note that `fragment_size` is ignored in this case.
[source,js]
--------------------------------------------------
{
"query" : {...},
"highlight" : {
"fields" : {
"_all" : {},
"bio.title" : {"number_of_fragments" : 0}
}
}
}
--------------------------------------------------
When using `fast-vector-highlighter` one can use `fragment_offset`
parameter to control the margin to start highlighting from.
[[highlighting-settings]] [[highlighting-settings]]
==== Global Settings ==== Global Settings