WebSearchToolboxTool interface

Pacote:

@azure/ai-projects

Uma ferramenta de pesquisa web guardada numa caixa de ferramentas.

Extends

ToolboxTool

Propriedades

custom_search_configuration	As ligações do project ligadas a esta ferramenta. Pode haver um máximo de 1 recurso de conexão anexado à ferramenta.
external_web_access	Permitir acesso à internet em tempo real para pesquisa na web. Por defeito, é verdadeiro quando omitido. Quando falso, a ferramenta de pesquisa web funciona em modo offline/apenas cache e não irá buscar novo conteúdo externo.
filters	Filtros que restringem resultados de pesquisa web a domínios permitidos.
search_context_size	Orientação de alto nível para a quantidade de espaço na janela de contexto a ser usada para a pesquisa. Um de low, medium, ou high. medium é o padrão.
type	O tipo de ferramenta da caixa de ferramentas. Sempre web_search para uma ferramenta de pesquisa na web.
user_location	A localização aproximada do utilizador, usada para melhorar a relevância dos resultados de pesquisa na web.

Propriedades Herdadas

description	Descrição opcional definida pelo utilizador para esta ferramenta ou configuração.
name	Nome opcional definido pelo utilizador para esta ferramenta ou configuração.
tool_configs	Mapa de configuração por ferramenta. As chaves são nomes de ferramentas ou * (padrão abrangente). Ordem de resolução: a correspondência exata do nome da ferramenta tem prioridade sobre *. Nomes de ferramentas desconhecidos são silenciosamente ignorados em tempo de execução.

Detalhes de Propriedade

custom_search_configuration

As ligações do project ligadas a esta ferramenta. Pode haver um máximo de 1 recurso de conexão anexado à ferramenta.

custom_search_configuration?: WebSearchConfiguration

Valor de Propriedade

WebSearchConfiguration

external_web_access

Permitir acesso à internet em tempo real para pesquisa na web. Por defeito, é verdadeiro quando omitido. Quando falso, a ferramenta de pesquisa web funciona em modo offline/apenas cache e não irá buscar novo conteúdo externo.

external_web_access?: boolean

Valor de Propriedade

boolean

filters

Filtros que restringem resultados de pesquisa web a domínios permitidos.

filters?: WebSearchToolFilters

Valor de Propriedade

WebSearchToolFilters

search_context_size

Orientação de alto nível para a quantidade de espaço na janela de contexto a ser usada para a pesquisa. Um de low, medium, ou high. medium é o padrão.

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

Valor de Propriedade

"low" | "medium" | "high"

type

O tipo de ferramenta da caixa de ferramentas. Sempre web_search para uma ferramenta de pesquisa na web.

type: "web_search"

Valor de Propriedade

"web_search"

user_location

A localização aproximada do utilizador, usada para melhorar a relevância dos resultados de pesquisa na web.

user_location?: WebSearchApproximateLocation

Valor de Propriedade

WebSearchApproximateLocation

Detalhes da Propriedade Herdada

description

Descrição opcional definida pelo utilizador para esta ferramenta ou configuração.

description?: string

Valor de Propriedade

string

Herdado deToolboxTool.description

name

Nome opcional definido pelo utilizador para esta ferramenta ou configuração.

name?: string

Valor de Propriedade

string

Herdado deToolboxTool.name

tool_configs

Mapa de configuração por ferramenta. As chaves são nomes de ferramentas ou * (padrão abrangente). Ordem de resolução: a correspondência exata do nome da ferramenta tem prioridade sobre *. Nomes de ferramentas desconhecidos são silenciosamente ignorados em tempo de execução.

tool_configs?: Record<string, ToolConfig>

Valor de Propriedade

Record<string, ToolConfig>

Herdado deToolboxTool.tool_configs