Class: Telnyx::Models::TextToSpeechGenerateSpeechParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/text_to_speech_generate_speech_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(text:, voice:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::TextToSpeechGenerateSpeechParams for more details.

Parameters:

  • text (String) —

    The text to convert to speech

  • voice (String) —

    The voice ID in the format Provider.ModelId.VoiceId.

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



# File 'lib/telnyx/models/text_to_speech_generate_speech_params.rb', line 32

Instance Attribute Details

#text ⇒ String

The text to convert to speech

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/text_to_speech_generate_speech_params.rb', line 14

required :text, String

#voice ⇒ String

The voice ID in the format Provider.ModelId.VoiceId.

Examples:

  • AWS.Polly.Joanna-Neural

  • Azure.en-US-AvaMultilingualNeural

  • ElevenLabs.eleven_multilingual_v2.Rachel

  • Telnyx.KokoroTTS.af

Use the ‘GET /text-to-speech/voices` endpoint to get a complete list of available voices.

Returns:

  • (String) 


30
 
# File 'lib/telnyx/models/text_to_speech_generate_speech_params.rb', line 30

required :voice, String