Class SpeechCreateParams.Voice
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class SpeechCreateParams.Voice implements Enum
The voice to use when generating the audio. Supported voices are
alloy
,ash
,ballad
,coral
,echo
,fable
,onyx
,nova
,sage
,shimmer
, andverse
. Previews of the voices are available in the Text to speech guide.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
SpeechCreateParams.Voice.Known
An enum containing Voice's known values.
public enum
SpeechCreateParams.Voice.Value
An enum containing Voice's known values, as well as an _UNKNOWN member.
An instance of Voice can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static SpeechCreateParams.Voice
ALLOY
public final static SpeechCreateParams.Voice
ASH
public final static SpeechCreateParams.Voice
BALLAD
public final static SpeechCreateParams.Voice
CORAL
public final static SpeechCreateParams.Voice
ECHO
public final static SpeechCreateParams.Voice
FABLE
public final static SpeechCreateParams.Voice
ONYX
public final static SpeechCreateParams.Voice
NOVA
public final static SpeechCreateParams.Voice
SAGE
public final static SpeechCreateParams.Voice
SHIMMER
public final static SpeechCreateParams.Voice
VERSE
-
Method Summary
Modifier and Type Method Description final JsonField<String>
_value()
Returns this class instance's raw value. final SpeechCreateParams.Voice.Value
value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final SpeechCreateParams.Voice.Known
known()
Returns an enum member corresponding to this class instance's value. final String
asString()
Returns this class instance's primitive wire representation. final SpeechCreateParams.Voice
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static SpeechCreateParams.Voice
of(String value)
-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final SpeechCreateParams.Voice.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final SpeechCreateParams.Voice.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final SpeechCreateParams.Voice validate()
-
of
final static SpeechCreateParams.Voice of(String value)
-
-
-
-