Package com.azure.ai.openai.assistants.models

Class AssistantsApiResponseFormatJsonSchema

java.lang.Object

com.azure.ai.openai.assistants.models.AssistantsApiResponseFormat

com.azure.ai.openai.assistants.models.AssistantsApiResponseFormatJsonSchema

All Implemented Interfaces:

com.azure.json.JsonSerializable<AssistantsApiResponseFormat>

public final class AssistantsApiResponseFormatJsonSchema
extends AssistantsApiResponseFormat

An object describing expected output of the model to match a JSON schema.

Constructor Summary

Constructors

Constructor	Description
AssistantsApiResponseFormatJsonSchema(AssistantsApiResponseFormatJsonSchemaJsonSchema jsonSchema)	Creates an instance of AssistantsApiResponseFormatJsonSchema class.

Method Summary

Modifier and Type	Method	Description
static AssistantsApiResponseFormatJsonSchema	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AssistantsApiResponseFormatJsonSchema from the JsonReader.
AssistantsApiResponseFormatJsonSchemaJsonSchema	getJsonSchema()	Get the jsonSchema property: The JSON schema that the model must output.
ApiResponseFormat	getType()	Get the type property: Must be one of `text`, `json_object` or `json_schema` .
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

AssistantsApiResponseFormatJsonSchema

public AssistantsApiResponseFormatJsonSchema(AssistantsApiResponseFormatJsonSchemaJsonSchema jsonSchema)

Creates an instance of AssistantsApiResponseFormatJsonSchema class.

Parameters:

jsonSchema - the jsonSchema value to set.

Method Details

getType

public ApiResponseFormat getType()

Get the type property: Must be one of `text`, `json_object` or `json_schema` .

Overrides:

getType in class AssistantsApiResponseFormat

Returns:

the type value.

getJsonSchema

public AssistantsApiResponseFormatJsonSchemaJsonSchema getJsonSchema()

Get the jsonSchema property: The JSON schema that the model must output.

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

Overrides:

toJson in class AssistantsApiResponseFormat

Throws:

IOException

fromJson

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

Reads an instance of AssistantsApiResponseFormatJsonSchema from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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