WebSearchToolboxTool interface

Paquete:

@azure/ai-projects

Una herramienta de búsqueda web almacenada en una caja de herramientas.

Extends

ToolboxTool

Propiedades

custom_search_configuration	La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 recurso de conexión asociado a la herramienta.
external_web_access	Permitir acceso a internet en directo para búsquedas web. Por defecto se aplica a verdadero cuando se omite. Cuando es falso, la herramienta de búsqueda web se ejecuta en modo offline/solo caché y no recupera contenido externo nuevo.
filters	Filtros que restringen los resultados de búsqueda web a dominios permitidos.
search_context_size	Orientación general sobre la cantidad de espacio de ventana de contexto que se va a usar para la búsqueda. Uno delow, medium o high. medium es el valor predeterminado.
type	El tipo de herramienta de caja de herramientas. Siempre web_search para una herramienta de búsqueda web.
user_location	La ubicación aproximada del usuario, utilizada para mejorar la relevancia de los resultados de búsqueda web.

Propiedades heredadas

description	Descripción opcional definida por el usuario para esta herramienta o configuración.
name	Nombre opcional definido por el usuario para esta herramienta o configuración.
tool_configs	Mapa de configuración por herramienta. Las claves son nombres de herramientas o * (predeterminado caótico). Orden de resolución: la coincidencia exacta con el nombre de la herramienta tiene prioridad sobre *. Los nombres de herramientas desconocidos se ignoran silenciosamente en tiempo de ejecución.

Detalles de las propiedades

custom_search_configuration

La project conexiones conectadas a esta herramienta. Puede haber un máximo de 1 recurso de conexión asociado a la herramienta.

custom_search_configuration?: WebSearchConfiguration

Valor de propiedad

WebSearchConfiguration

external_web_access

Permitir acceso a internet en directo para búsquedas web. Por defecto se aplica a verdadero cuando se omite. Cuando es falso, la herramienta de búsqueda web se ejecuta en modo offline/solo caché y no recupera contenido externo nuevo.

external_web_access?: boolean

Valor de propiedad

boolean

filters

Filtros que restringen los resultados de búsqueda web a dominios permitidos.

filters?: WebSearchToolFilters

Valor de propiedad

WebSearchToolFilters

search_context_size

Orientación general sobre la cantidad de espacio de ventana de contexto que se va a usar para la búsqueda. Uno delow, medium o high. medium es el valor predeterminado.

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

Valor de propiedad

"low" | "medium" | "high"

type

El tipo de herramienta de caja de herramientas. Siempre web_search para una herramienta de búsqueda web.

type: "web_search"

Valor de propiedad

"web_search"

user_location

La ubicación aproximada del usuario, utilizada para mejorar la relevancia de los resultados de búsqueda web.

user_location?: WebSearchApproximateLocation

Valor de propiedad

WebSearchApproximateLocation

Detalles de las propiedades heredadas

description

Descripción opcional definida por el usuario para esta herramienta o configuración.

description?: string

Valor de propiedad

string

Heredado deToolboxTool.description

name

Nombre opcional definido por el usuario para esta herramienta o configuración.

name?: string

Valor de propiedad

string

Heredado deToolboxTool.name

tool_configs

Mapa de configuración por herramienta. Las claves son nombres de herramientas o * (predeterminado caótico). Orden de resolución: la coincidencia exacta con el nombre de la herramienta tiene prioridad sobre *. Los nombres de herramientas desconocidos se ignoran silenciosamente en tiempo de ejecución.

tool_configs?: Record<string, ToolConfig>

Valor de propiedad

Record<string, ToolConfig>

Heredado deToolboxTool.tool_configs