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

Class ApiResponseFormat

java.lang.Object

com.azure.core.util.ExpandableStringEnum<ApiResponseFormat>

com.azure.ai.openai.assistants.models.ApiResponseFormat

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class ApiResponseFormat
extends com.azure.core.util.ExpandableStringEnum<ApiResponseFormat>

Possible API response formats.

Field Summary

Fields

Modifier and Type	Field	Description
static final ApiResponseFormat	JSON_OBJECT	Using `json_object` format will limit the usage of ToolCall to only functions.
static final ApiResponseFormat	JSON_SCHEMA	Using `json_schema` format will ensure the model matches the supplied JSON schema.
static final ApiResponseFormat	TEXT	`text` format should be used for requests involving any sort of ToolCall.

Constructor Summary

Constructors

Constructor	Description
ApiResponseFormat()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static ApiResponseFormat	fromString(String name)	Creates or finds a ApiResponseFormat from its string representation.
static Collection<ApiResponseFormat>	values()	Gets known ApiResponseFormat values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TEXT

public static final ApiResponseFormat TEXT

`text` format should be used for requests involving any sort of ToolCall.

JSON_OBJECT

public static final ApiResponseFormat JSON_OBJECT

Using `json_object` format will limit the usage of ToolCall to only functions.

JSON_SCHEMA

public static final ApiResponseFormat JSON_SCHEMA

Using `json_schema` format will ensure the model matches the supplied JSON schema.

Constructor Details

ApiResponseFormat

@Deprecated
public ApiResponseFormat()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ApiResponseFormat value.

Method Details

fromString

public static ApiResponseFormat fromString(String name)

Creates or finds a ApiResponseFormat from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ApiResponseFormat.

values

public static Collection<ApiResponseFormat> values()

Gets known ApiResponseFormat values.

Returns:

known ApiResponseFormat values.