WebSearchTool interface

Paket:

@azure/ai-projects

Suchen Sie im Internet nach Quellen, die mit dem Prompt zu tun haben. Erfahren Sie mehr über das Web-Suchtool.

Extends

Tool

Eigenschaften

custom_search_configuration	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindungsressource an das Tool angefügt sein.
description	Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.
external_web_access	Erlauben Sie Live-Internetzugang für die Websuche. Standardmäßig wird true angezeigt, wenn es weggelassen wird. Wenn falsch, läuft das Websuchtool im Offline-/Cache-Only-Modus und ruft keine neuen externen Inhalte ab.
filters	Filter, die auf Websuchergebnisse angewendet werden.
name	Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.
search_context_size	Allgemeine Richtlinie für die Menge des Kontextfensterbereichs, der für die Suche verwendet werden soll. Einer der folgenden Werte: low, medium oder high. medium ist die Standardoption.
tool_configs	Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.
type	Der Typ des Websuchtools. Einer der folgenden Werte: web_search oder web_search_2025_08_26.
user_location	Der ungefähre Standort des Nutzers für die Suchrelevanz.

Details zur Eigenschaft

custom_search_configuration

Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindungsressource an das Tool angefügt sein.

custom_search_configuration?: WebSearchConfiguration

Eigenschaftswert

WebSearchConfiguration

description

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.

description?: string

Eigenschaftswert

string

external_web_access

Erlauben Sie Live-Internetzugang für die Websuche. Standardmäßig wird true angezeigt, wenn es weggelassen wird. Wenn falsch, läuft das Websuchtool im Offline-/Cache-Only-Modus und ruft keine neuen externen Inhalte ab.

external_web_access?: boolean

Eigenschaftswert

boolean

filters

Filter, die auf Websuchergebnisse angewendet werden.

filters?: WebSearchToolFilters

Eigenschaftswert

WebSearchToolFilters

name

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.

name?: string

Eigenschaftswert

string

search_context_size

Allgemeine Richtlinie für die Menge des Kontextfensterbereichs, der für die Suche verwendet werden soll. Einer der folgenden Werte: low, medium oder high. medium ist die Standardoption.

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

Eigenschaftswert

"low" | "medium" | "high"

tool_configs

Deprecated. Diese Eigenschaft ist veraltet und wird in einer zukünftigen Version entfernt.

tool_configs?: Record<string, ToolConfig>

Eigenschaftswert

Record<string, ToolConfig>

type

Der Typ des Websuchtools. Einer der folgenden Werte: web_search oder web_search_2025_08_26.

type: "web_search"

Eigenschaftswert

"web_search"

user_location

Der ungefähre Standort des Nutzers für die Suchrelevanz.

user_location?: WebSearchApproximateLocation

Eigenschaftswert

WebSearchApproximateLocation