FileSearchToolboxTool interface

パッケージ:

@azure/ai-projects

ツールボックスに保存されたファイル検索ツール。

Extends

ToolboxTool

プロパティ

filters	検索に含まれるファイルを制限するフィルター。
max_num_results	返される結果の最大数。 この数値は、1 ~ 50 の範囲にする必要があります。
ranking_options	検索のランク付けオプション。
type	ファイル検索ツールボックスツールの種類。 常に file_search です。
vector_store_ids	検索するベクトルストアの ID。

継承されたプロパティ

description	このツールや設定のオプションでユーザー定義の説明があります。
name	このツールまたは設定にはオプションでユーザー定義の名称を付けることができます。
tool_configs	ツールごとの設定マップ。 キーは工具名または * (万能のデフォルト)です。 解決順:正確なツール名の一致が *より優先されます。 未知のツール名は実行時に静かに無視されます。

プロパティの詳細

filters

検索に含まれるファイルを制限するフィルター。

filters?: Filters

プロパティ値

Filters

max_num_results

返される結果の最大数。 この数値は、1 ~ 50 の範囲にする必要があります。

max_num_results?: number

プロパティ値

number

ranking_options

検索のランク付けオプション。

ranking_options?: RankingOptions

プロパティ値

RankingOptions

type

ファイル検索ツールボックスツールの種類。 常に file_search です。

type: "file_search"

プロパティ値

"file_search"

vector_store_ids

検索するベクトルストアの ID。

vector_store_ids?: string[]

プロパティ値

string[]

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

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から受け継いだ