Class: OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Audio::Output

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_session_create_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Voice

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(format_: nil, speed: nil, voice: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeSessionCreateResponse::Audio::Output for more details.

Parameters:




# File 'lib/openai/models/realtime/realtime_session_create_response.rb', line 495

Instance Attribute Details

#format_ ⇒ OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, ...

The format of the output audio.

Returns:



472
 
# File 'lib/openai/models/realtime/realtime_session_create_response.rb', line 472

optional :format_, union: -> { OpenAI::Realtime::RealtimeAudioFormats }, api_name: :format

#speed ⇒ Float?

The speed of the model’s spoken response as a multiple of the original speed. 1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.

This parameter is a post-processing adjustment to the audio after it is generated, it’s also possible to prompt the model to speak faster or slower.

Returns:

  • (Float, nil) 


484
 
# File 'lib/openai/models/realtime/realtime_session_create_response.rb', line 484

optional :speed, Float

#voice ⇒ String, ...

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`, and `cedar`. We recommend `marin` and `cedar` for best quality.

Returns:



493
 
# File 'lib/openai/models/realtime/realtime_session_create_response.rb', line 493

optional :voice, union: -> { OpenAI::Realtime::RealtimeSessionCreateResponse::Audio::Output::Voice }