Class: Revox::Models::AssistantRetrieveResponse::Voice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/revox/models/assistant_retrieve_response.rb,
sig/revox/models/assistant_retrieve_response.rbs

Overview

See Also:

  • Revox::Models::AssistantRetrieveResponse#voice

Defined Under Namespace

Modules: Model, Provider

Instance Attribute Summary collapse

Class Method 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(id:, provider:, model: nil, speed: nil, volume: nil) ⇒ Object

Some parameter documentations has been truncated, see Revox::Models::AssistantRetrieveResponse::Voice for more details.

Parameters:

  • id (String) —

    The ID of the voice.

  • provider (Symbol, Revox::Models::AssistantRetrieveResponse::Voice::Provider) —

    The provider of the voice.

  • model (Symbol, Revox::Models::AssistantRetrieveResponse::Voice::Model) (defaults to: nil) —

    Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored fo

  • speed (Float) (defaults to: nil) —

    The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs

  • volume (Float) (defaults to: nil) —

    Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other pro




# File 'lib/revox/models/assistant_retrieve_response.rb', line 1347

Instance Attribute Details

#id ⇒ String

The ID of the voice.

Parameters:

  • value (String)

Returns:

  • (String) 


1318
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1318

required :id, String

#model ⇒ Symbol, ...

Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored for other providers.

Returns:



1331
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1331

optional :model, enum: -> { Revox::Models::AssistantRetrieveResponse::Voice::Model }

#provider ⇒ Symbol, Revox::Models::AssistantRetrieveResponse::Voice::Provider

The provider of the voice.

Parameters:

  • value (Revox::Models::AssistantRetrieveResponse::Voice::provider)

Returns:



1324
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1324

required :provider, enum: -> { Revox::Models::AssistantRetrieveResponse::Voice::Provider }

#speed ⇒ Float?

The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


1338
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1338

optional :speed, Float

#volume ⇒ Float?

Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other providers.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


1345
 
# File 'lib/revox/models/assistant_retrieve_response.rb', line 1345

optional :volume, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/revox/models/assistant_retrieve_response.rb', line 1370

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1108
 
# File 'sig/revox/models/assistant_retrieve_response.rbs', line 1108

def to_hash: -> {