Class: Revox::Models::VoicePreviewParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/revox/models/voice_preview_params.rb,
sig/revox/models/voice_preview_params.rbs

Overview

See Also:

  • Revox::Resources::Voices#preview

Defined Under Namespace

Modules: Model, Provider

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(provider:, voice_id:, model: nil, speed: nil, text: nil, volume: nil, request_options: {}) ⇒ Object

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

Parameters:

  • provider (Symbol, Revox::Models::VoicePreviewParams::Provider) —

    The provider to use for the preview.

  • voice_id (String) —

    The voice ID to generate a preview for.

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

    Cartesia model for the preview. Defaults to sonic-3. Ignored for other providers

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

    Speed for preview. Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default 1.0.

  • text (String) (defaults to: nil) —

    Custom text for the preview. If omitted, a short default is used.

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

    Volume for Cartesia preview (0.5–2.0). Ignored for other providers.

  • request_options (Revox::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/revox/models/voice_preview_params.rb', line 47

Instance Attribute Details

#model ⇒ Symbol, ...

Cartesia model for the preview. Defaults to sonic-3. Ignored for other providers.

Returns:



27
 
# File 'lib/revox/models/voice_preview_params.rb', line 27

optional :model, enum: -> { Revox::VoicePreviewParams::Model }

#provider ⇒ Symbol, Revox::Models::VoicePreviewParams::Provider

The provider to use for the preview.

Parameters:

  • value (Revox::Models::VoicePreviewParams::provider)

Returns:



14
 
# File 'lib/revox/models/voice_preview_params.rb', line 14

required :provider, enum: -> { Revox::VoicePreviewParams::Provider }

#speed ⇒ Float?

Speed for preview. Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default 1.0.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


33
 
# File 'lib/revox/models/voice_preview_params.rb', line 33

optional :speed, Float

#text ⇒ String?

Custom text for the preview. If omitted, a short default is used.

Parameters:

  • (String)

Returns:

  • (String, nil) 


39
 
# File 'lib/revox/models/voice_preview_params.rb', line 39

optional :text, String

#voice_id ⇒ String

The voice ID to generate a preview for.

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/revox/models/voice_preview_params.rb', line 20

required :voice_id, String, api_name: :voiceId

#volume ⇒ Float?

Volume for Cartesia preview (0.5–2.0). Ignored for other providers.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


45
 
# File 'lib/revox/models/voice_preview_params.rb', line 45

optional :volume, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/revox/models/voice_preview_params.rb', line 72

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/revox/models/voice_preview_params.rbs', line 50

def to_hash: -> {