Package com.azure.ai.openai.models

Class ChatCompletionsToolCall

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsToolCall

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsToolCall>

Direct Known Subclasses:

ChatCompletionsFunctionToolCall

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

An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested chat completion.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsToolCall(String id)	Creates an instance of ChatCompletionsToolCall class.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsToolCall	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatCompletionsToolCall from the JsonReader.
String	getId()	Get the id property: The ID of the tool call.
String	getType()	Get the type property: The object type.
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

Constructor Details

ChatCompletionsToolCall

public ChatCompletionsToolCall(String id)

Creates an instance of ChatCompletionsToolCall class.

Parameters:

id - the id value to set.

Method Details

getId

public String getId()

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

Returns:

the id value.

getType

public String getType()

Get the type property: The object type.

Returns:

the type value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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