SolrNet: SolrNet.Commands.Parameters.HighlightingParameters Class Reference

SolrNet

SolrNet.Commands.Parameters.HighlightingParameters Class Reference

Highlighting parameters. More...

List of all members.

Properties

ICollection< string > Fields [get, set]
 List of fields to generate highlighted snippets for. If left blank, the fields highlighted for the StandardRequestHandler are the defaultSearchField (or the df param if used) and for the DisMaxRequestHandler the qf fields are used.
int Snippets [get, set]
 The 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. If left null, it will use whatever default Solr sets (1 for Solr 1.3)
int Fragsize [get, set]
 The size, in characters, of fragments to consider for highlighting. 0 indicates that the whole field value should be used (no fragmenting). If left null, it will use whatever default Solr sets (100 for Solr 1.3)
bool RequireFieldMatch [get, set]
 If true, then a field will only be highlighted if the query matched in this particular field (normally, terms are highlighted in all requested fields regardless of which field matched the query). If left null, it will use whatever default Solr sets (false for Solr 1.3)
string AlternateField [get, set]
 If a snippet cannot be generated (due to no terms matching), you can specify a field to use as the backup/default summary. The default value is to not have a default summary.
string BeforeTerm [get, set]
 The text which appears before a highlighted term. The default value is "&lt;em&gt;".
string AfterTerm [get, set]
 The text which appears after a highlighted term.
double RegexSlop [get, set]
 Factor by which the regex fragmenter can stray from the ideal fragment size (given by hl.fragsize) to accomodate the regular expression. For instance, a slop of 0.2 with fragsize of 100 should yield fragments between 80 and 120 characters in length. It is usually good to provide a slightly smaller fragsize when using the regex fragmenter. The default value is ".6".
string RegexPattern [get, set]
 The regular expression for fragmenting. This could be used to extract sentences.
int RegexMaxAnalyzedChars [get, set]
 Only analyze this many characters from a field when using the regex fragmenter (after which, the fragmenter produces fixed-sized fragments). Applying a complicated regex to a huge field is expensive. The default value is "10000".
bool MergeContiguous [get, set]
 Collapse contiguous fragments into a single fragment. "true" indicates contiguous fragments will be collapsed into single fragment. This parameter makes sense for Highlighter only. The default value is "false", which is also the backward-compatible setting.
bool UsePhraseHighlighter [get, set]
 Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. Default value is "false".
bool UseFastVectorHighlighter [get, set]
 Uses FastVectorHighlighter (Solr 3.1+). FastVectorHighlighter requires the field is termVectors=on, termPositions=on and termOffsets=on. The default value is "false".
bool HighlightMultiTerm [get, set]
 If the SpanScorer is also being used, enables highlighting for range/wildcard/fuzzy/prefix queries. This parameter makes sense for Highlighter only. The default is "false".
int MaxAnalyzedChars [get, set]
 How many characters into a document to look for suitable snippets. This parameter makes sense for Highlighter only. The default value is "51200".
int MaxAlternateFieldLength [get, set]
 If hl.alternateField is specified, this parameter specifies the maximum number of characters of the field to return. Any value less than or equal to 0 means unlimited. The default value is unlimited.
SolrHighlightFragmenter Fragmenter [get, set]
 Specify a text snippet generator for highlighted text. This parameter makes sense for Highlighter only. The default value is "gap".

Detailed Description

Highlighting parameters.


Property Documentation

string SolrNet.Commands.Parameters.HighlightingParameters.AfterTerm [get, set]

The text which appears after a highlighted term.

The default value is "&lt;/em&gt;"

string SolrNet.Commands.Parameters.HighlightingParameters.AlternateField [get, set]

If a snippet cannot be generated (due to no terms matching), you can specify a field to use as the backup/default summary. The default value is to not have a default summary.

string SolrNet.Commands.Parameters.HighlightingParameters.BeforeTerm [get, set]

The text which appears before a highlighted term. The default value is "&lt;em&gt;".

ICollection<string> SolrNet.Commands.Parameters.HighlightingParameters.Fields [get, set]

List of fields to generate highlighted snippets for. If left blank, the fields highlighted for the StandardRequestHandler are the defaultSearchField (or the df param if used) and for the DisMaxRequestHandler the qf fields are used.

SolrHighlightFragmenter SolrNet.Commands.Parameters.HighlightingParameters.Fragmenter [get, set]

Specify a text snippet generator for highlighted text. This parameter makes sense for Highlighter only. The default value is "gap".

int SolrNet.Commands.Parameters.HighlightingParameters.Fragsize [get, set]

The size, in characters, of fragments to consider for highlighting. 0 indicates that the whole field value should be used (no fragmenting). If left null, it will use whatever default Solr sets (100 for Solr 1.3)

bool SolrNet.Commands.Parameters.HighlightingParameters.HighlightMultiTerm [get, set]

If the SpanScorer is also being used, enables highlighting for range/wildcard/fuzzy/prefix queries. This parameter makes sense for Highlighter only. The default is "false".

int SolrNet.Commands.Parameters.HighlightingParameters.MaxAlternateFieldLength [get, set]

If hl.alternateField is specified, this parameter specifies the maximum number of characters of the field to return. Any value less than or equal to 0 means unlimited. The default value is unlimited.

int SolrNet.Commands.Parameters.HighlightingParameters.MaxAnalyzedChars [get, set]

How many characters into a document to look for suitable snippets. This parameter makes sense for Highlighter only. The default value is "51200".

bool SolrNet.Commands.Parameters.HighlightingParameters.MergeContiguous [get, set]

Collapse contiguous fragments into a single fragment. "true" indicates contiguous fragments will be collapsed into single fragment. This parameter makes sense for Highlighter only. The default value is "false", which is also the backward-compatible setting.

int SolrNet.Commands.Parameters.HighlightingParameters.RegexMaxAnalyzedChars [get, set]

Only analyze this many characters from a field when using the regex fragmenter (after which, the fragmenter produces fixed-sized fragments). Applying a complicated regex to a huge field is expensive. The default value is "10000".

string SolrNet.Commands.Parameters.HighlightingParameters.RegexPattern [get, set]

The regular expression for fragmenting. This could be used to extract sentences.

double SolrNet.Commands.Parameters.HighlightingParameters.RegexSlop [get, set]

Factor by which the regex fragmenter can stray from the ideal fragment size (given by hl.fragsize) to accomodate the regular expression. For instance, a slop of 0.2 with fragsize of 100 should yield fragments between 80 and 120 characters in length. It is usually good to provide a slightly smaller fragsize when using the regex fragmenter. The default value is ".6".

bool SolrNet.Commands.Parameters.HighlightingParameters.RequireFieldMatch [get, set]

If true, then a field will only be highlighted if the query matched in this particular field (normally, terms are highlighted in all requested fields regardless of which field matched the query). If left null, it will use whatever default Solr sets (false for Solr 1.3)

int SolrNet.Commands.Parameters.HighlightingParameters.Snippets [get, set]

The 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. If left null, it will use whatever default Solr sets (1 for Solr 1.3)

bool SolrNet.Commands.Parameters.HighlightingParameters.UseFastVectorHighlighter [get, set]

Uses FastVectorHighlighter (Solr 3.1+). FastVectorHighlighter requires the field is termVectors=on, termPositions=on and termOffsets=on. The default value is "false".

bool SolrNet.Commands.Parameters.HighlightingParameters.UsePhraseHighlighter [get, set]

Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the document. Default value is "false".


The documentation for this class was generated from the following file:
  • SolrNet/Commands/Parameters/HighlightingParameters.cs
Generated on Sun May 3 2015 17:19:07 for SolrNet by  doxygen 1.7.2