FoundryAITool.CreateWebSearchTool Method

Definition

Creates an AITool for web search.

public static Microsoft.Extensions.AI.AITool CreateWebSearchTool(OpenAI.Responses.WebSearchToolLocation? userLocation = default, OpenAI.Responses.WebSearchToolContextSize? searchContextSize = default, OpenAI.Responses.WebSearchToolFilters? filters = default);
static member CreateWebSearchTool : OpenAI.Responses.WebSearchToolLocation * Nullable<OpenAI.Responses.WebSearchToolContextSize> * OpenAI.Responses.WebSearchToolFilters -> Microsoft.Extensions.AI.AITool
Public Shared Function CreateWebSearchTool (Optional userLocation As WebSearchToolLocation = Nothing, Optional searchContextSize As Nullable(Of WebSearchToolContextSize) = Nothing, Optional filters As WebSearchToolFilters = Nothing) As AITool

Parameters

userLocation
OpenAI.Responses.WebSearchToolLocation

Optional user location for search context.

searchContextSize
Nullable<OpenAI.Responses.WebSearchToolContextSize>

Optional search context size.

filters
OpenAI.Responses.WebSearchToolFilters

Optional search filters.

Returns

An AITool for web search.

Applies to