Package org.springframework.ai.openai.api

Enum Class OpenAiApi.OutputModality

java.lang.Object

java.lang.Enum<OpenAiApi.OutputModality>

org.springframework.ai.openai.api.OpenAiApi.OutputModality

All Implemented Interfaces:

Serializable, Comparable<OpenAiApi.OutputModality>, Constable

Enclosing class:

OpenAiApi

public static enum OpenAiApi.OutputModality
extends Enum<OpenAiApi.OutputModality>

The type of modality for the model completion.

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
AUDIO
TEXT

Method Summary

Modifier and Type	Method	Description
static OpenAiApi.OutputModality	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAiApi.OutputModality[]	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

AUDIO

public static final OpenAiApi.OutputModality AUDIO

TEXT

public static final OpenAiApi.OutputModality TEXT

Method Details

values

public static OpenAiApi.OutputModality[] 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 OpenAiApi.OutputModality 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