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

Class RequiredFunctionToolCall

java.lang.Object

com.azure.ai.openai.assistants.models.RequiredToolCall

com.azure.ai.openai.assistants.models.RequiredFunctionToolCall

All Implemented Interfaces:

com.azure.json.JsonSerializable<RequiredToolCall>

public final class RequiredFunctionToolCall
extends RequiredToolCall

A representation of a requested call to a function tool, needed by the model to continue evaluation of a run.

Method Summary

Modifier and Type	Method	Description
static RequiredFunctionToolCall	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of RequiredFunctionToolCall from the JsonReader.
RequiredFunctionToolCallDetails	getFunction()	Get the function property: Detailed information about the function to be executed by the tool that includes name and arguments.
String	getType()	Get the type property: The object type for the required tool call.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

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

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

Method Details

getFunction

public RequiredFunctionToolCallDetails getFunction()

Get the function property: Detailed information about the function to be executed by the tool that includes name and arguments.

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

Overrides:

toJson in class RequiredToolCall

Throws:

IOException

fromJson

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

Reads an instance of RequiredFunctionToolCall from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getType

public String getType()

Get the type property: The object type for the required tool call.

Overrides:

getType in class RequiredToolCall

Returns:

the type value.