WebSearchTool interface

Package:

@azure/ai-projects

Search the Internet for sources related to the prompt. Learn more about the web search tool.

Extends

Tool

Properties

custom_search_configuration	The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.
filters
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 type of the web search tool. One of web_search or web_search_2025_08_26.
user_location

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

filters

filters?: null | WebSearchToolFilters

Property Value

null | 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 type of the web search tool. One of web_search or web_search_2025_08_26.

type: "web_search"

Property Value

"web_search"

user_location

user_location?: null | WebSearchApproximateLocation

Property Value

null | WebSearchApproximateLocation