AzureAISearchToolboxTool interface

Package:: @azure/ai-projects

An Azure AI Search tool stored in a toolbox.

Extends: ToolboxTool

Properties

azure_ai_search	The azure ai search index resource.
type	The type of the Azure AI Search toolbox tool. Always `azure_ai_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

azure_ai_search

The azure ai search index resource.

azure_ai_search: AzureAISearchToolResource

Property Value

AzureAISearchToolResource

type

The type of the Azure AI Search toolbox tool. Always azure_ai_search.

type: "azure_ai_search"

Property Value

"azure_ai_search"

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