Package com.azure.ai.openai.models

Class ChatCompletionsNamedFunctionToolSelection

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsNamedToolSelection

com.azure.ai.openai.models.ChatCompletionsNamedFunctionToolSelection

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsNamedToolSelection>

public final class ChatCompletionsNamedFunctionToolSelection
extends ChatCompletionsNamedToolSelection

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

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsNamedFunctionToolSelection(ChatCompletionsFunctionToolSelection function)	Creates an instance of ChatCompletionsNamedFunctionToolSelection class.

Method Summary

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

ChatCompletionsNamedFunctionToolSelection

public ChatCompletionsNamedFunctionToolSelection(ChatCompletionsFunctionToolSelection function)

Creates an instance of ChatCompletionsNamedFunctionToolSelection class.

Parameters:

function - the function value to set.

Method Details

getFunction

public ChatCompletionsFunctionToolSelection getFunction()

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

Returns:

the function value.

getType

public String getType()

Get the type property: The object type.

Overrides:

getType in class ChatCompletionsNamedToolSelection

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

Overrides:

toJson in class ChatCompletionsNamedToolSelection

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsNamedFunctionToolSelection from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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