Package org.springframework.ai.openai.api

Enum Class OpenAiAudioApi.SpeechRequest.Voice

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

OpenAiAudioApi.SpeechRequest

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

The voice to use for synthesis.

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
ALLOY
ASH
CORAL
ECHO
FABLE
NOVA
ONYX
SAGE
SHIMMER

Field Summary

Fields

Modifier and Type	Field	Description
final String	value

Method Summary

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

ALLOY

public static final OpenAiAudioApi.SpeechRequest.Voice ALLOY

ECHO

public static final OpenAiAudioApi.SpeechRequest.Voice ECHO

FABLE

public static final OpenAiAudioApi.SpeechRequest.Voice FABLE

ONYX

public static final OpenAiAudioApi.SpeechRequest.Voice ONYX

NOVA

public static final OpenAiAudioApi.SpeechRequest.Voice NOVA

SHIMMER

public static final OpenAiAudioApi.SpeechRequest.Voice SHIMMER

SAGE

public static final OpenAiAudioApi.SpeechRequest.Voice SAGE

CORAL

public static final OpenAiAudioApi.SpeechRequest.Voice CORAL

ASH

public static final OpenAiAudioApi.SpeechRequest.Voice ASH

Field Details

value

public final String value

Method Details

values

public static OpenAiAudioApi.SpeechRequest.Voice[] 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.Voice 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()