Package com.azure.ai.inference.models

Class ChatCompletionsToolDefinition

java.lang.Object

com.azure.ai.inference.models.ChatCompletionsToolDefinition

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsToolDefinition>

Direct Known Subclasses:

ChatCompletionsFunctionToolDefinition

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

The definition of a chat completions tool that can call a function.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsToolDefinition(FunctionDefinition function)	Creates an instance of ChatCompletionsToolDefinition class.

Method Summary

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

ChatCompletionsToolDefinition

public ChatCompletionsToolDefinition(FunctionDefinition function)

Creates an instance of ChatCompletionsToolDefinition class.

Parameters:

function - the function value to set.

Method Details

getType

public String getType()

Get the type property: The type of the tool. Currently, only `function` is supported.

Returns:

the type value.

getFunction

public FunctionDefinition getFunction()

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

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

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsToolDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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