IFulltextSession.GetSuggestionsAsync<TDocument> Method (String, SuggestionOptions, CancellationToken)

Asynchronously gets a suggestion for the given word or query. In case of a single word Sphinx' SUGGEST() function is used, in case of a query (multiple words), QSUGGEST() is used.

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

Syntax

Copy

Task<IList<Suggestion>> GetSuggestionsAsync<TDocument>(
	string wordOrQuery,
	SuggestionOptions suggestionOptions,
	CancellationToken cancellationToken
)

Function GetSuggestionsAsync(Of TDocument) ( 
	wordOrQuery As String,
	suggestionOptions As SuggestionOptions,
	cancellationToken As CancellationToken
) As Task(Of IList(Of Suggestion))

Parameters

wordOrQuery: Type: System.String
The word or query to get suggestions for.
suggestionOptions: Type: SphinxConnector.FluentApi.SuggestionOptions
The options to use.
cancellationToken: Type: System.Threading.CancellationToken
The token to monitor for cancellation requests.

Type Parameters

TDocument: The document type to get suggestions for.

Return Value

Type: Task<IList<Suggestion>>
A list of suggestions.

Reference

IFulltextSession Interface

GetSuggestionsAsync Overload

SphinxConnector.FluentApi Namespace