Share via


ComputerToolCallItemResource Class

Definition

A tool call to a computer use tool. See the computer use guide for more information.

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

Constructors

Name Description
ComputerToolCallItemResource()

Initializes a new instance of ComputerToolCallItemResource for deserialization.

ComputerToolCallItemResource(ItemType, String, CreatedBy, IDictionary<String, BinaryData>, ComputerToolCallItemResourceStatus, String, ComputerAction, IReadOnlyList<ComputerToolCallSafetyCheck>)

Initializes a new instance of ComputerToolCallItemResource.

ComputerToolCallItemResource(String, ComputerToolCallItemResourceStatus, String, ComputerAction, IEnumerable<ComputerToolCallSafetyCheck>)

Initializes a new instance of ComputerToolCallItemResource.

Properties

Name Description
Action

Gets the action Please note ComputerAction 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 ComputerActionClick, ComputerActionDoubleClick, ComputerActionDrag, ComputerActionKeyPress, ComputerActionMove, ComputerActionScreenshot, ComputerActionScroll, ComputerActionTypeKeys and ComputerActionWait.

CallId

An identifier used when responding to the tool call with output.

CreatedBy

The information about the creator of the item.

(Inherited from ItemResource)
Id

Gets the id.

(Inherited from ItemResource)
PendingSafetyChecks

The pending safety checks for the computer call.

Status

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Type

Gets or sets the type.

(Inherited from ItemResource)

Methods

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

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

IJsonModel<ComputerToolCallItemResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<ItemResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemResource)
IPersistableModel<ComputerToolCallItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ComputerToolCallItemResource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ComputerToolCallItemResource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<ItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from ItemResource)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to