Share via

ITextSearch Interface

Definition

Namespace:
Microsoft.SemanticKernel.Data
Assembly:
Microsoft.SemanticKernel.Abstractions.dll
Package:
Microsoft.SemanticKernel.Abstractions v1.45.0

Interface for text based search queries for use with Semantic Kernel prompts and automatic function calling.

public interface ITextSearch
type ITextSearch = interface
Public Interface ITextSearch
Derived

Methods

GetSearchResultsAsync(String, TextSearchOptions, CancellationToken)

Perform a search for content related to the specified query and return Object values representing the search results.
GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken)

Perform a search for content related to the specified query and return TextSearchResult values representing the search results.
SearchAsync(String, TextSearchOptions, CancellationToken)

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

Extension Methods

CreateGetSearchResults(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)

Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetSearchResults(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)

Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetTextSearchResults(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)

Create a KernelFunction which invokes GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetTextSearchResults(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)

Create a KernelFunction which invokes GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateSearch(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)

Create a KernelFunction which invokes SearchAsync(String, TextSearchOptions, CancellationToken).
CreateSearch(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)

Create a KernelFunction which invokes SearchAsync(String, TextSearchOptions, CancellationToken).
CreateWithGetSearchResults(ITextSearch, String, String)

Creates a plugin from an ITextSearch implementation.
CreateWithGetSearchResults(ITextSearch, String, JsonSerializerOptions, String)

Creates a plugin from an ITextSearch implementation.
CreateWithGetTextSearchResults(ITextSearch, String, String)

Creates a plugin from an ITextSearch implementation.
CreateWithGetTextSearchResults(ITextSearch, String, JsonSerializerOptions, String)

Creates a plugin from an ITextSearch implementation.
CreateWithSearch(ITextSearch, String, String)

Creates a plugin from an ITextSearch implementation.
CreateWithSearch(ITextSearch, String, JsonSerializerOptions, String)

Creates a plugin from an ITextSearch implementation.

Applies to