Class RealtimeAudioConfigOutput.Voice
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class RealtimeAudioConfigOutput.Voice implements Enum
The voice the model uses to respond. Voice cannot be changed during the session once the model has responded with audio at least once. Current voice options are
alloy
,ash
,ballad
,coral
,echo
,sage
,shimmer
,verse
,marin
, andcedar
. We recommendmarin
andcedar
for best quality.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
RealtimeAudioConfigOutput.Voice.Known
An enum containing Voice's known values.
public enum
RealtimeAudioConfigOutput.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 RealtimeAudioConfigOutput.Voice
ALLOY
public final static RealtimeAudioConfigOutput.Voice
ASH
public final static RealtimeAudioConfigOutput.Voice
BALLAD
public final static RealtimeAudioConfigOutput.Voice
CORAL
public final static RealtimeAudioConfigOutput.Voice
ECHO
public final static RealtimeAudioConfigOutput.Voice
SAGE
public final static RealtimeAudioConfigOutput.Voice
SHIMMER
public final static RealtimeAudioConfigOutput.Voice
VERSE
public final static RealtimeAudioConfigOutput.Voice
MARIN
public final static RealtimeAudioConfigOutput.Voice
CEDAR
-
Method Summary
Modifier and Type Method Description final JsonField<String>
_value()
Returns this class instance's raw value. final RealtimeAudioConfigOutput.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 RealtimeAudioConfigOutput.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 RealtimeAudioConfigOutput.Voice
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RealtimeAudioConfigOutput.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 RealtimeAudioConfigOutput.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 RealtimeAudioConfigOutput.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 RealtimeAudioConfigOutput.Voice validate()
-
of
final static RealtimeAudioConfigOutput.Voice of(String value)
-
-
-
-