OutputItemComputerToolCall Class

Definition

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

Computer tool call.

public class OutputItemComputerToolCall : Azure.AI.AgentServer.Responses.Models.OutputItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.OutputItemComputerToolCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.OutputItemComputerToolCall>
type OutputItemComputerToolCall = class
    inherit OutputItem
    interface IJsonModel<OutputItemComputerToolCall>
    interface IPersistableModel<OutputItemComputerToolCall>
Public Class OutputItemComputerToolCall
Inherits OutputItem
Implements IJsonModel(Of OutputItemComputerToolCall), IPersistableModel(Of OutputItemComputerToolCall)
Inheritance
Object
OutputItem
OutputItemComputerToolCall
Implements
IJsonModel<OutputItemComputerToolCall> IPersistableModel<OutputItemComputerToolCall> IPersistableModel<T>

Constructors

Name Description
OutputItemComputerToolCall(String, String, ComputerAction, IEnumerable<ComputerCallSafetyCheckParam>, OutputItemComputerToolCallStatus)

Initializes a new instance of OutputItemComputerToolCall.

Properties

Name Description
Action

Gets or sets the Action.
AgentReference

The agent that created the item.

(Inherited from OutputItem)
CallId

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

The information about the creator of the item

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

(Inherited from OutputItem)
Id

The unique ID of the computer call.
PendingSafetyChecks

The pending safety checks for the computer call.
ResponseId

The response on which the item is created.

(Inherited from OutputItem)
Status

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

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<OutputItem>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from OutputItem)
IJsonModel<OutputItemComputerToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItemComputerToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<OutputItem>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItem>.Write(ModelReaderWriterOptions) (Inherited from OutputItem)
IPersistableModel<OutputItemComputerToolCall>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItemComputerToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItemComputerToolCall>.Write(ModelReaderWriterOptions)

Extension Methods

Name Description
GetId(OutputItem)

Gets the Id property from an OutputItem. Uses direct type checks for known subclasses; falls back to JSON serialization for unrecognized types.

Applies to