Highlight Matches in Results

One popular feature of search is the ability to highlight matching sections of a document in the search results.

Requirements * The field you want to highlight matches in must be both Stored and IncludeTermVectors. It must be stored so that we have access to the original content to highlight, and it must include term vectors so that we know the byte offsets where each term occurred within the original contnent.

Consider we already have the following search request:

  1.     query := bleve.NewQueryStringQuery(...)
  2.     searchRequest := bleve.NewSearchRequest(query)

We can highlight results with the default highlighter using:

  1.     searchRequest.Highlight = bleve.NewHighlight()

Or we can request use of a specific named highlighter with:

  1.     searchRequest.Highlight = bleve.NewHighlightWithStyle(highlighterName)

Without any other configuration, it will automatically try to highlight any fields which have matches. Sometimes we’re only interested in highlighting a specific field or set of fields.

  1.     searchRequest.Highlight.AddField(field)

Highlighters

HTML

The HTML Result Match Highlighter is registered with the name html.

By default it produces output that looks like:

Highlight Matches in Results - 图1

ANSI

The ANSI Result Match Highlighter is registered with the name ansi.

By default it produces output that looks like:

Highlight Matches in Results - 图2