ResponseExtensions.GetToolChoiceExpanded(ResponseObject) Method

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.3
Source:
ResponseExtensions.cs

Expands the ToolChoice BinaryData into a typed ToolChoiceParam. String shorthands ("auto", "required") are expanded to ToolChoiceAllowed with the corresponding mode. "none" returns null.

public static Azure.AI.AgentServer.Responses.Models.ToolChoiceParam? GetToolChoiceExpanded(this Azure.AI.AgentServer.Responses.Models.ResponseObject response);
static member GetToolChoiceExpanded : Azure.AI.AgentServer.Responses.Models.ResponseObject -> Azure.AI.AgentServer.Responses.Models.ToolChoiceParam
<Extension()>
Public Function GetToolChoiceExpanded (response As ResponseObject) As ToolChoiceParam

Parameters

response
ResponseObject

The response.

Returns

ToolChoiceParam

The typed tool choice, or null if the tool choice is "none" or unset.

Exceptions

ArgumentNullException

response is null.

FormatException

The ToolChoice BinaryData contains an unrecognized value.

Applies to