Package com.azure.ai.openai.models

Class ChatCompletionsJsonSchemaResponseFormat

java.lang.Object

com.azure.ai.openai.models.ChatCompletionsResponseFormat

com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormat

All Implemented Interfaces:

com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>

public final class ChatCompletionsJsonSchemaResponseFormat
extends ChatCompletionsResponseFormat

A response format for Chat Completions that restricts responses to emitting JSON that conforms to a provided JSON Schema for Structured Outputs.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionsJsonSchemaResponseFormat(ChatCompletionsJsonSchemaResponseFormatJsonSchema jsonSchema)	Creates an instance of ChatCompletionsJsonSchemaResponseFormat class.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsJsonSchemaResponseFormat	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatCompletionsJsonSchemaResponseFormat from the JsonReader.
ChatCompletionsJsonSchemaResponseFormatJsonSchema	getJsonSchema()	Get the jsonSchema property: The json_schema property.
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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

ChatCompletionsJsonSchemaResponseFormat

public ChatCompletionsJsonSchemaResponseFormat(ChatCompletionsJsonSchemaResponseFormatJsonSchema jsonSchema)

Creates an instance of ChatCompletionsJsonSchemaResponseFormat class.

Parameters:

jsonSchema - the jsonSchema value to set.

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.

getJsonSchema

public ChatCompletionsJsonSchemaResponseFormatJsonSchema getJsonSchema()

Get the jsonSchema property: The json_schema property.

Returns:

the jsonSchema 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 ChatCompletionsJsonSchemaResponseFormat fromJson(com.azure.json.JsonReader jsonReader)
                                                        throws IOException

Reads an instance of ChatCompletionsJsonSchemaResponseFormat from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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