WebSearchToolboxTool interface

ツールボックスに保存されたウェブ検索ツール。

Extends

プロパティ

custom_search_configuration

このツールに接続されているproject接続。 このツールには最大 1 つの接続リソースをアタッチできます。

external_web_access

ウェブ検索のためにライブインターネットアクセスを許可してください。 省略するとデフォルトでtrueになります。 誤りの場合、ウェブ検索ツールはオフライン/キャッシュ専用モードで動作し、新しい外部コンテンツを取得しません。

filters

ウェブ検索結果を許可されたドメインに限定するフィルター。

search_context_size

検索に使用するコンテキスト ウィンドウ領域の量に関する概要ガイダンス。 low、medium、またはhighのいずれか。 medium はデフォルト値です。

type

ツールボックスの工具タイプ。 ウェブ検索ツールは常に web_search しましょう。

user_location

ユーザーのおおよその位置情報は、ウェブ検索結果の関連性を高めるために使われます。

継承されたプロパティ

description

このツールや設定のオプションでユーザー定義の説明があります。

name

このツールまたは設定にはオプションでユーザー定義の名称を付けることができます。

tool_configs

ツールごとの設定マップ。 キーは工具名または * (万能のデフォルト)です。 解決順:正確なツール名の一致が *より優先されます。 未知のツール名は実行時に静かに無視されます。

プロパティの詳細

custom_search_configuration

このツールに接続されているproject接続。 このツールには最大 1 つの接続リソースをアタッチできます。

custom_search_configuration?: WebSearchConfiguration

プロパティ値

external_web_access

ウェブ検索のためにライブインターネットアクセスを許可してください。 省略するとデフォルトでtrueになります。 誤りの場合、ウェブ検索ツールはオフライン/キャッシュ専用モードで動作し、新しい外部コンテンツを取得しません。

external_web_access?: boolean

プロパティ値

boolean

filters

ウェブ検索結果を許可されたドメインに限定するフィルター。

filters?: WebSearchToolFilters

プロパティ値

search_context_size

検索に使用するコンテキスト ウィンドウ領域の量に関する概要ガイダンス。 low、medium、またはhighのいずれか。 medium はデフォルト値です。

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

プロパティ値

"low" | "medium" | "high"

type

ツールボックスの工具タイプ。 ウェブ検索ツールは常に web_search しましょう。

type: "web_search"

プロパティ値

"web_search"

user_location

ユーザーのおおよその位置情報は、ウェブ検索結果の関連性を高めるために使われます。

user_location?: WebSearchApproximateLocation

プロパティ値

継承されたプロパティの詳細

description

このツールや設定のオプションでユーザー定義の説明があります。

description?: string

プロパティ値

string

ToolboxTool.descriptionから引き継がれました

name

このツールまたは設定にはオプションでユーザー定義の名称を付けることができます。

name?: string

プロパティ値

string

ToolboxTool.nameから受け継いだ

tool_configs

ツールごとの設定マップ。 キーは工具名または * (万能のデフォルト)です。 解決順:正確なツール名の一致が *より優先されます。 未知のツール名は実行時に静かに無視されます。

tool_configs?: Record<string, ToolConfig>

プロパティ値

Record<string, ToolConfig>

ToolboxTool.tool_configsから受け継いだ