Class: Telnyx::Models::ConversationRelayLanguage

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::ConversationRelayLanguage

Defined in:

lib/telnyx/models/conversation_relay_language.rb,
sig/telnyx/models/conversation_relay_language.rbs

Defined Under Namespace

Modules: TranscriptionEngine, VoiceSettings

Instance Attribute Summary

• #language ⇒ String

  BCP 47 language tag for this language configuration.

• #speech_model ⇒ String^?

  Conversation Relay speech model.

• #transcription_engine ⇒ Symbol, ...

  Engine to use for speech recognition.

• #transcription_engine_config ⇒ Hash{Symbol=>Object}^?

  Engine-specific transcription settings for Conversation Relay.

• #transcription_provider ⇒ String^?

  Conversation Relay transcription provider name.

• #tts_provider ⇒ String^?

  Text-to-speech provider for this language.

• #voice ⇒ String^?

  Voice identifier for this language.

• #voice_settings ⇒ Telnyx::Models::Calls::ElevenLabsVoiceSettings, ...

  The settings associated with the voice selected.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(language:, speech_model: nil, transcription_engine: nil, transcription_engine_config: nil, transcription_provider: nil, tts_provider: nil, voice: nil, voice_settings: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ConversationRelayLanguage for more details.

• #to_hash ⇒ {

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(language:, speech_model: nil, transcription_engine: nil, transcription_engine_config: nil, transcription_provider: nil, tts_provider: nil, voice: nil, voice_settings: nil) ⇒ Object

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

Language-specific TTS and transcription settings for Conversation Relay.

Parameters:

• language (String) —

  BCP 47 language tag for this language configuration.

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

  Conversation Relay speech model. Prefer `transcription_engine_config.transcripti

• transcription_engine (Symbol, Telnyx::Models::ConversationRelayLanguage::TranscriptionEngine) (defaults to: nil) —

  Engine to use for speech recognition. Legacy values A - Google, B - `Telny

• transcription_engine_config (Hash{Symbol=>Object}) (defaults to: nil) —

  Engine-specific transcription settings for Conversation Relay. This accepts the

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

  Conversation Relay transcription provider name. Prefer transcription_engine wh

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

  Text-to-speech provider for this language. If omitted and voice is provided, T

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

  Voice identifier for this language.

• voice_settings (Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings) (defaults to: nil) —

  The settings associated with the voice selected

# File 'lib/telnyx/models/conversation_relay_language.rb', line 64

Instance Attribute Details

#language ⇒ String

BCP 47 language tag for this language configuration.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 10

required :language, String

#speech_model ⇒ String^?

Conversation Relay speech model. Prefer transcription_engine_config.transcription_model when configuring speech-to-text.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 18

optional :speech_model, String

#transcription_engine ⇒ Symbol, ...

Engine to use for speech recognition. Legacy values A - Google, B - Telnyx are supported for backward compatibility. When provided in a Conversation Relay language entry, Telnyx derives transcription_provider and speech_model for that language.

Returns:

• (Symbol, Telnyx::Models::ConversationRelayLanguage::TranscriptionEngine, nil)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 27

optional :transcription_engine, enum: -> { Telnyx::ConversationRelayLanguage::TranscriptionEngine }

#transcription_engine_config ⇒ Hash{Symbol=>Object}^?

Engine-specific transcription settings for Conversation Relay. This accepts the same provider-specific options used by the Call Transcription Start command, such as transcription_model, without requiring the engine discriminator to be repeated inside this object.

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 36

optional :transcription_engine_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#transcription_provider ⇒ String^?

Conversation Relay transcription provider name. Prefer transcription_engine when configuring speech-to-text.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 43

optional :transcription_provider, String

#tts_provider ⇒ String^?

Text-to-speech provider for this language. If omitted and voice is provided, Telnyx derives the provider from the voice identifier.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 50

optional :tts_provider, String

#voice ⇒ String^?

Voice identifier for this language.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 56

optional :voice, String

#voice_settings ⇒ Telnyx::Models::Calls::ElevenLabsVoiceSettings, ...

The settings associated with the voice selected

Returns:

• (Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 62

optional :voice_settings, union: -> { Telnyx::ConversationRelayLanguage::VoiceSettings }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/conversation_relay_language.rb', line 106

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/conversation_relay_language.rbs', line 63

def to_hash: -> {