Click or drag to resize

IFulltextSessionBuildSnippetsAsyncTDocument Method (IEnumerableString, String, SnippetsOptions)

Builds snippets for the given data using the text processing settings from the index for the given document type.

Namespace:  SphinxConnector.FluentApi
Assembly:  SphinxConnector (in SphinxConnector.dll) Version: 5.3.0
Syntax
Copy
Task<IList<string>> BuildSnippetsAsync<TDocument>(
	IEnumerable<string> data,
	string query,
	SnippetsOptions options
)

Parameters

data
Type: System.Collections.GenericIEnumerableString
The data to build snippets for.
query
Type: SystemString
The query to build snippets for.
options
Type: SphinxConnector.FluentApiSnippetsOptions
The options to use.

Type Parameters

TDocument
The document type to build snippets for. This determines the index to take the text processing settings from.

Return Value

Type: TaskIListString
A list of strings with the snippets.
Exceptions
ExceptionCondition
ObjectDisposedExceptionOccurs when the session has already been disposed.
ArgumentNullException One of data, query or options is null.
ArgumentExceptionquery is empty.
FulltextExceptionOccurs when there is an error during the execution of the query.
Examples
Suppose you have the following class representing a document in your index:
Copy
using (IFulltextSession fulltextSession = fulltextStore.StartSession())
{                
    var results = await fulltextSession.Query<Product>().
                                        Match("my query").        
                                        ToList();

    var descriptionSnippets = await fulltextSession.BuildSnippetsAsync<Product>(results.Select(p => p.Description), "my query", new SnippetsOptions
                                                                                                                                          {
                                                                                                                                               BeforeMatch = "<i>",
                                                                                                                                               AfterMatch = "</i>",
                                                                                                                                               HtmlStripMode = HtmlStripMode.Strip
                                                                                                                                          }););        
}
See Also