Package com.azure.ai.openai.assistants.models

Class RunStepDeltaFunctionToolCall

java.lang.Object

com.azure.ai.openai.assistants.models.RunStepDeltaToolCall

com.azure.ai.openai.assistants.models.RunStepDeltaFunctionToolCall

All Implemented Interfaces:

com.azure.json.JsonSerializable<RunStepDeltaToolCall>

public final class RunStepDeltaFunctionToolCall
extends RunStepDeltaToolCall

Represents a function tool call within a streaming run step's tool call details.

Method Summary

Modifier and Type	Method	Description
static RunStepDeltaFunctionToolCall	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of RunStepDeltaFunctionToolCall from the JsonReader.
RunStepDeltaFunction	getFunction()	Get the function property: The function data for the tool call.
String	getType()	Get the type property: The type of the tool call detail item in a streaming run step's details.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class com.azure.ai.openai.assistants.models.RunStepDeltaToolCall

getId, getIndex

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

Method Details

getType

public String getType()

Get the type property: The type of the tool call detail item in a streaming run step's details.

Overrides:

getType in class RunStepDeltaToolCall

Returns:

the type value.

getFunction

public RunStepDeltaFunction getFunction()

Get the function property: The function data for the tool call.

Returns:

the function value.

toJson

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

Specified by:

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

Overrides:

toJson in class RunStepDeltaToolCall

Throws:

IOException

fromJson

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

Reads an instance of RunStepDeltaFunctionToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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