Class ChatCompletionAudioParam
-
- All Implemented Interfaces:
public final class ChatCompletionAudioParamParameters for audio output. Required when audio output is requested with
modalities: ["audio"]. Learn more.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionAudioParam.BuilderA builder for ChatCompletionAudioParam.
public final classChatCompletionAudioParam.FormatSpecifies the output audio format. Must be one of
wav,mp3,flac,opus, orpcm16.public final classChatCompletionAudioParam.VoiceThe voice the model uses to respond. Supported voices are
alloy,ash,ballad,coral,echo,fable,nova,onyx,sage, andshimmer.
-
Method Summary
Modifier and Type Method Description final ChatCompletionAudioParam.Formatformat()Specifies the output audio format. final ChatCompletionAudioParam.Voicevoice()The voice the model uses to respond. final JsonField<ChatCompletionAudioParam.Format>_format()Returns the raw JSON value of format. final JsonField<ChatCompletionAudioParam.Voice>_voice()Returns the raw JSON value of voice. final Map<String, JsonValue>_additionalProperties()final ChatCompletionAudioParam.BuildertoBuilder()final ChatCompletionAudioParamvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionAudioParam.Builderbuilder()Returns a mutable builder for constructing an instance of ChatCompletionAudioParam. -
-
Method Detail
-
format
final ChatCompletionAudioParam.Format format()
Specifies the output audio format. Must be one of
wav,mp3,flac,opus, orpcm16.
-
voice
final ChatCompletionAudioParam.Voice voice()
The voice the model uses to respond. Supported voices are
alloy,ash,ballad,coral,echo,fable,nova,onyx,sage, andshimmer.
-
_format
final JsonField<ChatCompletionAudioParam.Format> _format()
Returns the raw JSON value of format.
Unlike format, this method doesn't throw if the JSON field has an unexpected type.
-
_voice
final JsonField<ChatCompletionAudioParam.Voice> _voice()
Returns the raw JSON value of voice.
Unlike voice, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionAudioParam.Builder toBuilder()
-
validate
final ChatCompletionAudioParam validate()
-
builder
final static ChatCompletionAudioParam.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionAudioParam.
The following fields are required:
.format() .voice()
-
-
-
-