telnyx 5.123.0 → 5.124.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +19 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +5 -0
- data/lib/telnyx/models/ai/assistant_create_params.rb +780 -1
- data/lib/telnyx/models/ai/assistant_update_params.rb +780 -1
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +785 -1
- data/lib/telnyx/models/ai/inference_embedding.rb +767 -1
- data/lib/telnyx/models/{ai_create_response_params.rb → ai_create_response_deprecated_params.rb} +2 -2
- data/lib/telnyx/models/{ai_create_response_response.rb → ai_create_response_deprecated_response.rb} +1 -1
- data/lib/telnyx/models/call_dial_params.rb +276 -10
- data/lib/telnyx/models/calls/action_answer_params.rb +278 -10
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +15 -4
- data/lib/telnyx/models/calls/action_speak_params.rb +15 -4
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +431 -13
- data/lib/telnyx/models/calls/transcription_start_request.rb +173 -5
- data/lib/telnyx/models/conferences/action_speak_params.rb +15 -4
- data/lib/telnyx/models/messaging_profile_update_params.rb +9 -1
- data/lib/telnyx/models/sip_registration_status_retrieve_params.rb +45 -0
- data/lib/telnyx/models/sip_registration_status_retrieve_response.rb +160 -0
- data/lib/telnyx/models/speech_to_text_list_providers_params.rb +16 -5
- data/lib/telnyx/models/speech_to_text_list_providers_response.rb +55 -23
- data/lib/telnyx/models/voice_sdk_call_report_list_response.rb +114 -9
- data/lib/telnyx/models/voice_sdk_call_report_retrieve_response.rb +116 -9
- data/lib/telnyx/models/whatsapp/user_data_retrieve_response.rb +44 -3
- data/lib/telnyx/models/whatsapp/user_data_update_response.rb +44 -3
- data/lib/telnyx/models.rb +3 -9
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
- data/lib/telnyx/resources/ai/assistants.rb +6 -2
- data/lib/telnyx/resources/ai.rb +4 -4
- data/lib/telnyx/resources/calls/actions.rb +6 -6
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/messaging_profiles.rb +3 -1
- data/lib/telnyx/resources/sip_registration_status.rb +45 -0
- data/lib/telnyx/resources/speech_to_text.rb +6 -5
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +5 -9
- data/rbi/telnyx/client.rbi +4 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +1411 -0
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +1411 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +1417 -0
- data/rbi/telnyx/models/ai/inference_embedding.rbi +1454 -0
- data/rbi/telnyx/models/{ai_create_response_params.rbi → ai_create_response_deprecated_params.rbi} +5 -2
- data/rbi/telnyx/models/{ai_create_response_response.rbi → ai_create_response_deprecated_response.rbi} +1 -1
- data/rbi/telnyx/models/call_dial_params.rbi +661 -13
- data/rbi/telnyx/models/calls/action_answer_params.rbi +659 -13
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +30 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +30 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +1016 -17
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +433 -10
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +30 -5
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +8 -0
- data/rbi/telnyx/models/sip_registration_status_retrieve_params.rbi +93 -0
- data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi +343 -0
- data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi +27 -7
- data/rbi/telnyx/models/speech_to_text_list_providers_response.rbi +107 -43
- data/rbi/telnyx/models/voice_sdk_call_report_list_response.rbi +294 -9
- data/rbi/telnyx/models/voice_sdk_call_report_retrieve_response.rbi +294 -9
- data/rbi/telnyx/models/whatsapp/user_data_retrieve_response.rbi +96 -6
- data/rbi/telnyx/models/whatsapp/user_data_update_response.rbi +94 -6
- data/rbi/telnyx/models.rbi +5 -10
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +8 -0
- data/rbi/telnyx/resources/ai/assistants.rbi +16 -0
- data/rbi/telnyx/resources/ai.rbi +1 -1
- data/rbi/telnyx/resources/calls/actions.rbi +10 -7
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/messaging_profiles.rbi +3 -0
- data/rbi/telnyx/resources/sip_registration_status.rbi +34 -0
- data/rbi/telnyx/resources/speech_to_text.rbi +11 -5
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +508 -0
- data/sig/telnyx/models/ai/assistant_update_params.rbs +508 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +511 -0
- data/sig/telnyx/models/ai/inference_embedding.rbs +526 -0
- data/sig/telnyx/models/{ai_create_response_params.rbs → ai_create_response_deprecated_params.rbs} +2 -2
- data/sig/telnyx/models/ai_create_response_deprecated_response.rbs +7 -0
- data/sig/telnyx/models/call_dial_params.rbs +236 -13
- data/sig/telnyx/models/calls/action_answer_params.rbs +236 -13
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +11 -1
- data/sig/telnyx/models/calls/action_speak_params.rbs +11 -1
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +370 -19
- data/sig/telnyx/models/calls/transcription_start_request.rbs +175 -2
- data/sig/telnyx/models/conferences/action_speak_params.rbs +11 -1
- data/sig/telnyx/models/messaging_profile_update_params.rbs +5 -0
- data/sig/telnyx/models/sip_registration_status_retrieve_params.rbs +41 -0
- data/sig/telnyx/models/sip_registration_status_retrieve_response.rbs +164 -0
- data/sig/telnyx/models/speech_to_text_list_providers_params.rbs +4 -4
- data/sig/telnyx/models/speech_to_text_list_providers_response.rbs +33 -16
- data/sig/telnyx/models/voice_sdk_call_report_list_response.rbs +121 -8
- data/sig/telnyx/models/voice_sdk_call_report_retrieve_response.rbs +121 -8
- data/sig/telnyx/models/whatsapp/user_data_retrieve_response.rbs +57 -6
- data/sig/telnyx/models/whatsapp/user_data_update_response.rbs +57 -6
- data/sig/telnyx/models.rbs +3 -9
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +2 -0
- data/sig/telnyx/resources/ai.rbs +2 -2
- data/sig/telnyx/resources/calls/actions.rbs +2 -2
- data/sig/telnyx/resources/messaging_profiles.rbs +1 -0
- data/sig/telnyx/resources/sip_registration_status.rbs +13 -0
- metadata +17 -29
- data/lib/telnyx/models/calls/transcription_engine_soniox_config.rb +0 -91
- data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +0 -100
- data/lib/telnyx/models/conversation_relay_interruption_settings.rb +0 -105
- data/lib/telnyx/models/conversation_relay_language.rb +0 -141
- data/lib/telnyx/models/inworld_voice_settings.rb +0 -28
- data/lib/telnyx/models/voice_sdk_call_report_log_entry.rb +0 -57
- data/lib/telnyx/models/whatsapp/whatsapp_user_data.rb +0 -49
- data/rbi/telnyx/models/calls/transcription_engine_soniox_config.rbi +0 -184
- data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +0 -289
- data/rbi/telnyx/models/conversation_relay_interruption_settings.rbi +0 -271
- data/rbi/telnyx/models/conversation_relay_language.rbi +0 -309
- data/rbi/telnyx/models/inworld_voice_settings.rbi +0 -53
- data/rbi/telnyx/models/voice_sdk_call_report_log_entry.rbi +0 -108
- data/rbi/telnyx/models/whatsapp/whatsapp_user_data.rbi +0 -82
- data/sig/telnyx/models/ai_create_response_response.rbs +0 -7
- data/sig/telnyx/models/calls/transcription_engine_soniox_config.rbs +0 -79
- data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +0 -114
- data/sig/telnyx/models/conversation_relay_interruption_settings.rbs +0 -88
- data/sig/telnyx/models/conversation_relay_language.rbs +0 -121
- data/sig/telnyx/models/inworld_voice_settings.rbs +0 -26
- data/sig/telnyx/models/voice_sdk_call_report_log_entry.rbs +0 -58
- data/sig/telnyx/models/whatsapp/whatsapp_user_data.rbs +0 -54
|
@@ -359,8 +359,9 @@ module Telnyx
|
|
|
359
359
|
# @!attribute interruption_settings
|
|
360
360
|
# Settings for handling caller interruptions during Conversation Relay speech.
|
|
361
361
|
#
|
|
362
|
-
# @return [Telnyx::Models::
|
|
363
|
-
optional :interruption_settings,
|
|
362
|
+
# @return [Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings, nil]
|
|
363
|
+
optional :interruption_settings,
|
|
364
|
+
-> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings }
|
|
364
365
|
|
|
365
366
|
# @!attribute language
|
|
366
367
|
# Default language for both text-to-speech and speech recognition.
|
|
@@ -371,8 +372,9 @@ module Telnyx
|
|
|
371
372
|
# @!attribute languages
|
|
372
373
|
# Per-language TTS and transcription settings.
|
|
373
374
|
#
|
|
374
|
-
# @return [Array<Telnyx::Models::
|
|
375
|
-
optional :languages,
|
|
375
|
+
# @return [Array<Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language>, nil]
|
|
376
|
+
optional :languages,
|
|
377
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language] }
|
|
376
378
|
|
|
377
379
|
# @!attribute provider
|
|
378
380
|
# Structured voice provider. Must be supplied together with `structured_provider`.
|
|
@@ -448,7 +450,7 @@ module Telnyx
|
|
|
448
450
|
# @!attribute voice_settings
|
|
449
451
|
# The settings associated with the voice selected
|
|
450
452
|
#
|
|
451
|
-
# @return [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::
|
|
453
|
+
# @return [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::Calls::ActionAnswerParams::ConversationRelayConfig::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
|
|
452
454
|
optional :voice_settings,
|
|
453
455
|
union: -> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::VoiceSettings }
|
|
454
456
|
|
|
@@ -476,11 +478,11 @@ module Telnyx
|
|
|
476
478
|
#
|
|
477
479
|
# @param interruptible_greeting [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptibleGreeting] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
478
480
|
#
|
|
479
|
-
# @param interruption_settings [Telnyx::Models::
|
|
481
|
+
# @param interruption_settings [Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings] Settings for handling caller interruptions during Conversation Relay speech.
|
|
480
482
|
#
|
|
481
483
|
# @param language [String] Default language for both text-to-speech and speech recognition.
|
|
482
484
|
#
|
|
483
|
-
# @param languages [Array<Telnyx::Models::
|
|
485
|
+
# @param languages [Array<Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language>] Per-language TTS and transcription settings.
|
|
484
486
|
#
|
|
485
487
|
# @param provider [String] Structured voice provider. Must be supplied together with `structured_provider`.
|
|
486
488
|
#
|
|
@@ -494,7 +496,7 @@ module Telnyx
|
|
|
494
496
|
#
|
|
495
497
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
496
498
|
#
|
|
497
|
-
# @param 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::
|
|
499
|
+
# @param 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::Calls::ActionAnswerParams::ConversationRelayConfig::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
498
500
|
|
|
499
501
|
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
500
502
|
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
@@ -530,6 +532,260 @@ module Telnyx
|
|
|
530
532
|
# @return [Array<Symbol>]
|
|
531
533
|
end
|
|
532
534
|
|
|
535
|
+
# @see Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig#interruption_settings
|
|
536
|
+
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
537
|
+
# @!attribute enable
|
|
538
|
+
# Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is
|
|
539
|
+
# equivalent to `interruptible=none`.
|
|
540
|
+
#
|
|
541
|
+
# @return [Boolean, nil]
|
|
542
|
+
optional :enable, Telnyx::Internal::Type::Boolean
|
|
543
|
+
|
|
544
|
+
# @!attribute interruptible
|
|
545
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
546
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
547
|
+
# only; `dtmf` allows DTMF only.
|
|
548
|
+
#
|
|
549
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::Interruptible, nil]
|
|
550
|
+
optional :interruptible,
|
|
551
|
+
enum: -> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::Interruptible }
|
|
552
|
+
|
|
553
|
+
# @!attribute interruptible_greeting
|
|
554
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
555
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
556
|
+
# only; `dtmf` allows DTMF only.
|
|
557
|
+
#
|
|
558
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting, nil]
|
|
559
|
+
optional :interruptible_greeting,
|
|
560
|
+
enum: -> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting }
|
|
561
|
+
|
|
562
|
+
# @!attribute welcome_greeting_interruptible
|
|
563
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
564
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
565
|
+
# only; `dtmf` allows DTMF only.
|
|
566
|
+
#
|
|
567
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible, nil]
|
|
568
|
+
optional :welcome_greeting_interruptible,
|
|
569
|
+
enum: -> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible }
|
|
570
|
+
|
|
571
|
+
# @!method initialize(enable: nil, interruptible: nil, interruptible_greeting: nil, welcome_greeting_interruptible: nil)
|
|
572
|
+
# Some parameter documentations has been truncated, see
|
|
573
|
+
# {Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings}
|
|
574
|
+
# for more details.
|
|
575
|
+
#
|
|
576
|
+
# Settings for handling caller interruptions during Conversation Relay speech.
|
|
577
|
+
#
|
|
578
|
+
# @param enable [Boolean] Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is equ
|
|
579
|
+
#
|
|
580
|
+
# @param interruptible [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::Interruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
581
|
+
#
|
|
582
|
+
# @param interruptible_greeting [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::InterruptibleGreeting] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
583
|
+
#
|
|
584
|
+
# @param welcome_greeting_interruptible [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings::WelcomeGreetingInterruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
585
|
+
|
|
586
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
587
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
588
|
+
# only; `dtmf` allows DTMF only.
|
|
589
|
+
#
|
|
590
|
+
# @see Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings#interruptible
|
|
591
|
+
module Interruptible
|
|
592
|
+
extend Telnyx::Internal::Type::Enum
|
|
593
|
+
|
|
594
|
+
NONE = :none
|
|
595
|
+
ANY = :any
|
|
596
|
+
SPEECH = :speech
|
|
597
|
+
DTMF = :dtmf
|
|
598
|
+
|
|
599
|
+
# @!method self.values
|
|
600
|
+
# @return [Array<Symbol>]
|
|
601
|
+
end
|
|
602
|
+
|
|
603
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
604
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
605
|
+
# only; `dtmf` allows DTMF only.
|
|
606
|
+
#
|
|
607
|
+
# @see Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings#interruptible_greeting
|
|
608
|
+
module InterruptibleGreeting
|
|
609
|
+
extend Telnyx::Internal::Type::Enum
|
|
610
|
+
|
|
611
|
+
NONE = :none
|
|
612
|
+
ANY = :any
|
|
613
|
+
SPEECH = :speech
|
|
614
|
+
DTMF = :dtmf
|
|
615
|
+
|
|
616
|
+
# @!method self.values
|
|
617
|
+
# @return [Array<Symbol>]
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
621
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
622
|
+
# only; `dtmf` allows DTMF only.
|
|
623
|
+
#
|
|
624
|
+
# @see Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::InterruptionSettings#welcome_greeting_interruptible
|
|
625
|
+
module WelcomeGreetingInterruptible
|
|
626
|
+
extend Telnyx::Internal::Type::Enum
|
|
627
|
+
|
|
628
|
+
NONE = :none
|
|
629
|
+
ANY = :any
|
|
630
|
+
SPEECH = :speech
|
|
631
|
+
DTMF = :dtmf
|
|
632
|
+
|
|
633
|
+
# @!method self.values
|
|
634
|
+
# @return [Array<Symbol>]
|
|
635
|
+
end
|
|
636
|
+
end
|
|
637
|
+
|
|
638
|
+
class Language < Telnyx::Internal::Type::BaseModel
|
|
639
|
+
# @!attribute language
|
|
640
|
+
# BCP 47 language tag for this language configuration.
|
|
641
|
+
#
|
|
642
|
+
# @return [String]
|
|
643
|
+
required :language, String
|
|
644
|
+
|
|
645
|
+
# @!attribute speech_model
|
|
646
|
+
# Conversation Relay speech model. Prefer
|
|
647
|
+
# `transcription_engine_config.transcription_model` when configuring
|
|
648
|
+
# speech-to-text.
|
|
649
|
+
#
|
|
650
|
+
# @return [String, nil]
|
|
651
|
+
optional :speech_model, String
|
|
652
|
+
|
|
653
|
+
# @!attribute transcription_engine
|
|
654
|
+
# Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
|
|
655
|
+
# `Telnyx` are supported for backward compatibility. When provided in a
|
|
656
|
+
# Conversation Relay language entry, Telnyx derives `transcription_provider` and
|
|
657
|
+
# `speech_model` for that language.
|
|
658
|
+
#
|
|
659
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::TranscriptionEngine, nil]
|
|
660
|
+
optional :transcription_engine,
|
|
661
|
+
enum: -> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language::TranscriptionEngine }
|
|
662
|
+
|
|
663
|
+
# @!attribute transcription_engine_config
|
|
664
|
+
# Engine-specific transcription settings for Conversation Relay. This accepts the
|
|
665
|
+
# same provider-specific options used by the Call Transcription Start command,
|
|
666
|
+
# such as `transcription_model`, without requiring the engine discriminator to be
|
|
667
|
+
# repeated inside this object.
|
|
668
|
+
#
|
|
669
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
670
|
+
optional :transcription_engine_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
671
|
+
|
|
672
|
+
# @!attribute transcription_provider
|
|
673
|
+
# Conversation Relay transcription provider name. Prefer `transcription_engine`
|
|
674
|
+
# when configuring speech-to-text.
|
|
675
|
+
#
|
|
676
|
+
# @return [String, nil]
|
|
677
|
+
optional :transcription_provider, String
|
|
678
|
+
|
|
679
|
+
# @!attribute tts_provider
|
|
680
|
+
# Text-to-speech provider for this language. If omitted and `voice` is provided,
|
|
681
|
+
# Telnyx derives the provider from the voice identifier.
|
|
682
|
+
#
|
|
683
|
+
# @return [String, nil]
|
|
684
|
+
optional :tts_provider, String
|
|
685
|
+
|
|
686
|
+
# @!attribute voice
|
|
687
|
+
# Voice identifier for this language.
|
|
688
|
+
#
|
|
689
|
+
# @return [String, nil]
|
|
690
|
+
optional :voice, String
|
|
691
|
+
|
|
692
|
+
# @!attribute voice_settings
|
|
693
|
+
# The settings associated with the voice selected
|
|
694
|
+
#
|
|
695
|
+
# @return [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::Calls::ActionAnswerParams::ConversationRelayConfig::Language::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
|
|
696
|
+
optional :voice_settings,
|
|
697
|
+
union: -> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language::VoiceSettings }
|
|
698
|
+
|
|
699
|
+
# @!method initialize(language:, speech_model: nil, transcription_engine: nil, transcription_engine_config: nil, transcription_provider: nil, tts_provider: nil, voice: nil, voice_settings: nil)
|
|
700
|
+
# Some parameter documentations has been truncated, see
|
|
701
|
+
# {Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language}
|
|
702
|
+
# for more details.
|
|
703
|
+
#
|
|
704
|
+
# Language-specific TTS and transcription settings for Conversation Relay.
|
|
705
|
+
#
|
|
706
|
+
# @param language [String] BCP 47 language tag for this language configuration.
|
|
707
|
+
#
|
|
708
|
+
# @param speech_model [String] Conversation Relay speech model. Prefer `transcription_engine_config.transcripti
|
|
709
|
+
#
|
|
710
|
+
# @param transcription_engine [Symbol, Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
711
|
+
#
|
|
712
|
+
# @param transcription_engine_config [Hash{Symbol=>Object}] Engine-specific transcription settings for Conversation Relay. This accepts the
|
|
713
|
+
#
|
|
714
|
+
# @param transcription_provider [String] Conversation Relay transcription provider name. Prefer `transcription_engine` wh
|
|
715
|
+
#
|
|
716
|
+
# @param tts_provider [String] Text-to-speech provider for this language. If omitted and `voice` is provided, T
|
|
717
|
+
#
|
|
718
|
+
# @param voice [String] Voice identifier for this language.
|
|
719
|
+
#
|
|
720
|
+
# @param 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::Calls::ActionAnswerParams::ConversationRelayConfig::Language::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
721
|
+
|
|
722
|
+
# Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
|
|
723
|
+
# `Telnyx` are supported for backward compatibility. When provided in a
|
|
724
|
+
# Conversation Relay language entry, Telnyx derives `transcription_provider` and
|
|
725
|
+
# `speech_model` for that language.
|
|
726
|
+
#
|
|
727
|
+
# @see Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language#transcription_engine
|
|
728
|
+
module TranscriptionEngine
|
|
729
|
+
extend Telnyx::Internal::Type::Enum
|
|
730
|
+
|
|
731
|
+
GOOGLE = :Google
|
|
732
|
+
TELNYX = :Telnyx
|
|
733
|
+
DEEPGRAM = :Deepgram
|
|
734
|
+
AZURE = :Azure
|
|
735
|
+
X_AI = :xAI
|
|
736
|
+
ASSEMBLY_AI = :AssemblyAI
|
|
737
|
+
SPEECHMATICS = :Speechmatics
|
|
738
|
+
SONIOX = :Soniox
|
|
739
|
+
A = :A
|
|
740
|
+
B = :B
|
|
741
|
+
|
|
742
|
+
# @!method self.values
|
|
743
|
+
# @return [Array<Symbol>]
|
|
744
|
+
end
|
|
745
|
+
|
|
746
|
+
# The settings associated with the voice selected
|
|
747
|
+
#
|
|
748
|
+
# @see Telnyx::Models::Calls::ActionAnswerParams::ConversationRelayConfig::Language#voice_settings
|
|
749
|
+
module VoiceSettings
|
|
750
|
+
extend Telnyx::Internal::Type::Union
|
|
751
|
+
|
|
752
|
+
discriminator :type
|
|
753
|
+
|
|
754
|
+
variant :elevenlabs, -> { Telnyx::Calls::ElevenLabsVoiceSettings }
|
|
755
|
+
|
|
756
|
+
variant :telnyx, -> { Telnyx::Calls::TelnyxVoiceSettings }
|
|
757
|
+
|
|
758
|
+
variant :aws, -> { Telnyx::Calls::AwsVoiceSettings }
|
|
759
|
+
|
|
760
|
+
variant :minimax, -> { Telnyx::MinimaxVoiceSettings }
|
|
761
|
+
|
|
762
|
+
variant :azure, -> { Telnyx::AzureVoiceSettings }
|
|
763
|
+
|
|
764
|
+
variant :rime, -> { Telnyx::RimeVoiceSettings }
|
|
765
|
+
|
|
766
|
+
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
767
|
+
|
|
768
|
+
variant :inworld,
|
|
769
|
+
-> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::Language::VoiceSettings::Inworld }
|
|
770
|
+
|
|
771
|
+
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
772
|
+
|
|
773
|
+
class Inworld < Telnyx::Internal::Type::BaseModel
|
|
774
|
+
# @!attribute type
|
|
775
|
+
# Voice settings provider type
|
|
776
|
+
#
|
|
777
|
+
# @return [Symbol, :inworld]
|
|
778
|
+
required :type, const: :inworld
|
|
779
|
+
|
|
780
|
+
# @!method initialize(type: :inworld)
|
|
781
|
+
# @param type [Symbol, :inworld] Voice settings provider type
|
|
782
|
+
end
|
|
783
|
+
|
|
784
|
+
# @!method self.variants
|
|
785
|
+
# @return [Array(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::Calls::ActionAnswerParams::ConversationRelayConfig::Language::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
|
|
786
|
+
end
|
|
787
|
+
end
|
|
788
|
+
|
|
533
789
|
# Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
|
|
534
790
|
# `Telnyx` are supported for backward compatibility. For Conversation Relay, use
|
|
535
791
|
# this field with `transcription_engine_config`; the `transcription` object is not
|
|
@@ -576,12 +832,24 @@ module Telnyx
|
|
|
576
832
|
|
|
577
833
|
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
578
834
|
|
|
579
|
-
variant :inworld,
|
|
835
|
+
variant :inworld,
|
|
836
|
+
-> { Telnyx::Calls::ActionAnswerParams::ConversationRelayConfig::VoiceSettings::Inworld }
|
|
580
837
|
|
|
581
838
|
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
582
839
|
|
|
840
|
+
class Inworld < Telnyx::Internal::Type::BaseModel
|
|
841
|
+
# @!attribute type
|
|
842
|
+
# Voice settings provider type
|
|
843
|
+
#
|
|
844
|
+
# @return [Symbol, :inworld]
|
|
845
|
+
required :type, const: :inworld
|
|
846
|
+
|
|
847
|
+
# @!method initialize(type: :inworld)
|
|
848
|
+
# @param type [Symbol, :inworld] Voice settings provider type
|
|
849
|
+
end
|
|
850
|
+
|
|
583
851
|
# @!method self.variants
|
|
584
|
-
# @return [Array(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::
|
|
852
|
+
# @return [Array(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::Calls::ActionAnswerParams::ConversationRelayConfig::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
|
|
585
853
|
end
|
|
586
854
|
end
|
|
587
855
|
|
|
@@ -160,7 +160,7 @@ module Telnyx
|
|
|
160
160
|
# @!attribute voice_settings
|
|
161
161
|
# The settings associated with the voice selected
|
|
162
162
|
#
|
|
163
|
-
# @return [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::
|
|
163
|
+
# @return [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::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
|
|
164
164
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings }
|
|
165
165
|
|
|
166
166
|
# @!method initialize(call_control_id:, payload:, voice:, client_state: nil, command_id: nil, inter_digit_timeout_millis: nil, invalid_payload: nil, language: nil, maximum_digits: nil, maximum_tries: nil, minimum_digits: nil, payload_type: nil, service_level: nil, terminating_digit: nil, timeout_millis: nil, valid_digits: nil, voice_settings: nil, request_options: {})
|
|
@@ -200,7 +200,7 @@ module Telnyx
|
|
|
200
200
|
#
|
|
201
201
|
# @param valid_digits [String] A list of all digits accepted as valid.
|
|
202
202
|
#
|
|
203
|
-
# @param 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::
|
|
203
|
+
# @param 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::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
204
204
|
#
|
|
205
205
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
206
206
|
|
|
@@ -287,12 +287,23 @@ module Telnyx
|
|
|
287
287
|
|
|
288
288
|
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
289
289
|
|
|
290
|
-
variant :inworld, -> { Telnyx::
|
|
290
|
+
variant :inworld, -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld }
|
|
291
291
|
|
|
292
292
|
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
293
293
|
|
|
294
|
+
class Inworld < Telnyx::Internal::Type::BaseModel
|
|
295
|
+
# @!attribute type
|
|
296
|
+
# Voice settings provider type
|
|
297
|
+
#
|
|
298
|
+
# @return [Symbol, :inworld]
|
|
299
|
+
required :type, const: :inworld
|
|
300
|
+
|
|
301
|
+
# @!method initialize(type: :inworld)
|
|
302
|
+
# @param type [Symbol, :inworld] Voice settings provider type
|
|
303
|
+
end
|
|
304
|
+
|
|
294
305
|
# @!method self.variants
|
|
295
|
-
# @return [Array(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::
|
|
306
|
+
# @return [Array(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::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
|
|
296
307
|
end
|
|
297
308
|
end
|
|
298
309
|
end
|
|
@@ -128,7 +128,7 @@ module Telnyx
|
|
|
128
128
|
# @!attribute voice_settings
|
|
129
129
|
# The settings associated with the voice selected
|
|
130
130
|
#
|
|
131
|
-
# @return [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::
|
|
131
|
+
# @return [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::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
|
|
132
132
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionSpeakParams::VoiceSettings }
|
|
133
133
|
|
|
134
134
|
# @!method initialize(call_control_id:, payload:, voice:, client_state: nil, command_id: nil, language: nil, loop_: nil, payload_type: nil, service_level: nil, stop: nil, target_legs: nil, voice_settings: nil, request_options: {})
|
|
@@ -157,7 +157,7 @@ module Telnyx
|
|
|
157
157
|
#
|
|
158
158
|
# @param target_legs [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs] Specifies which legs of the call should receive the spoken audio.
|
|
159
159
|
#
|
|
160
|
-
# @param 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::
|
|
160
|
+
# @param 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::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
161
161
|
#
|
|
162
162
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
163
163
|
|
|
@@ -256,12 +256,23 @@ module Telnyx
|
|
|
256
256
|
|
|
257
257
|
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
258
258
|
|
|
259
|
-
variant :inworld, -> { Telnyx::
|
|
259
|
+
variant :inworld, -> { Telnyx::Calls::ActionSpeakParams::VoiceSettings::Inworld }
|
|
260
260
|
|
|
261
261
|
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
262
262
|
|
|
263
|
+
class Inworld < Telnyx::Internal::Type::BaseModel
|
|
264
|
+
# @!attribute type
|
|
265
|
+
# Voice settings provider type
|
|
266
|
+
#
|
|
267
|
+
# @return [Symbol, :inworld]
|
|
268
|
+
required :type, const: :inworld
|
|
269
|
+
|
|
270
|
+
# @!method initialize(type: :inworld)
|
|
271
|
+
# @param type [Symbol, :inworld] Voice settings provider type
|
|
272
|
+
end
|
|
273
|
+
|
|
263
274
|
# @!method self.variants
|
|
264
|
-
# @return [Array(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::
|
|
275
|
+
# @return [Array(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::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
|
|
265
276
|
end
|
|
266
277
|
end
|
|
267
278
|
end
|