Struct UnifiedHighlighter

pub struct UnifiedHighlighter { /* private fields */ }

The unified highlighter uses the Lucene Unified Highlighter. This highlighter breaks the text into sentences and uses the BM25 algorithm to score individual sentences as if they were documents in the corpus. It also supports accurate phrase and multi-term (fuzzy, prefix, regex) highlighting. This is the default highlighter.

https://www.elastic.co/guide/en/elasticsearch/reference/current/highlighting.html#unified-highlighter

Implementations

impl UnifiedHighlighter

pub fn new() -> Self

Creates a new UnifiedHighlighter instance

pub fn boundary_chars<T>(self, boundary_chars: T) -> Self

where T: ToString,

A string that contains each boundary character. Defaults to .,!? \t\n.

pub fn boundary_max_scan(self, boundary_max_scan: u32) -> Self

How far to scan for boundary characters. Defaults to 20.

pub fn encoder(self, encoder: Encoder) -> Self

Indicates if the snippet should be HTML encoded.

pub fn force_source(self, force_source: bool) -> Self

Highlight based on the source even if the field is stored separately. Defaults to false.

pub fn fragment_size(self, fragment_size: u32) -> Self

The size of the highlighted fragment in characters. Defaults to 100.

pub fn highlight_query<T>(self, highlight_query: T) -> Self

where T: Into<Query>,

Highlight matches for a query other than the search query. This is especially useful if you use a rescore query because those are not taken into account by highlighting by default.

Warning
Elasticsearch does not validate that highlight_query contains the search query in any way so it is possible to define it so legitimate query results are not highlighted. Generally, you should include the search query as part of the highlight_query.

pub fn no_match_size(self, no_match_size: u32) -> Self

The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. Defaults to 0 (nothing is returned).

pub fn number_of_fragments(self, number_of_fragments: u32) -> Self

The maximum number of fragments to return. If the number of fragments is set to 0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. If number_of_fragments is 0, fragment_size is ignored. Defaults to 5.

pub fn order(self, order: Order) -> Self

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). Setting this option to score will output the most relevant fragments first. Each highlighter applies its own logic to compute relevancy scores. See the document How highlighters work internally for more details how different highlighters find the best fragments.

pub fn require_field_match(self, require_field_match: bool) -> Self

By default, only fields that contains a query match are highlighted. Set require_field_match to false to highlight all fields. Defaults to true.

pub fn tags<T>(self, tags: T) -> Self

where T: Into<Tags>,

Set to styled to use the built-in tag schema or use custom tags

pub fn boundary_scanner(self, boundary_scanner: UnifiedBoundaryScanner) -> Self

Specifies how to break the highlighted fragments.

Trait Implementations

impl Clone for UnifiedHighlighter

fn clone(&self) -> UnifiedHighlighter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnifiedHighlighter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UnifiedHighlighter

fn default() -> Self

Returns the “default value” for a type.

impl From<UnifiedHighlighter> for Highlighter

fn from(highlighter: UnifiedHighlighter) -> Self

Converts to this type from the input type.

impl PartialEq for UnifiedHighlighter

fn eq(&self, other: &UnifiedHighlighter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for UnifiedHighlighter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UnifiedHighlighter