Package org.springframework.ai.openai.api

Enum Class OpenAiAudioApi.SpeechRequest.AudioResponseFormat

java.lang.Object

java.lang.Enum<OpenAiAudioApi.SpeechRequest.AudioResponseFormat>

org.springframework.ai.openai.api.OpenAiAudioApi.SpeechRequest.AudioResponseFormat

All Implemented Interfaces:

Serializable, Comparable<OpenAiAudioApi.SpeechRequest.AudioResponseFormat>, Constable

Enclosing class:

OpenAiAudioApi.SpeechRequest

public static enum OpenAiAudioApi.SpeechRequest.AudioResponseFormat
extends Enum<OpenAiAudioApi.SpeechRequest.AudioResponseFormat>

The format to audio in. Supported formats are mp3, opus, aac, and flac. Defaults to mp3.

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
AAC
FLAC
MP3
OPUS

Field Summary

Fields

Modifier and Type	Field	Description
final String	value

Method Summary

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

MP3

public static final OpenAiAudioApi.SpeechRequest.AudioResponseFormat MP3

OPUS

public static final OpenAiAudioApi.SpeechRequest.AudioResponseFormat OPUS

AAC

public static final OpenAiAudioApi.SpeechRequest.AudioResponseFormat AAC

FLAC

public static final OpenAiAudioApi.SpeechRequest.AudioResponseFormat FLAC

Field Details

value

public final String value

Method Details

values

public static OpenAiAudioApi.SpeechRequest.AudioResponseFormat[] 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 OpenAiAudioApi.SpeechRequest.AudioResponseFormat 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

getValue

public String getValue()