Class ChatCompletionAudioParam.Voice
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class ChatCompletionAudioParam.Voice implements EnumThe voice the model uses to respond. Supported voices are
ash,ballad,coral,sage, andverse(also supported but not recommended arealloy,echo, andshimmer; these voices are less expressive).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumChatCompletionAudioParam.Voice.KnownAn enum containing Voice's known values.
public enumChatCompletionAudioParam.Voice.ValueAn 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 ChatCompletionAudioParam.VoiceALLOYpublic final static ChatCompletionAudioParam.VoiceASHpublic final static ChatCompletionAudioParam.VoiceBALLADpublic final static ChatCompletionAudioParam.VoiceCORALpublic final static ChatCompletionAudioParam.VoiceECHOpublic final static ChatCompletionAudioParam.VoiceSAGEpublic final static ChatCompletionAudioParam.VoiceSHIMMERpublic final static ChatCompletionAudioParam.VoiceVERSE
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final ChatCompletionAudioParam.Voice.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final ChatCompletionAudioParam.Voice.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionAudioParam.Voiceof(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 ChatCompletionAudioParam.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 ChatCompletionAudioParam.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.
-
of
final static ChatCompletionAudioParam.Voice of(String value)
-
-
-
-