Package com.azure.ai.inference.models

Class StreamingChatResponseToolCallUpdate

java.lang.Object

com.azure.ai.inference.models.StreamingChatResponseToolCallUpdate

All Implemented Interfaces:

com.azure.json.JsonSerializable<StreamingChatResponseToolCallUpdate>

public final class StreamingChatResponseToolCallUpdate
extends Object
implements com.azure.json.JsonSerializable<StreamingChatResponseToolCallUpdate>

An update to the function tool call information requested by the AI model.

Method Summary

Modifier and Type	Method	Description
static StreamingChatResponseToolCallUpdate	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of StreamingChatResponseToolCallUpdate from the JsonReader.
FunctionCall	getFunction()	Get the function property: Updates to the function call requested by the AI model.
String	getId()	Get the id property: The ID of the tool call.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

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

getId

public String getId()

Get the id property: The ID of the tool call.

Returns:

the id value.

getFunction

public FunctionCall getFunction()

Get the function property: Updates to the function call requested by the AI model.

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<StreamingChatResponseToolCallUpdate>

Throws:

IOException

fromJson

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

Reads an instance of StreamingChatResponseToolCallUpdate from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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