Package com.azure.ai.inference.models

Class ChatCompletionsNamedToolChoice

java.lang.Object

com.azure.ai.inference.models.ChatCompletionsNamedToolChoice

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsNamedToolChoice>

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

A tool selection of a specific, named function tool that will limit chat completions to using the named function.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsNamedToolChoice(ChatCompletionsNamedToolChoiceFunction function)	Creates an instance of ChatCompletionsNamedToolChoice class.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsNamedToolChoice	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatCompletionsNamedToolChoice from the JsonReader.
ChatCompletionsNamedToolChoiceFunction	getFunction()	Get the function property: The function that should be called.
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

ChatCompletionsNamedToolChoice

public ChatCompletionsNamedToolChoice(ChatCompletionsNamedToolChoiceFunction function)

Creates an instance of ChatCompletionsNamedToolChoice 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 ChatCompletionsNamedToolChoiceFunction getFunction()

Get the function property: The function that should be called.

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

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsNamedToolChoice from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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