Module: OpenAI::Models::Realtime::RealtimeSession::Voice

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/realtime/realtime_session.rb,
sig/openai/models/realtime/realtime_session.rbs

Overview

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, and verse.

See Also:

  • OpenAI::Models::Realtime::RealtimeSession#voice

collapse

ALLOY =

Returns:

  • (:alloy) 
:alloy
ASH =

Returns:

  • (:ash) 
:ash
BALLAD =

Returns:

  • (:ballad) 
:ballad
CORAL =

Returns:

  • (:coral) 
:coral
ECHO =

Returns:

  • (:echo) 
:echo
SAGE =

Returns:

  • (:sage) 
:sage
SHIMMER =

Returns:

  • (:shimmer) 
:shimmer
VERSE =

Returns:

  • (:verse) 
:verse
MARIN =

Returns:

  • (:marin) 
:marin
CEDAR =

Returns:

  • (:cedar) 
:cedar

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Class Method Details

.variants ⇒ Array(String, Symbol)

Returns:

  • (Array(String, Symbol)) 


693
694
695
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 693

define_sorbet_constant!(:Variants) do
  T.type_alias { T.any(String, OpenAI::Realtime::RealtimeSession::Voice::TaggedSymbol) }
end

Instance Method Details

#self?.variants ⇒ ::Array[OpenAI::Models::Realtime::RealtimeSession::voice]

Returns:

  • (::Array[OpenAI::Models::Realtime::RealtimeSession::voice]) 


462
 
# File 'sig/openai/models/realtime/realtime_session.rbs', line 462

def self?.variants: -> ::Array[OpenAI::Models::Realtime::RealtimeSession::voice]