TavilyTextSearch Class

Definition

Namespace:: Microsoft.SemanticKernel.Plugins.Web.Tavily

Assembly:: Microsoft.SemanticKernel.Plugins.Web.dll

Package:: Microsoft.SemanticKernel.Plugins.Web v1.45.0-alpha

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.

A Tavily Text Search implementation that can be used to perform searches using the Tavily Web Search API.

public sealed class TavilyTextSearch : Microsoft.SemanticKernel.Data.ITextSearch

type TavilyTextSearch = class
    interface ITextSearch

Public NotInheritable Class TavilyTextSearch
Implements ITextSearch

Inheritance: Object
TavilyTextSearch

Implements: ITextSearch

Constructors

Name	Description
TavilyTextSearch(String, TavilyTextSearchOptions)	Create an instance of the TavilyTextSearch with API key authentication.

Methods

Name	Description
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

Name	Description
CreateGetSearchResults(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetSearchResults(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetTextSearchResults(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetTextSearchResults(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateSearch(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes SearchAsync(String, TextSearchOptions, CancellationToken).
CreateSearch(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes SearchAsync(String, TextSearchOptions, CancellationToken).
CreateWithGetSearchResults(ITextSearch, String, JsonSerializerOptions, String)	Creates a plugin from an ITextSearch implementation.
CreateWithGetSearchResults(ITextSearch, String, String)	Creates a plugin from an ITextSearch implementation.
CreateWithGetTextSearchResults(ITextSearch, String, JsonSerializerOptions, String)	Creates a plugin from an ITextSearch implementation.
CreateWithGetTextSearchResults(ITextSearch, String, String)	Creates a plugin from an ITextSearch implementation.
CreateWithSearch(ITextSearch, String, JsonSerializerOptions, String)	Creates a plugin from an ITextSearch implementation.
CreateWithSearch(ITextSearch, String, String)	Creates a plugin from an ITextSearch implementation.

Applies to