 | IFulltext |
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: 6.0.0
SyntaxTask<IList<string>> BuildSnippetsAsync<TDocument>( IEnumerable<string> data, string query, SnippetsOptions options )
Parameters
- data IEnumerableString
- The data to build snippets for.
- query String
- The query to build snippets for.
- options SnippetsOptions
- 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
TaskIListStringA list of strings with the snippets.
Exceptions| Exception | Condition |
|---|---|
| ObjectDisposedException | Occurs when the session has already been disposed. |
| ArgumentNullException | One of data, query or options is null. |
| ArgumentException | query is empty. |
| FulltextException | Occurs when there is an error during the execution of the query. |
Example
Suppose you have the following class representing a document in your index:
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