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

Class AssistantsApiResponseFormat

java.lang.Object

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

All Implemented Interfaces:

com.azure.json.JsonSerializable<AssistantsApiResponseFormat>

Direct Known Subclasses:

AssistantsApiResponseFormatJsonObject, AssistantsApiResponseFormatJsonSchema, AssistantsApiResponseFormatText

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

An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run. If `text` the model can return text or any value needed.

Constructor Summary

Constructors

Constructor	Description
AssistantsApiResponseFormat()	Creates an instance of AssistantsApiResponseFormat class.
AssistantsApiResponseFormat(ApiResponseFormat type)	Creates an instance of AssistantsApiResponseFormat class.

Method Summary

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

AssistantsApiResponseFormat

public AssistantsApiResponseFormat()

Creates an instance of AssistantsApiResponseFormat class.

AssistantsApiResponseFormat

public AssistantsApiResponseFormat(ApiResponseFormat type)

Creates an instance of AssistantsApiResponseFormat class.

Parameters:

type - Must be one of `text` or `json_object`.

Method Details

getType

public ApiResponseFormat getType()

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

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>

Throws:

IOException

fromJson

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

Reads an instance of AssistantsApiResponseFormat from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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