WebSearchToolboxTool interface

Package:

@azure/ai-projects

A web search tool stored in a toolbox.

Extends

ToolboxTool

Properties

custom_search_configuration	The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.
external_web_access	Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.
filters	Filters that restrict web search results to allowed domains.
search_context_size	High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
type	The toolbox tool type. Always web_search for a web search tool.
user_location	The user's approximate location, used to improve the relevance of web search results.

Inherited Properties

description	Optional user-defined description for this tool or configuration.
name	Optional user-defined name for this tool or configuration.
tool_configs	Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

Property Details

custom_search_configuration

The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.

custom_search_configuration?: WebSearchConfiguration

Property Value

WebSearchConfiguration

external_web_access

Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

external_web_access?: boolean

Property Value

boolean

filters

Filters that restrict web search results to allowed domains.

filters?: WebSearchToolFilters

Property Value

WebSearchToolFilters

search_context_size

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

search_context_size?: "low" | "medium" | "high"

Property Value

"low" | "medium" | "high"

type

The toolbox tool type. Always web_search for a web search tool.

type: "web_search"

Property Value

"web_search"

user_location

The user's approximate location, used to improve the relevance of web search results.

user_location?: WebSearchApproximateLocation

Property Value

WebSearchApproximateLocation

Inherited Property Details

description

Optional user-defined description for this tool or configuration.

description?: string

Property Value

string

Inherited From ToolboxTool.description

name

Optional user-defined name for this tool or configuration.

name?: string

Property Value

string

Inherited From ToolboxTool.name

tool_configs

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

tool_configs?: Record<string, ToolConfig>

Property Value

Record<string, ToolConfig>

Inherited From ToolboxTool.tool_configs