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

Class AssistantsApiResponseFormatJsonObject

java.lang.Object

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

com.azure.ai.openai.assistants.models.AssistantsApiResponseFormatJsonObject

All Implemented Interfaces:

com.azure.json.JsonSerializable<AssistantsApiResponseFormat>

public final class AssistantsApiResponseFormatJsonObject
extends AssistantsApiResponseFormat

An object describing expected output of the model as a JSON object.

Constructor Summary

Constructors

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

Method Summary

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

AssistantsApiResponseFormatJsonObject

public AssistantsApiResponseFormatJsonObject()

Creates an instance of AssistantsApiResponseFormatJsonObject class.

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.

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

Reads an instance of AssistantsApiResponseFormatJsonObject from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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