VoiceAgentDefinition.ToolChoice Property

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v3.0.0-beta.3

Source:

VoiceAgentDefinition.cs

How the model chooses tools for generated responses. none prevents tool calls, auto lets the model decide, required requires at least one tool call, and a specific function or MCP tool can be selected with an object. Defaults to auto.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

• "none".
• "auto".
• "required".
• OpenAI.Realtime.RealtimeCustomFunctionToolChoice.
• OpenAI.Realtime.RealtimeCustomMcpToolChoice.

</remarks>

Examples:

• BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
• BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
• BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
• BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

public BinaryData ToolChoice { get; set; }

member this.ToolChoice : BinaryData with get, set

Public Property ToolChoice As BinaryData

Property Value

BinaryData