SolrNet: SolrNet.Commands.Parameters.SpellCheckingParameters Class Reference

SolrNet

SolrNet.Commands.Parameters.SpellCheckingParameters Class Reference

Spell checking parameters. More...

List of all members.

Properties

string Query [get, set]
 The query to spellcheck. If spellcheck.q is defined, then it is used, otherwise the original input query is used. The spellcheck.q parameter is intended to be the original query, minus any extra markup like field names, boosts, etc. If the q parameter is specified, then the SpellingQueryConverter class is used to parse it into tokens, otherwise the WhitesepaceTokenizer is used. The choice of which one to use is up to the application. Essentially, if you have a spelling "ready" version in your application, then it is probably better to send spellcheck.q, otherwise, if you just want Solr to do the job, use the q parameter.
bool Build [get, set]
 Create the dictionary for use by the SolrSpellChecker. In typical applications, one needs to build the dictionary before using it. However, it may not always be necessary as it is possible to setup the spellchecker with a dictionary that already exists.
bool Reload [get, set]
 Reload the spell checker. Depends on the implementation of SolrSpellChecker.reload() but usually means reloading the dictionary.
int Count [get, set]
 The maximum number of suggestions to return.
bool OnlyMorePopular [get, set]
 Only return suggestions that result in more hits for the query than the existing query.
bool Collate [get, set]
 Take the best suggestion for each token (if it exists) and construct a new query from the suggestions.
string Dictionary [get, set]
 The name of the spellchecker to use. This defaults to "default". Can be used to invoke a specific spellchecker on a per request basis.

Detailed Description

Spell checking parameters.


Property Documentation

bool SolrNet.Commands.Parameters.SpellCheckingParameters.Build [get, set]

Create the dictionary for use by the SolrSpellChecker. In typical applications, one needs to build the dictionary before using it. However, it may not always be necessary as it is possible to setup the spellchecker with a dictionary that already exists.

bool SolrNet.Commands.Parameters.SpellCheckingParameters.Collate [get, set]

Take the best suggestion for each token (if it exists) and construct a new query from the suggestions.

int SolrNet.Commands.Parameters.SpellCheckingParameters.Count [get, set]

The maximum number of suggestions to return.

string SolrNet.Commands.Parameters.SpellCheckingParameters.Dictionary [get, set]

The name of the spellchecker to use. This defaults to "default". Can be used to invoke a specific spellchecker on a per request basis.

bool SolrNet.Commands.Parameters.SpellCheckingParameters.OnlyMorePopular [get, set]

Only return suggestions that result in more hits for the query than the existing query.

string SolrNet.Commands.Parameters.SpellCheckingParameters.Query [get, set]

The query to spellcheck. If spellcheck.q is defined, then it is used, otherwise the original input query is used. The spellcheck.q parameter is intended to be the original query, minus any extra markup like field names, boosts, etc. If the q parameter is specified, then the SpellingQueryConverter class is used to parse it into tokens, otherwise the WhitesepaceTokenizer is used. The choice of which one to use is up to the application. Essentially, if you have a spelling "ready" version in your application, then it is probably better to send spellcheck.q, otherwise, if you just want Solr to do the job, use the q parameter.

bool SolrNet.Commands.Parameters.SpellCheckingParameters.Reload [get, set]

Reload the spell checker. Depends on the implementation of SolrSpellChecker.reload() but usually means reloading the dictionary.


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