TextSearchExtensions.CreateGetSearchResults Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
CreateGetSearchResults(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)
Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
public static Microsoft.SemanticKernel.KernelFunction CreateGetSearchResults(this Microsoft.SemanticKernel.Data.ITextSearch textSearch, Microsoft.SemanticKernel.KernelFunctionFromMethodOptions? options = default, Microsoft.SemanticKernel.Data.TextSearchOptions? searchOptions = default);static member CreateGetSearchResults : Microsoft.SemanticKernel.Data.ITextSearch * Microsoft.SemanticKernel.KernelFunctionFromMethodOptions * Microsoft.SemanticKernel.Data.TextSearchOptions -> Microsoft.SemanticKernel.KernelFunction<Extension()>
Public Function CreateGetSearchResults (textSearch As ITextSearch, Optional options As KernelFunctionFromMethodOptions = Nothing, Optional searchOptions As TextSearchOptions = Nothing) As KernelFunctionParameters
- textSearch
- ITextSearch
The ITextSearch instance to use.
- options
- KernelFunctionFromMethodOptions
Optional KernelFunctionFromMethodOptions which allow the KernelFunction metadata to be specified.
- searchOptions
- TextSearchOptions
Optional TextSearchOptions which override the options provided when the function is invoked.
Returns
A KernelFunction instance with a Search operation that calls the provided GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
Applies to
CreateGetSearchResults(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)
Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
public static Microsoft.SemanticKernel.KernelFunction CreateGetSearchResults(this Microsoft.SemanticKernel.Data.ITextSearch textSearch, System.Text.Json.JsonSerializerOptions jsonSerializerOptions, Microsoft.SemanticKernel.KernelFunctionFromMethodOptions? options = default, Microsoft.SemanticKernel.Data.TextSearchOptions? searchOptions = default);static member CreateGetSearchResults : Microsoft.SemanticKernel.Data.ITextSearch * System.Text.Json.JsonSerializerOptions * Microsoft.SemanticKernel.KernelFunctionFromMethodOptions * Microsoft.SemanticKernel.Data.TextSearchOptions -> Microsoft.SemanticKernel.KernelFunction<Extension()>
Public Function CreateGetSearchResults (textSearch As ITextSearch, jsonSerializerOptions As JsonSerializerOptions, Optional options As KernelFunctionFromMethodOptions = Nothing, Optional searchOptions As TextSearchOptions = Nothing) As KernelFunctionParameters
- textSearch
- ITextSearch
The ITextSearch instance to use.
- jsonSerializerOptions
- JsonSerializerOptions
The JsonSerializerOptions to use for serialization and deserialization of various aspects of the function.
- options
- KernelFunctionFromMethodOptions
Optional KernelFunctionFromMethodOptions which allow the KernelFunction metadata to be specified.
- searchOptions
- TextSearchOptions
Optional TextSearchOptions which override the options provided when the function is invoked.
Returns
A KernelFunction instance with a Search operation that calls the provided GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).