WebSearchTool interface

Pacote:

@azure/ai-projects

Pesquise na Internet fontes relacionadas ao prompt. Saiba mais sobre a ferramenta de pesquisa web.

Extends

Tool

Propriedades

custom_search_configuration	O project conexões anexadas a essa ferramenta. Pode haver um máximo de 1 recurso de conexão anexado à ferramenta.
description	Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.
filters	Filtros para aplicar nos resultados de busca na web.
name	Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.
search_context_size	Diretrizes de alto nível para a quantidade de espaço de janela de contexto a ser usada para a pesquisa. Uma opção entre low, medium ou high. medium é o padrão.
tool_configs	Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.
type	O tipo da ferramenta de pesquisa na Web. Uma opção entre web_search ou web_search_2025_08_26.
user_location	A localização aproximada do usuário para relevância na busca.

Detalhes da propriedade

custom_search_configuration

O project conexões anexadas a essa ferramenta. Pode haver um máximo de 1 recurso de conexão anexado à ferramenta.

custom_search_configuration?: WebSearchConfiguration

Valor da propriedade

WebSearchConfiguration

description

Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.

description?: string

Valor da propriedade

string

filters

Filtros para aplicar nos resultados de busca na web.

filters?: WebSearchToolFilters

Valor da propriedade

WebSearchToolFilters

name

Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.

name?: string

Valor da propriedade

string

search_context_size

Diretrizes de alto nível para a quantidade de espaço de janela de contexto a ser usada para a pesquisa. Uma opção entre low, medium ou high. medium é o padrão.

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

Valor da propriedade

"low" | "medium" | "high"

tool_configs

Descontinuado. Esta propriedade está obsoleta e será removida em uma versão futura.

tool_configs?: Record<string, ToolConfig>

Valor da propriedade

Record<string, ToolConfig>

type

O tipo da ferramenta de pesquisa na Web. Uma opção entre web_search ou web_search_2025_08_26.

type: "web_search"

Valor da propriedade

"web_search"

user_location

A localização aproximada do usuário para relevância na busca.

user_location?: WebSearchApproximateLocation

Valor da propriedade

WebSearchApproximateLocation