Package com.azure.ai.openai.models

Class ChatCompletionsFunctionToolSelection

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsFunctionToolSelection

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsFunctionToolSelection>

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

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

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsFunctionToolSelection(String name)	Creates an instance of ChatCompletionsFunctionToolSelection class.

Method Summary

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

ChatCompletionsFunctionToolSelection

public ChatCompletionsFunctionToolSelection(String name)

Creates an instance of ChatCompletionsFunctionToolSelection class.

Parameters:

name - the name value to set.

Method Details

getName

public String getName()

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

Returns:

the name value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ChatCompletionsFunctionToolSelection>

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsFunctionToolSelection from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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