FileSearchToolboxTool interface

Package:

@azure/ai-projects

A file search tool stored in a toolbox.

Extends

ToolboxTool

Properties

filters
max_num_results	The maximum number of results to return. This number should be between 1 and 50 inclusive.
ranking_options	Ranking options for search.
type	The discriminator possible values: code_interpreter, file_search, web_search, mcp, azure_ai_search, openapi, a2a_preview, browser_automation_preview, reminder_preview, work_iq_preview, fabric_iq_preview, toolbox_search_preview
vector_store_ids	The IDs of the vector stores to search.

Inherited Properties

description	Optional user-defined description for this tool or configuration.
name	Optional user-defined name for this tool or configuration.
tool_configs	Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

Property Details

filters

filters?: Filters

Property Value

Filters

max_num_results

The maximum number of results to return. This number should be between 1 and 50 inclusive.

max_num_results?: number

Property Value

number

ranking_options

Ranking options for search.

ranking_options?: RankingOptions

Property Value

RankingOptions

type

The discriminator possible values: code_interpreter, file_search, web_search, mcp, azure_ai_search, openapi, a2a_preview, browser_automation_preview, reminder_preview, work_iq_preview, fabric_iq_preview, toolbox_search_preview

type: "file_search"

Property Value

"file_search"

vector_store_ids

The IDs of the vector stores to search.

vector_store_ids?: string[]

Property Value

string[]

Inherited Property Details

description

Optional user-defined description for this tool or configuration.

description?: string

Property Value

string

Inherited From ToolboxTool.description

name

Optional user-defined name for this tool or configuration.

name?: string

Property Value

string

Inherited From ToolboxTool.name

tool_configs

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

tool_configs?: Record<string, ToolConfig>

Property Value

Record<string, ToolConfig>

Inherited From ToolboxTool.tool_configs