SuggestionOptions Class

Represents the options for getting suggestions.

Inheritance Hierarchy

SystemObject
SphinxConnector.FluentApiSuggestionOptions

Namespace: SphinxConnector.FluentApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 3.12.6

Syntax

[SerializableAttribute]
public class SuggestionOptions

<SerializableAttribute>
Public Class SuggestionOptions

The SuggestionOptions type exposes the following members.

Constructors

	Name	Description
	SuggestionOptions	Initializes a new instance of the SuggestionOptions class.

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	DeltaLength	The maximum difference in length between the original input and a suggestion. Default is 3.
	Limit	The maximum number of suggestion to return. Default is 5.
	MaxLevenshteinDistance	The maximum Levenshtein distance between the original input and a suggestion. Default is 4.
	RejectQueueLength	Rejected words are matches that are not better than those already in the match queue. They are put in a rejected queue that gets reset in case one actually can go in the match queue. This option defines the size of the rejected queue (as reject*max(max_matched,limit)). If the rejected queue is filled, the engine stops looking for potential matches.
	ReturnStatistics	Whether to return statistics for a suggestions. Default is true.