OpenApiToolboxTool interface

Package:: @azure/ai-projects

An OpenAPI tool stored in a toolbox.

Extends: ToolboxTool

Properties

openapi	The openapi function definition.
type	The type of the OpenAPI toolbox tool. Always `openapi`.

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

openapi

The openapi function definition.

openapi: OpenApiFunctionDefinition

Property Value

OpenApiFunctionDefinition

type

The type of the OpenAPI toolbox tool. Always openapi.

type: "openapi"

Property Value

"openapi"

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