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

Class ResponsesFunctionCallItem

java.lang.Object

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

com.azure.ai.openai.responses.models.ResponsesFunctionCallItem

All Implemented Interfaces:

com.azure.json.JsonSerializable<ResponsesItem>

public final class ResponsesFunctionCallItem
extends ResponsesItem

The ResponsesFunctionCallItem model.

Constructor Summary

Constructors

Constructor	Description
ResponsesFunctionCallItem(String callId, String name, String arguments)	Creates an instance of ResponsesFunctionCallItem class.

Method Summary

Modifier and Type	Method	Description
static ResponsesFunctionCallItem	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ResponsesFunctionCallItem from the JsonReader.
String	getArguments()	Get the arguments property: The arguments property.
String	getCallId()	Get the callId property: The call_id property.
String	getName()	Get the name property: The name property.
ResponsesFunctionCallItemStatus	getStatus()	Get the status property: The status property.
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

ResponsesFunctionCallItem

public ResponsesFunctionCallItem(String callId,
 String name,
 String arguments)

Creates an instance of ResponsesFunctionCallItem class.

Parameters:

callId - the callId value to set.

name - the name value to set.

arguments - the arguments 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.

getStatus

public ResponsesFunctionCallItemStatus getStatus()

Get the status property: The status property.

Returns:

the status value.

getCallId

public String getCallId()

Get the callId property: The call_id property.

Returns:

the callId value.

getName

public String getName()

Get the name property: The name property.

Returns:

the name value.

getArguments

public String getArguments()

Get the arguments property: The arguments property.

Returns:

the arguments 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 ResponsesFunctionCallItem fromJson(com.azure.json.JsonReader jsonReader)
                                          throws IOException

Reads an instance of ResponsesFunctionCallItem from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ResponsesFunctionCallItem 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 ResponsesFunctionCallItem.