Enum Class ResponseFormat.Type

java.lang.Object

java.lang.Enum<ResponseFormat.Type>

org.springframework.ai.openai.api.ResponseFormat.Type

All Implemented Interfaces:

Serializable, Comparable<ResponseFormat.Type>, Constable

Enclosing class:

ResponseFormat

public static enum ResponseFormat.Type
extends Enum<ResponseFormat.Type>

Since:

1.0.0

Author:

Christian Tzolov

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON_OBJECT	Enables JSON mode, which guarantees the message the model generates is valid JSON.
JSON_SCHEMA	Enables Structured Outputs which guarantees the model will match your supplied JSON schema.
TEXT	Generates a text response.

Method Summary

Modifier and Type	Method	Description
static ResponseFormat.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResponseFormat.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT

public static final ResponseFormat.Type TEXT

Generates a text response. (default)

JSON_OBJECT

public static final ResponseFormat.Type JSON_OBJECT

Enables JSON mode, which guarantees the message the model generates is valid JSON.

JSON_SCHEMA

public static final ResponseFormat.Type JSON_SCHEMA

Enables Structured Outputs which guarantees the model will match your supplied JSON schema.

Method Details

values

public static ResponseFormat.Type[] values()

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

Returns:

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

valueOf

public static ResponseFormat.Type valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null