Package com.azure.ai.openai.responses.models

Class ResponsesComputerCallItem

java.lang.Object

com.azure.ai.openai.responses.models.ResponsesItem

com.azure.ai.openai.responses.models.ResponsesComputerCallItem

All Implemented Interfaces:

com.azure.json.JsonSerializable<ResponsesItem>

public final class ResponsesComputerCallItem
extends ResponsesItem

A tool call to a computer use tool. See the [computer use guide](/docs/guides/tools-computer-use) for more information.

Constructor Summary

Constructors

Constructor	Description
ResponsesComputerCallItem(String callId, ResponsesComputerCallItemAction action, List<ResponsesComputerCallItemSafetyCheck> pendingSafetyChecks)	Creates an instance of ResponsesComputerCallItem class.

Method Summary

Modifier and Type	Method	Description
static ResponsesComputerCallItem	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ResponsesComputerCallItem from the JsonReader.
ResponsesComputerCallItemAction	getAction()	Get the action property: The action property.
String	getCallId()	Get the callId property: An identifier used when responding to the tool call with output.
List<ResponsesComputerCallItemSafetyCheck>	getPendingSafetyChecks()	Get the pendingSafetyChecks property: The pending safety checks for the computer call.
ResponsesComputerCallItemStatus	getStatus()	Get the status property: The status of the item.
ResponsesItemType	getType()	Get the type property: The type property.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class com.azure.ai.openai.responses.models.ResponsesItem

getId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

ResponsesComputerCallItem

public ResponsesComputerCallItem(String callId,
 ResponsesComputerCallItemAction action,
 List<ResponsesComputerCallItemSafetyCheck> pendingSafetyChecks)

Creates an instance of ResponsesComputerCallItem class.

Parameters:

callId - the callId value to set.

action - the action value to set.

pendingSafetyChecks - the pendingSafetyChecks value to set.

Method Details

getType

public ResponsesItemType getType()

Get the type property: The type property.

Overrides:

getType in class ResponsesItem

Returns:

the type value.

getCallId

public String getCallId()

Get the callId property: An identifier used when responding to the tool call with output.

Returns:

the callId value.

getAction

public ResponsesComputerCallItemAction getAction()

Get the action property: The action property.

Returns:

the action value.

getPendingSafetyChecks

public List<ResponsesComputerCallItemSafetyCheck> getPendingSafetyChecks()

Get the pendingSafetyChecks property: The pending safety checks for the computer call.

Returns:

the pendingSafetyChecks value.

getStatus

public ResponsesComputerCallItemStatus getStatus()

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

Returns:

the status value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ResponsesItem>

Overrides:

toJson in class ResponsesItem

Throws:

IOException

fromJson

public static ResponsesComputerCallItem fromJson(com.azure.json.JsonReader jsonReader)
                                          throws IOException

Reads an instance of ResponsesComputerCallItem from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ResponsesComputerCallItem if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the ResponsesComputerCallItem.