ProjectsAgentsModelFactory.CaptureStructuredOutputsTool Method

Definition

A tool for capturing structured outputs.

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

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.

outputDefinition
StructuredOutputDefinition

The structured outputs to capture from the model.

Returns

A new CaptureStructuredOutputsTool instance for mocking.

Applies to