Class: Telnyx::Models::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/voice_clone_create_from_upload_params.rb

Defined Under Namespace

Modules: Gender, ModelID, 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(audio_file:, gender:, language:, model_id:, name:, provider:, label: nil, ref_text: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone for more details.

Upload-based voice clone using the Telnyx Ultra model.

Parameters:




# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 212

Instance Attribute Details

#audio_file ⇒ Pathname, ...

Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A. For best quality, provide 5–10 seconds of clear, uninterrupted speech. Maximum size: 5MB.

Returns:



166
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 166

required :audio_file, Telnyx::Internal::Type::FileInput

#gender ⇒ Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone::Gender

Gender of the voice clone.

Returns:



172
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 172

required :gender, enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone::Gender }

#label ⇒ String?

Optional custom label describing the voice style.

Returns:

  • (String, nil) 


204
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 204

optional :label, String

#language ⇒ String

ISO 639-1 language code from the Ultra language set (40 languages).

Returns:

  • (String) 


178
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 178

required :language, String

#model_id ⇒ Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone::ModelID

TTS model identifier. Must be ‘Ultra`.

Returns:



184
185
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 184

required :model_id,
enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone::ModelID }

#name ⇒ String

Name for the voice clone.

Returns:

  • (String) 


191
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 191

required :name, String

#provider ⇒ Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone::Provider

Voice synthesis provider. Must be ‘telnyx`.

Returns:



197
198
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 197

required :provider,
enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::Params::TelnyxUltraClone::Provider }

#ref_text ⇒ String?

Optional transcript of the audio file. Providing this improves clone quality.

Returns:

  • (String, nil) 


210
 
# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 210

optional :ref_text, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/voice_clone_create_from_upload_params.rb', line 245