WebSearchTool interface

套件:

@azure/ai-projects

在網路上搜尋與該題目的相關來源。 了解更多關於 web 搜尋工具。

Extends

Tool

屬性

custom_search_configuration	這個工具上的 project 連結。 最多可以有 1 個連結至工具的連接資源。
description	Deprecated. 此屬性已廢止，未來版本將被移除。
filters	篩選器可套用於網路搜尋結果。
name	Deprecated. 此屬性已廢止，未來版本將被移除。
search_context_size	用於搜尋的內容窗口空間量高階指引。 low、medium 或 high 的其中之一。 medium 是預設值。
tool_configs	Deprecated. 此屬性已廢止，未來版本將被移除。
type	Web 搜尋工具的類型。 web_search 或 web_search_2025_08_26 的其中之一。
user_location	使用者的大致位置，以供搜尋相關性。

屬性詳細資料

custom_search_configuration

這個工具上的 project 連結。 最多可以有 1 個連結至工具的連接資源。

custom_search_configuration?: WebSearchConfiguration

屬性值

WebSearchConfiguration

description

Deprecated. 此屬性已廢止，未來版本將被移除。

description?: string

屬性值

string

filters

篩選器可套用於網路搜尋結果。

filters?: WebSearchToolFilters

屬性值

WebSearchToolFilters

name

Deprecated. 此屬性已廢止，未來版本將被移除。

name?: string

屬性值

string

search_context_size

用於搜尋的內容窗口空間量高階指引。 low、medium 或 high 的其中之一。 medium 是預設值。

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

屬性值

"low" | "medium" | "high"

tool_configs

Deprecated. 此屬性已廢止，未來版本將被移除。

tool_configs?: Record<string, ToolConfig>

屬性值

Record<string, ToolConfig>

type

Web 搜尋工具的類型。 web_search 或 web_search_2025_08_26 的其中之一。

type: "web_search"

屬性值

"web_search"

user_location

使用者的大致位置，以供搜尋相關性。

user_location?: WebSearchApproximateLocation

屬性值

WebSearchApproximateLocation