Package com.azure.ai.openai.models

Class ChatCompletionsNamedToolSelection

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsNamedToolSelection

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsNamedToolSelection>

Direct Known Subclasses:

ChatCompletionsNamedFunctionToolSelection

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

An abstract representation of an explicit, named tool selection to use for a chat completions request.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsNamedToolSelection()	Creates an instance of ChatCompletionsNamedToolSelection class.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsNamedToolSelection	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatCompletionsNamedToolSelection from the JsonReader.
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

ChatCompletionsNamedToolSelection

public ChatCompletionsNamedToolSelection()

Creates an instance of ChatCompletionsNamedToolSelection class.

Method Details

getType

public String getType()

Get the type property: The object type.

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>

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsNamedToolSelection from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ChatCompletionsNamedToolSelection if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException - If an error occurs while reading the ChatCompletionsNamedToolSelection.