Share via


ToolChoiceObject Class

Definition

The ToolChoiceObject. Please note ToolChoiceObject is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ToolChoiceObjectCodeInterpreter, ToolChoiceObjectComputer, ToolChoiceObjectFileSearch, ToolChoiceObjectFunction, ToolChoiceObjectImageGen, ToolChoiceObjectMCP and ToolChoiceObjectWebSearch.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.OpenAI.UnknownToolChoiceObject))]
public abstract class ToolChoiceObject : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ToolChoiceObject>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ToolChoiceObject>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.OpenAI.UnknownToolChoiceObject))>]
type ToolChoiceObject = class
    interface IUtf8JsonSerializable
    interface IJsonModel<ToolChoiceObject>
    interface IPersistableModel<ToolChoiceObject>
Public MustInherit Class ToolChoiceObject
Implements IJsonModel(Of ToolChoiceObject), IPersistableModel(Of ToolChoiceObject), IUtf8JsonSerializable
Inheritance
ToolChoiceObject
Derived
Attributes
Implements

Constructors

Name Description
ToolChoiceObject()

Initializes a new instance of ToolChoiceObject.

ToolChoiceObject(ToolChoiceObjectType, IDictionary<String,BinaryData>)

Initializes a new instance of ToolChoiceObject.

Properties

Name Description
Type

Gets or sets the type.

Methods

Name Description
DeserializeToolChoiceObject(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<ToolChoiceObject>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ToolChoiceObject>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ToolChoiceObject>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ToolChoiceObject>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ToolChoiceObject>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to