Package com.azure.ai.openai.models

Class ChatCompletionsJsonResponseFormat

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsResponseFormat

com.azure.ai.openai.models.ChatCompletionsJsonResponseFormat

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>

public final class ChatCompletionsJsonResponseFormat
extends ChatCompletionsResponseFormat

A response format for Chat Completions that restricts responses to emitting valid JSON objects.

Constructor Summary

Constructors

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

Method Summary

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

ChatCompletionsJsonResponseFormat

public ChatCompletionsJsonResponseFormat()

Creates an instance of ChatCompletionsJsonResponseFormat class.

Method Details

getType

public String getType()

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

Overrides:

getType in class ChatCompletionsResponseFormat

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>

Overrides:

toJson in class ChatCompletionsResponseFormat

Throws:

IOException

fromJson

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

Reads an instance of ChatCompletionsJsonResponseFormat from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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