Share via


WebKernelBuilderExtensions.AddTavilyTextSearch Method

Definition

Register an ITextSearch instance with the specified service ID.

public static Microsoft.SemanticKernel.IKernelBuilder AddTavilyTextSearch(this Microsoft.SemanticKernel.IKernelBuilder builder, string apiKey, Microsoft.SemanticKernel.Plugins.Web.Tavily.TavilyTextSearchOptions? options = default, string? serviceId = default);
static member AddTavilyTextSearch : Microsoft.SemanticKernel.IKernelBuilder * string * Microsoft.SemanticKernel.Plugins.Web.Tavily.TavilyTextSearchOptions * string -> Microsoft.SemanticKernel.IKernelBuilder
<Extension()>
Public Function AddTavilyTextSearch (builder As IKernelBuilder, apiKey As String, Optional options As TavilyTextSearchOptions = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder

Parameters

builder
IKernelBuilder

The IKernelBuilder to register the ITextSearch on.

apiKey
String

The API key credential used to authenticate requests against the Search service.

options
TavilyTextSearchOptions

Instance of TavilyTextSearchOptions to used when creating the TavilyTextSearch.

serviceId
String

An optional service id to use as the service key.

Returns

Applies to