Apache Solr Reference Guide Covering Apache Solr 6.0

Postings Highlighter Parameters
The table below describes Solr's parameters for this highlighter. These parameters can be set as defaults (as in
the examples), or the default values can be changed in the request handler or at query time. Most of the
parameters can be specified per-field (exceptions noted below).
Parameter Default Description
hl
blank (no
highlight)
When set to true, enables highlighted snippets to be generated
in the query response. If set to false or to a blank or missing
value, disables highlighting.
hl.q blank Specifies an overriding query term for highlighting. If hl.q is
specified, the highlighter will use that term rather than the main
query term.
hl.fl blank Specifies a list of fields to highlight. Accepts a comma- or
space-delimited list of fields for which Solr should generate
highlighted snippets. If left blank, highlights the
defaultSearchField (or the field specified the df parameter if
used) for the StandardRequestHandler. For the
DisMaxRequestHandler, the qf fields are used as defaults.
A '*' can be used to match field globs, such as 'text_*' or even '*'
to highlight on all fields where highlighting is possible. When
using '*', consider adding hl.requireFieldMatch=true.
hl.snippets 1 Specifies maximum number of highlighted snippets to generate
per field. It is possible for any number of snippets from zero to
this value to be generated. This parameter accepts per-field
overrides.
hl.tag.pre Specifies the text that should appear before a highlighted term.
hl.tag.post Specifies the text that should appear after a highlighted term.
hl.tag.ellipsis "... " Specifies the text that should join two unconnected passages in
the resulting snippet.
hl.maxAnalyzedChars 10000 Specifies the number of characters into a document that Solr
should look for suitable snippets. This parameter does not
accept per-field overrides.
hl.multiValuedSeparatorChar " " (space) Specifies the logical separator between multi-valued fields.
hl.defaultSummary true If true, a field should have a default summary if highlighting
finds no matching passages.
hl.encoder simple Defines the encoding for the resulting snippet. The value simple
applies no escaping, while html will escape HTML characters in
the text.
hl.score.k1 1.2 Specifies BM25 term frequency normalization parameter 'k1'.
For example, it can be set to "0" to rank passages solely based
on the number of query terms that match.
Apache Solr Reference Guide 6.0
322