Share via


ComputerToolCallOutputItemParam Class

Definition

The output of a computer tool call.

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

Constructors

Name Description
ComputerToolCallOutputItemParam()

Initializes a new instance of ComputerToolCallOutputItemParam for deserialization.

ComputerToolCallOutputItemParam(ItemType, IDictionary<String, BinaryData>, String, IList<ComputerToolCallSafetyCheck>, ComputerToolCallOutputItemOutput)

Initializes a new instance of ComputerToolCallOutputItemParam.

ComputerToolCallOutputItemParam(String, ComputerToolCallOutputItemOutput)

Initializes a new instance of ComputerToolCallOutputItemParam.

Properties

Name Description
AcknowledgedSafetyChecks

The safety checks reported by the API that have been acknowledged by the developer.

CallId

The ID of the computer tool call that produced the output.

Output

Gets or sets the output Please note ComputerToolCallOutputItemOutput 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 ComputerToolCallOutputItemOutputComputerScreenshot.

SerializedAdditionalRawData (Inherited from ItemParam)
Type

Gets or sets the type.

(Inherited from ItemParam)

Methods

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

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

IJsonModel<ComputerToolCallOutputItemParam>.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<ComputerToolCallOutputItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ComputerToolCallOutputItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ComputerToolCallOutputItemParam>.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