Package org.springframework.ai.azure.openai

Enum Class AzureOpenAiResponseFormat

java.lang.Object

java.lang.Enum<AzureOpenAiResponseFormat>

org.springframework.ai.azure.openai.AzureOpenAiResponseFormat

All Implemented Interfaces:

Serializable, Comparable<AzureOpenAiResponseFormat>, Constable

public enum AzureOpenAiResponseFormat
extends Enum<AzureOpenAiResponseFormat>

Utility enumeration for representing the response format that may be requested from the Azure OpenAI model. Please check OpenAI API documentation for more details.

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
TEXT

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT

public static final AzureOpenAiResponseFormat TEXT

JSON

public static final AzureOpenAiResponseFormat JSON

Method Details

values

public static AzureOpenAiResponseFormat[] 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 AzureOpenAiResponseFormat 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