Package com.azure.ai.openai.models

Class ChatCompletionsResponseFormat

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsResponseFormat

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>

Direct Known Subclasses:

ChatCompletionsJsonResponseFormat, ChatCompletionsTextResponseFormat

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

An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON mode.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsResponseFormat	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatCompletionsResponseFormat from the JsonReader.
String	getType()	Get the type property: The discriminated type for the response format.
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

ChatCompletionsResponseFormat

public ChatCompletionsResponseFormat()

Creates an instance of ChatCompletionsResponseFormat class.

Method Details

getType

public String getType()

Get the type property: The discriminated type for the response format.

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

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsResponseFormat from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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