WebSearchToolboxTool interface

Paket:

@azure/ai-projects

Ein Web-Suchwerkzeug, das in einem Werkzeugkasten gespeichert ist.

Extends

ToolboxTool

Eigenschaften

custom_search_configuration	Die an dieses Tool angefügten project Verbindungen. Es kann maximal 1 Verbindungsressource an das Tool angefügt sein.
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 Websuchergebnisse auf erlaubte Domains beschränken.
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 der Standardwert.
type	Der Werkzeugkasten-Werkzeugtyp. Immer web_search für ein Web-Suchwerkzeug.
user_location	Der ungefähre Standort des Nutzers wird verwendet, um die Relevanz der Websuchergebnisse zu verbessern.

Geerbte Eigenschaften

description	Optionale, benutzerdefinierte Beschreibung für dieses Werkzeug oder diese Konfiguration.
name	Optionaler benutzerdefinierter Name für dieses Werkzeug oder diese Konfiguration.
tool_configs	Konfigurationskarte pro Werkzeug. Schlüssel sind Werkzeugnamen oder * (Standard-Sammelbegriff). Auflösungsreihenfolge: Der exakte Werkzeugname-Treffer hat Vorrang vor *. Unbekannte Werkzeugnamen werden zur Laufzeit stillschweigend ignoriert.

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

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 Websuchergebnisse auf erlaubte Domains beschränken.

filters?: WebSearchToolFilters

Eigenschaftswert

WebSearchToolFilters

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 der Standardwert.

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

Eigenschaftswert

"low" | "medium" | "high"

type

Der Werkzeugkasten-Werkzeugtyp. Immer web_search für ein Web-Suchwerkzeug.

type: "web_search"

Eigenschaftswert

"web_search"

user_location

Der ungefähre Standort des Nutzers wird verwendet, um die Relevanz der Websuchergebnisse zu verbessern.

user_location?: WebSearchApproximateLocation

Eigenschaftswert

WebSearchApproximateLocation

Geerbte Eigenschaftsdetails

description

Optionale, benutzerdefinierte Beschreibung für dieses Werkzeug oder diese Konfiguration.

description?: string

Eigenschaftswert

string

Geerbt vonToolboxTool.description

name

Optionaler benutzerdefinierter Name für dieses Werkzeug oder diese Konfiguration.

name?: string

Eigenschaftswert

string

Geerbt vonToolboxTool.name

tool_configs

Konfigurationskarte pro Werkzeug. Schlüssel sind Werkzeugnamen oder * (Standard-Sammelbegriff). Auflösungsreihenfolge: Der exakte Werkzeugname-Treffer hat Vorrang vor *. Unbekannte Werkzeugnamen werden zur Laufzeit stillschweigend ignoriert.

tool_configs?: Record<string, ToolConfig>

Eigenschaftswert

Record<string, ToolConfig>

Geerbt vonToolboxTool.tool_configs