Package com.azure.ai.openai.responses.models

Enum ResponsesTextFormatType

java.lang.Object

java.lang.Enum<ResponsesTextFormatType>

com.azure.ai.openai.responses.models.ResponsesTextFormatType

All Implemented Interfaces:

Serializable, Comparable<ResponsesTextFormatType>, java.lang.constant.Constable

public enum ResponsesTextFormatType
extends Enum<ResponsesTextFormatType>

Defines values for ResponsesTextFormatType.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON_OBJECT	Enum value json_object.
JSON_SCHEMA	Enum value json_schema.
TEXT	Enum value text.

Method Summary

Modifier and Type	Method	Description
static ResponsesTextFormatType	fromString(String value)	Parses a serialized value to a ResponsesTextFormatType instance.
String	toString()
static ResponsesTextFormatType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ResponsesTextFormatType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT

public static final ResponsesTextFormatType TEXT

Enum value text.

JSON_OBJECT

public static final ResponsesTextFormatType JSON_OBJECT

Enum value json_object.

JSON_SCHEMA

public static final ResponsesTextFormatType JSON_SCHEMA

Enum value json_schema.

Method Details

values

public static ResponsesTextFormatType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResponsesTextFormatType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static ResponsesTextFormatType fromString(String value)

Parses a serialized value to a ResponsesTextFormatType instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed ResponsesTextFormatType object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<ResponsesTextFormatType>