Share via

FunctionToolCallItemParam Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.OpenAI
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
FunctionToolCallItemParam.cs

A tool call to run a function. See the function calling guide for more information.

public class FunctionToolCallItemParam : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemParam, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.FunctionToolCallItemParam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.FunctionToolCallItemParam>
type FunctionToolCallItemParam = class
    inherit ItemParam
    interface IUtf8JsonSerializable
    interface IJsonModel<FunctionToolCallItemParam>
    interface IPersistableModel<FunctionToolCallItemParam>
Public Class FunctionToolCallItemParam
Inherits ItemParam
Implements IJsonModel(Of FunctionToolCallItemParam), IPersistableModel(Of FunctionToolCallItemParam)
Inheritance
Object
ItemParam
FunctionToolCallItemParam
Implements
IUtf8JsonSerializable IJsonModel<FunctionToolCallItemParam> IPersistableModel<FunctionToolCallItemParam> IPersistableModel<T>

Constructors

Name Description
FunctionToolCallItemParam()

Initializes a new instance of FunctionToolCallItemParam for deserialization.
FunctionToolCallItemParam(ItemType, IDictionary<String,BinaryData>, String, String, String)

Initializes a new instance of FunctionToolCallItemParam.
FunctionToolCallItemParam(String, String, String)

Initializes a new instance of FunctionToolCallItemParam.

Properties

Name Description
Arguments

A JSON string of the arguments to pass to the function.
CallId

The unique ID of the function tool call generated by the model.
Name

The name of the function to run.
SerializedAdditionalRawData (Inherited from ItemParam)
Type

Gets or sets the type.

(Inherited from ItemParam)

Methods

Name Description
DeserializeFunctionToolCallItemParam(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<FunctionToolCallItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<FunctionToolCallItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IJsonModel<ItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

(Inherited from ItemParam)
IJsonModel<ItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemParam)
IPersistableModel<FunctionToolCallItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<FunctionToolCallItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<FunctionToolCallItemParam>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IPersistableModel<ItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ItemParam)
IPersistableModel<ItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from ItemParam)
IPersistableModel<ItemParam>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ItemParam)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to