Share via


ITextSearch.SearchAsync(String, TextSearchOptions, CancellationToken) Method

Definition

Perform a search for content related to the specified query and return String values representing the search results.

public System.Threading.Tasks.Task<Microsoft.SemanticKernel.Data.KernelSearchResults<string>> SearchAsync(string query, Microsoft.SemanticKernel.Data.TextSearchOptions? searchOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member SearchAsync : string * Microsoft.SemanticKernel.Data.TextSearchOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Data.KernelSearchResults<string>>
Public Function SearchAsync (query As String, Optional searchOptions As TextSearchOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of KernelSearchResults(Of String))

Parameters

query
String

What to search for.

searchOptions
TextSearchOptions

Options used when executing a text search.

cancellationToken
CancellationToken

The CancellationToken to monitor for cancellation requests. The default is None.

Returns

Applies to