ProjectsAgentsModelFactory.OpenApiToolboxTool Method

Definition

An OpenAPI tool stored in a toolbox.

public static Azure.AI.Projects.Agents.OpenApiToolboxTool OpenApiToolboxTool(string name = default, string description = default, System.Collections.Generic.IDictionary<string,Azure.AI.Projects.Agents.ToolConfig> toolConfigs = default, Azure.AI.Projects.Agents.OpenApiFunctionDefinition functionDefinition = default);
static member OpenApiToolboxTool : string * string * System.Collections.Generic.IDictionary<string, Azure.AI.Projects.Agents.ToolConfig> * Azure.AI.Projects.Agents.OpenApiFunctionDefinition -> Azure.AI.Projects.Agents.OpenApiToolboxTool
Public Shared Function OpenApiToolboxTool (Optional name As String = Nothing, Optional description As String = Nothing, Optional toolConfigs As IDictionary(Of String, ToolConfig) = Nothing, Optional functionDefinition As OpenApiFunctionDefinition = Nothing) As OpenApiToolboxTool

Parameters

name
String

Optional user-defined name for this tool or configuration.

description
String

Optional user-defined description for this tool or configuration.

toolConfigs
IDictionary<String,ToolConfig>

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.

functionDefinition
OpenApiFunctionDefinition

The openapi function definition.

Returns

A new OpenApiToolboxTool instance for mocking.

Applies to