Package com.azure.ai.openai.models

Class ChatCompletionsFunctionToolDefinition

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsToolDefinition

com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinition

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsToolDefinition>

public final class ChatCompletionsFunctionToolDefinition
extends ChatCompletionsToolDefinition

The definition information for a chat completions function tool that can call a function in response to a tool call.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsFunctionToolDefinition(ChatCompletionsFunctionToolDefinitionFunction function)	Creates an instance of ChatCompletionsFunctionToolDefinition class.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsFunctionToolDefinition	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatCompletionsFunctionToolDefinition from the JsonReader.
ChatCompletionsFunctionToolDefinitionFunction	getFunction()	Get the function property: The function definition details for the function tool.
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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

ChatCompletionsFunctionToolDefinition

public ChatCompletionsFunctionToolDefinition(ChatCompletionsFunctionToolDefinitionFunction function)

Creates an instance of ChatCompletionsFunctionToolDefinition class.

Parameters:

function - the function value to set.

Method Details

getFunction

public ChatCompletionsFunctionToolDefinitionFunction getFunction()

Get the function property: The function definition details for the function tool.

Returns:

the function value.

getType

public String getType()

Get the type property: The object type.

Overrides:

getType in class ChatCompletionsToolDefinition

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

Overrides:

toJson in class ChatCompletionsToolDefinition

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsFunctionToolDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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