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
|
@@ -1,100 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module Calls
|
|
6
|
-
class TranscriptionEngineSpeechmaticsConfig < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute interim_results
|
|
8
|
-
# Whether to send also interim results. If set to false, only final results will
|
|
9
|
-
# be sent.
|
|
10
|
-
#
|
|
11
|
-
# @return [Boolean, nil]
|
|
12
|
-
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
13
|
-
|
|
14
|
-
# @!attribute language
|
|
15
|
-
# Language to use for speech recognition
|
|
16
|
-
#
|
|
17
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::Language, nil]
|
|
18
|
-
optional :language, enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language }
|
|
19
|
-
|
|
20
|
-
# @!attribute transcription_engine
|
|
21
|
-
# Engine identifier for Speechmatics transcription service
|
|
22
|
-
#
|
|
23
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine, nil]
|
|
24
|
-
optional :transcription_engine,
|
|
25
|
-
enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine }
|
|
26
|
-
|
|
27
|
-
# @!attribute transcription_model
|
|
28
|
-
# The model to use for transcription.
|
|
29
|
-
#
|
|
30
|
-
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel, nil]
|
|
31
|
-
optional :transcription_model,
|
|
32
|
-
enum: -> { Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel }
|
|
33
|
-
|
|
34
|
-
# @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
|
|
35
|
-
# Some parameter documentations has been truncated, see
|
|
36
|
-
# {Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig} for more details.
|
|
37
|
-
#
|
|
38
|
-
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
39
|
-
#
|
|
40
|
-
# @param language [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::Language] Language to use for speech recognition
|
|
41
|
-
#
|
|
42
|
-
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine] Engine identifier for Speechmatics transcription service
|
|
43
|
-
#
|
|
44
|
-
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel] The model to use for transcription.
|
|
45
|
-
|
|
46
|
-
# Language to use for speech recognition
|
|
47
|
-
#
|
|
48
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#language
|
|
49
|
-
module Language
|
|
50
|
-
extend Telnyx::Internal::Type::Enum
|
|
51
|
-
|
|
52
|
-
EN = :en
|
|
53
|
-
BA = :ba
|
|
54
|
-
EU = :eu
|
|
55
|
-
GL = :gl
|
|
56
|
-
GA = :ga
|
|
57
|
-
MT = :mt
|
|
58
|
-
MN = :mn
|
|
59
|
-
SW = :sw
|
|
60
|
-
UG = :ug
|
|
61
|
-
CY = :cy
|
|
62
|
-
AR_EN = :ar_en
|
|
63
|
-
CMN_EN = :cmn_en
|
|
64
|
-
EN_MS = :en_ms
|
|
65
|
-
EN_TA = :en_ta
|
|
66
|
-
TL = :tl
|
|
67
|
-
ES_BILINGUAL_EN = :"es-bilingual-en"
|
|
68
|
-
CMN_EN_MS_TA = :cmn_en_ms_ta
|
|
69
|
-
|
|
70
|
-
# @!method self.values
|
|
71
|
-
# @return [Array<Symbol>]
|
|
72
|
-
end
|
|
73
|
-
|
|
74
|
-
# Engine identifier for Speechmatics transcription service
|
|
75
|
-
#
|
|
76
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#transcription_engine
|
|
77
|
-
module TranscriptionEngine
|
|
78
|
-
extend Telnyx::Internal::Type::Enum
|
|
79
|
-
|
|
80
|
-
SPEECHMATICS = :Speechmatics
|
|
81
|
-
|
|
82
|
-
# @!method self.values
|
|
83
|
-
# @return [Array<Symbol>]
|
|
84
|
-
end
|
|
85
|
-
|
|
86
|
-
# The model to use for transcription.
|
|
87
|
-
#
|
|
88
|
-
# @see Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig#transcription_model
|
|
89
|
-
module TranscriptionModel
|
|
90
|
-
extend Telnyx::Internal::Type::Enum
|
|
91
|
-
|
|
92
|
-
SPEECHMATICS_STANDARD = :"speechmatics/standard"
|
|
93
|
-
|
|
94
|
-
# @!method self.values
|
|
95
|
-
# @return [Array<Symbol>]
|
|
96
|
-
end
|
|
97
|
-
end
|
|
98
|
-
end
|
|
99
|
-
end
|
|
100
|
-
end
|
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
class ConversationRelayInterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute enable
|
|
7
|
-
# Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is
|
|
8
|
-
# equivalent to `interruptible=none`.
|
|
9
|
-
#
|
|
10
|
-
# @return [Boolean, nil]
|
|
11
|
-
optional :enable, Telnyx::Internal::Type::Boolean
|
|
12
|
-
|
|
13
|
-
# @!attribute interruptible
|
|
14
|
-
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
15
|
-
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
16
|
-
# only; `dtmf` allows DTMF only.
|
|
17
|
-
#
|
|
18
|
-
# @return [Symbol, Telnyx::Models::ConversationRelayInterruptionSettings::Interruptible, nil]
|
|
19
|
-
optional :interruptible, enum: -> { Telnyx::ConversationRelayInterruptionSettings::Interruptible }
|
|
20
|
-
|
|
21
|
-
# @!attribute interruptible_greeting
|
|
22
|
-
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
23
|
-
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
24
|
-
# only; `dtmf` allows DTMF only.
|
|
25
|
-
#
|
|
26
|
-
# @return [Symbol, Telnyx::Models::ConversationRelayInterruptionSettings::InterruptibleGreeting, nil]
|
|
27
|
-
optional :interruptible_greeting,
|
|
28
|
-
enum: -> { Telnyx::ConversationRelayInterruptionSettings::InterruptibleGreeting }
|
|
29
|
-
|
|
30
|
-
# @!attribute welcome_greeting_interruptible
|
|
31
|
-
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
32
|
-
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
33
|
-
# only; `dtmf` allows DTMF only.
|
|
34
|
-
#
|
|
35
|
-
# @return [Symbol, Telnyx::Models::ConversationRelayInterruptionSettings::WelcomeGreetingInterruptible, nil]
|
|
36
|
-
optional :welcome_greeting_interruptible,
|
|
37
|
-
enum: -> { Telnyx::ConversationRelayInterruptionSettings::WelcomeGreetingInterruptible }
|
|
38
|
-
|
|
39
|
-
# @!method initialize(enable: nil, interruptible: nil, interruptible_greeting: nil, welcome_greeting_interruptible: nil)
|
|
40
|
-
# Some parameter documentations has been truncated, see
|
|
41
|
-
# {Telnyx::Models::ConversationRelayInterruptionSettings} for more details.
|
|
42
|
-
#
|
|
43
|
-
# Settings for handling caller interruptions during Conversation Relay speech.
|
|
44
|
-
#
|
|
45
|
-
# @param enable [Boolean] Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is equ
|
|
46
|
-
#
|
|
47
|
-
# @param interruptible [Symbol, Telnyx::Models::ConversationRelayInterruptionSettings::Interruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
48
|
-
#
|
|
49
|
-
# @param interruptible_greeting [Symbol, Telnyx::Models::ConversationRelayInterruptionSettings::InterruptibleGreeting] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
50
|
-
#
|
|
51
|
-
# @param welcome_greeting_interruptible [Symbol, Telnyx::Models::ConversationRelayInterruptionSettings::WelcomeGreetingInterruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
52
|
-
|
|
53
|
-
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
54
|
-
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
55
|
-
# only; `dtmf` allows DTMF only.
|
|
56
|
-
#
|
|
57
|
-
# @see Telnyx::Models::ConversationRelayInterruptionSettings#interruptible
|
|
58
|
-
module Interruptible
|
|
59
|
-
extend Telnyx::Internal::Type::Enum
|
|
60
|
-
|
|
61
|
-
NONE = :none
|
|
62
|
-
ANY = :any
|
|
63
|
-
SPEECH = :speech
|
|
64
|
-
DTMF = :dtmf
|
|
65
|
-
|
|
66
|
-
# @!method self.values
|
|
67
|
-
# @return [Array<Symbol>]
|
|
68
|
-
end
|
|
69
|
-
|
|
70
|
-
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
71
|
-
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
72
|
-
# only; `dtmf` allows DTMF only.
|
|
73
|
-
#
|
|
74
|
-
# @see Telnyx::Models::ConversationRelayInterruptionSettings#interruptible_greeting
|
|
75
|
-
module InterruptibleGreeting
|
|
76
|
-
extend Telnyx::Internal::Type::Enum
|
|
77
|
-
|
|
78
|
-
NONE = :none
|
|
79
|
-
ANY = :any
|
|
80
|
-
SPEECH = :speech
|
|
81
|
-
DTMF = :dtmf
|
|
82
|
-
|
|
83
|
-
# @!method self.values
|
|
84
|
-
# @return [Array<Symbol>]
|
|
85
|
-
end
|
|
86
|
-
|
|
87
|
-
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
88
|
-
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
89
|
-
# only; `dtmf` allows DTMF only.
|
|
90
|
-
#
|
|
91
|
-
# @see Telnyx::Models::ConversationRelayInterruptionSettings#welcome_greeting_interruptible
|
|
92
|
-
module WelcomeGreetingInterruptible
|
|
93
|
-
extend Telnyx::Internal::Type::Enum
|
|
94
|
-
|
|
95
|
-
NONE = :none
|
|
96
|
-
ANY = :any
|
|
97
|
-
SPEECH = :speech
|
|
98
|
-
DTMF = :dtmf
|
|
99
|
-
|
|
100
|
-
# @!method self.values
|
|
101
|
-
# @return [Array<Symbol>]
|
|
102
|
-
end
|
|
103
|
-
end
|
|
104
|
-
end
|
|
105
|
-
end
|
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
class ConversationRelayLanguage < Telnyx::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute language
|
|
7
|
-
# BCP 47 language tag for this language configuration.
|
|
8
|
-
#
|
|
9
|
-
# @return [String]
|
|
10
|
-
required :language, String
|
|
11
|
-
|
|
12
|
-
# @!attribute speech_model
|
|
13
|
-
# Conversation Relay speech model. Prefer
|
|
14
|
-
# `transcription_engine_config.transcription_model` when configuring
|
|
15
|
-
# speech-to-text.
|
|
16
|
-
#
|
|
17
|
-
# @return [String, nil]
|
|
18
|
-
optional :speech_model, String
|
|
19
|
-
|
|
20
|
-
# @!attribute transcription_engine
|
|
21
|
-
# Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
|
|
22
|
-
# `Telnyx` are supported for backward compatibility. When provided in a
|
|
23
|
-
# Conversation Relay language entry, Telnyx derives `transcription_provider` and
|
|
24
|
-
# `speech_model` for that language.
|
|
25
|
-
#
|
|
26
|
-
# @return [Symbol, Telnyx::Models::ConversationRelayLanguage::TranscriptionEngine, nil]
|
|
27
|
-
optional :transcription_engine, enum: -> { Telnyx::ConversationRelayLanguage::TranscriptionEngine }
|
|
28
|
-
|
|
29
|
-
# @!attribute transcription_engine_config
|
|
30
|
-
# Engine-specific transcription settings for Conversation Relay. This accepts the
|
|
31
|
-
# same provider-specific options used by the Call Transcription Start command,
|
|
32
|
-
# such as `transcription_model`, without requiring the engine discriminator to be
|
|
33
|
-
# repeated inside this object.
|
|
34
|
-
#
|
|
35
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
36
|
-
optional :transcription_engine_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
37
|
-
|
|
38
|
-
# @!attribute transcription_provider
|
|
39
|
-
# Conversation Relay transcription provider name. Prefer `transcription_engine`
|
|
40
|
-
# when configuring speech-to-text.
|
|
41
|
-
#
|
|
42
|
-
# @return [String, nil]
|
|
43
|
-
optional :transcription_provider, String
|
|
44
|
-
|
|
45
|
-
# @!attribute tts_provider
|
|
46
|
-
# Text-to-speech provider for this language. If omitted and `voice` is provided,
|
|
47
|
-
# Telnyx derives the provider from the voice identifier.
|
|
48
|
-
#
|
|
49
|
-
# @return [String, nil]
|
|
50
|
-
optional :tts_provider, String
|
|
51
|
-
|
|
52
|
-
# @!attribute voice
|
|
53
|
-
# Voice identifier for this language.
|
|
54
|
-
#
|
|
55
|
-
# @return [String, nil]
|
|
56
|
-
optional :voice, String
|
|
57
|
-
|
|
58
|
-
# @!attribute voice_settings
|
|
59
|
-
# The settings associated with the voice selected
|
|
60
|
-
#
|
|
61
|
-
# @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::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
|
|
62
|
-
optional :voice_settings, union: -> { Telnyx::ConversationRelayLanguage::VoiceSettings }
|
|
63
|
-
|
|
64
|
-
# @!method initialize(language:, speech_model: nil, transcription_engine: nil, transcription_engine_config: nil, transcription_provider: nil, tts_provider: nil, voice: nil, voice_settings: nil)
|
|
65
|
-
# Some parameter documentations has been truncated, see
|
|
66
|
-
# {Telnyx::Models::ConversationRelayLanguage} for more details.
|
|
67
|
-
#
|
|
68
|
-
# Language-specific TTS and transcription settings for Conversation Relay.
|
|
69
|
-
#
|
|
70
|
-
# @param language [String] BCP 47 language tag for this language configuration.
|
|
71
|
-
#
|
|
72
|
-
# @param speech_model [String] Conversation Relay speech model. Prefer `transcription_engine_config.transcripti
|
|
73
|
-
#
|
|
74
|
-
# @param transcription_engine [Symbol, Telnyx::Models::ConversationRelayLanguage::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
75
|
-
#
|
|
76
|
-
# @param transcription_engine_config [Hash{Symbol=>Object}] Engine-specific transcription settings for Conversation Relay. This accepts the
|
|
77
|
-
#
|
|
78
|
-
# @param transcription_provider [String] Conversation Relay transcription provider name. Prefer `transcription_engine` wh
|
|
79
|
-
#
|
|
80
|
-
# @param tts_provider [String] Text-to-speech provider for this language. If omitted and `voice` is provided, T
|
|
81
|
-
#
|
|
82
|
-
# @param voice [String] Voice identifier for this language.
|
|
83
|
-
#
|
|
84
|
-
# @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::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
85
|
-
|
|
86
|
-
# Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
|
|
87
|
-
# `Telnyx` are supported for backward compatibility. When provided in a
|
|
88
|
-
# Conversation Relay language entry, Telnyx derives `transcription_provider` and
|
|
89
|
-
# `speech_model` for that language.
|
|
90
|
-
#
|
|
91
|
-
# @see Telnyx::Models::ConversationRelayLanguage#transcription_engine
|
|
92
|
-
module TranscriptionEngine
|
|
93
|
-
extend Telnyx::Internal::Type::Enum
|
|
94
|
-
|
|
95
|
-
GOOGLE = :Google
|
|
96
|
-
TELNYX = :Telnyx
|
|
97
|
-
DEEPGRAM = :Deepgram
|
|
98
|
-
AZURE = :Azure
|
|
99
|
-
X_AI = :xAI
|
|
100
|
-
ASSEMBLY_AI = :AssemblyAI
|
|
101
|
-
SPEECHMATICS = :Speechmatics
|
|
102
|
-
SONIOX = :Soniox
|
|
103
|
-
A = :A
|
|
104
|
-
B = :B
|
|
105
|
-
|
|
106
|
-
# @!method self.values
|
|
107
|
-
# @return [Array<Symbol>]
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
# The settings associated with the voice selected
|
|
111
|
-
#
|
|
112
|
-
# @see Telnyx::Models::ConversationRelayLanguage#voice_settings
|
|
113
|
-
module VoiceSettings
|
|
114
|
-
extend Telnyx::Internal::Type::Union
|
|
115
|
-
|
|
116
|
-
discriminator :type
|
|
117
|
-
|
|
118
|
-
variant :elevenlabs, -> { Telnyx::Calls::ElevenLabsVoiceSettings }
|
|
119
|
-
|
|
120
|
-
variant :telnyx, -> { Telnyx::Calls::TelnyxVoiceSettings }
|
|
121
|
-
|
|
122
|
-
variant :aws, -> { Telnyx::Calls::AwsVoiceSettings }
|
|
123
|
-
|
|
124
|
-
variant :minimax, -> { Telnyx::MinimaxVoiceSettings }
|
|
125
|
-
|
|
126
|
-
variant :azure, -> { Telnyx::AzureVoiceSettings }
|
|
127
|
-
|
|
128
|
-
variant :rime, -> { Telnyx::RimeVoiceSettings }
|
|
129
|
-
|
|
130
|
-
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
131
|
-
|
|
132
|
-
variant :inworld, -> { Telnyx::InworldVoiceSettings }
|
|
133
|
-
|
|
134
|
-
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
135
|
-
|
|
136
|
-
# @!method self.variants
|
|
137
|
-
# @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::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
|
|
138
|
-
end
|
|
139
|
-
end
|
|
140
|
-
end
|
|
141
|
-
end
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
class InworldVoiceSettings < Telnyx::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute type
|
|
7
|
-
# Voice settings provider type
|
|
8
|
-
#
|
|
9
|
-
# @return [Symbol, Telnyx::Models::InworldVoiceSettings::Type]
|
|
10
|
-
required :type, enum: -> { Telnyx::InworldVoiceSettings::Type }
|
|
11
|
-
|
|
12
|
-
# @!method initialize(type:)
|
|
13
|
-
# @param type [Symbol, Telnyx::Models::InworldVoiceSettings::Type] Voice settings provider type
|
|
14
|
-
|
|
15
|
-
# Voice settings provider type
|
|
16
|
-
#
|
|
17
|
-
# @see Telnyx::Models::InworldVoiceSettings#type
|
|
18
|
-
module Type
|
|
19
|
-
extend Telnyx::Internal::Type::Enum
|
|
20
|
-
|
|
21
|
-
INWORLD = :inworld
|
|
22
|
-
|
|
23
|
-
# @!method self.values
|
|
24
|
-
# @return [Array<Symbol>]
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
class VoiceSDKCallReportLogEntry < Telnyx::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute context
|
|
7
|
-
# Raw structured context attached to the log entry.
|
|
8
|
-
#
|
|
9
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
10
|
-
optional :context, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
11
|
-
|
|
12
|
-
# @!attribute level
|
|
13
|
-
# Log level emitted by the SDK.
|
|
14
|
-
#
|
|
15
|
-
# @return [Symbol, Telnyx::Models::VoiceSDKCallReportLogEntry::Level, nil]
|
|
16
|
-
optional :level, enum: -> { Telnyx::VoiceSDKCallReportLogEntry::Level }
|
|
17
|
-
|
|
18
|
-
# @!attribute message
|
|
19
|
-
# Log message.
|
|
20
|
-
#
|
|
21
|
-
# @return [String, nil]
|
|
22
|
-
optional :message, String
|
|
23
|
-
|
|
24
|
-
# @!attribute timestamp
|
|
25
|
-
# Time when the log entry was emitted.
|
|
26
|
-
#
|
|
27
|
-
# @return [Time, nil]
|
|
28
|
-
optional :timestamp, Time
|
|
29
|
-
|
|
30
|
-
# @!method initialize(context: nil, level: nil, message: nil, timestamp: nil)
|
|
31
|
-
# A raw Voice SDK log entry. Additional SDK-specific fields may be present.
|
|
32
|
-
#
|
|
33
|
-
# @param context [Hash{Symbol=>Object}] Raw structured context attached to the log entry.
|
|
34
|
-
#
|
|
35
|
-
# @param level [Symbol, Telnyx::Models::VoiceSDKCallReportLogEntry::Level] Log level emitted by the SDK.
|
|
36
|
-
#
|
|
37
|
-
# @param message [String] Log message.
|
|
38
|
-
#
|
|
39
|
-
# @param timestamp [Time] Time when the log entry was emitted.
|
|
40
|
-
|
|
41
|
-
# Log level emitted by the SDK.
|
|
42
|
-
#
|
|
43
|
-
# @see Telnyx::Models::VoiceSDKCallReportLogEntry#level
|
|
44
|
-
module Level
|
|
45
|
-
extend Telnyx::Internal::Type::Enum
|
|
46
|
-
|
|
47
|
-
DEBUG = :debug
|
|
48
|
-
INFO = :info
|
|
49
|
-
WARN = :warn
|
|
50
|
-
ERROR = :error
|
|
51
|
-
|
|
52
|
-
# @!method self.values
|
|
53
|
-
# @return [Array<Symbol>]
|
|
54
|
-
end
|
|
55
|
-
end
|
|
56
|
-
end
|
|
57
|
-
end
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module Whatsapp
|
|
6
|
-
class WhatsappUserData < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute created_at
|
|
8
|
-
#
|
|
9
|
-
# @return [Time, nil]
|
|
10
|
-
optional :created_at, Time
|
|
11
|
-
|
|
12
|
-
# @!attribute record_type
|
|
13
|
-
#
|
|
14
|
-
# @return [String, nil]
|
|
15
|
-
optional :record_type, String
|
|
16
|
-
|
|
17
|
-
# @!attribute updated_at
|
|
18
|
-
#
|
|
19
|
-
# @return [Time, nil]
|
|
20
|
-
optional :updated_at, Time
|
|
21
|
-
|
|
22
|
-
# @!attribute webhook_failover_url
|
|
23
|
-
# Failover URL to receive Whatsapp signup events
|
|
24
|
-
#
|
|
25
|
-
# @return [String, nil]
|
|
26
|
-
optional :webhook_failover_url, String
|
|
27
|
-
|
|
28
|
-
# @!attribute webhook_url
|
|
29
|
-
# URL to receive Whatsapp signup events
|
|
30
|
-
#
|
|
31
|
-
# @return [String, nil]
|
|
32
|
-
optional :webhook_url, String
|
|
33
|
-
|
|
34
|
-
# @!method initialize(created_at: nil, record_type: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
35
|
-
# @param created_at [Time]
|
|
36
|
-
#
|
|
37
|
-
# @param record_type [String]
|
|
38
|
-
#
|
|
39
|
-
# @param updated_at [Time]
|
|
40
|
-
#
|
|
41
|
-
# @param webhook_failover_url [String] Failover URL to receive Whatsapp signup events
|
|
42
|
-
#
|
|
43
|
-
# @param webhook_url [String] URL to receive Whatsapp signup events
|
|
44
|
-
end
|
|
45
|
-
end
|
|
46
|
-
|
|
47
|
-
WhatsappUserData = Whatsapp::WhatsappUserData
|
|
48
|
-
end
|
|
49
|
-
end
|
|
@@ -1,184 +0,0 @@
|
|
|
1
|
-
# typed: strong
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module Calls
|
|
6
|
-
class TranscriptionEngineSonioxConfig < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
OrHash =
|
|
8
|
-
T.type_alias do
|
|
9
|
-
T.any(
|
|
10
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig,
|
|
11
|
-
Telnyx::Internal::AnyHash
|
|
12
|
-
)
|
|
13
|
-
end
|
|
14
|
-
|
|
15
|
-
# Engine identifier for Soniox transcription service
|
|
16
|
-
sig do
|
|
17
|
-
returns(
|
|
18
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionEngine::OrSymbol
|
|
19
|
-
)
|
|
20
|
-
end
|
|
21
|
-
attr_accessor :transcription_engine
|
|
22
|
-
|
|
23
|
-
# When true, Soniox emits end-of-utterance events at the cadence configured by
|
|
24
|
-
# `max_endpoint_delay_ms`.
|
|
25
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
26
|
-
attr_reader :enable_endpoint_detection
|
|
27
|
-
|
|
28
|
-
sig { params(enable_endpoint_detection: T::Boolean).void }
|
|
29
|
-
attr_writer :enable_endpoint_detection
|
|
30
|
-
|
|
31
|
-
# Whether to send also interim results. If set to false, only final results will
|
|
32
|
-
# be sent.
|
|
33
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
34
|
-
attr_reader :interim_results
|
|
35
|
-
|
|
36
|
-
sig { params(interim_results: T::Boolean).void }
|
|
37
|
-
attr_writer :interim_results
|
|
38
|
-
|
|
39
|
-
# ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let
|
|
40
|
-
# Soniox auto-detect supported languages multilingually.
|
|
41
|
-
sig { returns(T.nilable(String)) }
|
|
42
|
-
attr_reader :language
|
|
43
|
-
|
|
44
|
-
sig { params(language: String).void }
|
|
45
|
-
attr_writer :language
|
|
46
|
-
|
|
47
|
-
# Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
|
|
48
|
-
# Only honored when `enable_endpoint_detection` is true. Range: 500-3000 ms.
|
|
49
|
-
sig { returns(T.nilable(Integer)) }
|
|
50
|
-
attr_reader :max_endpoint_delay_ms
|
|
51
|
-
|
|
52
|
-
sig { params(max_endpoint_delay_ms: Integer).void }
|
|
53
|
-
attr_writer :max_endpoint_delay_ms
|
|
54
|
-
|
|
55
|
-
# The model to use for transcription.
|
|
56
|
-
sig do
|
|
57
|
-
returns(
|
|
58
|
-
T.nilable(
|
|
59
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionModel::OrSymbol
|
|
60
|
-
)
|
|
61
|
-
)
|
|
62
|
-
end
|
|
63
|
-
attr_reader :transcription_model
|
|
64
|
-
|
|
65
|
-
sig do
|
|
66
|
-
params(
|
|
67
|
-
transcription_model:
|
|
68
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionModel::OrSymbol
|
|
69
|
-
).void
|
|
70
|
-
end
|
|
71
|
-
attr_writer :transcription_model
|
|
72
|
-
|
|
73
|
-
sig do
|
|
74
|
-
params(
|
|
75
|
-
transcription_engine:
|
|
76
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionEngine::OrSymbol,
|
|
77
|
-
enable_endpoint_detection: T::Boolean,
|
|
78
|
-
interim_results: T::Boolean,
|
|
79
|
-
language: String,
|
|
80
|
-
max_endpoint_delay_ms: Integer,
|
|
81
|
-
transcription_model:
|
|
82
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionModel::OrSymbol
|
|
83
|
-
).returns(T.attached_class)
|
|
84
|
-
end
|
|
85
|
-
def self.new(
|
|
86
|
-
# Engine identifier for Soniox transcription service
|
|
87
|
-
transcription_engine:,
|
|
88
|
-
# When true, Soniox emits end-of-utterance events at the cadence configured by
|
|
89
|
-
# `max_endpoint_delay_ms`.
|
|
90
|
-
enable_endpoint_detection: nil,
|
|
91
|
-
# Whether to send also interim results. If set to false, only final results will
|
|
92
|
-
# be sent.
|
|
93
|
-
interim_results: nil,
|
|
94
|
-
# ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let
|
|
95
|
-
# Soniox auto-detect supported languages multilingually.
|
|
96
|
-
language: nil,
|
|
97
|
-
# Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
|
|
98
|
-
# Only honored when `enable_endpoint_detection` is true. Range: 500-3000 ms.
|
|
99
|
-
max_endpoint_delay_ms: nil,
|
|
100
|
-
# The model to use for transcription.
|
|
101
|
-
transcription_model: nil
|
|
102
|
-
)
|
|
103
|
-
end
|
|
104
|
-
|
|
105
|
-
sig do
|
|
106
|
-
override.returns(
|
|
107
|
-
{
|
|
108
|
-
transcription_engine:
|
|
109
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionEngine::OrSymbol,
|
|
110
|
-
enable_endpoint_detection: T::Boolean,
|
|
111
|
-
interim_results: T::Boolean,
|
|
112
|
-
language: String,
|
|
113
|
-
max_endpoint_delay_ms: Integer,
|
|
114
|
-
transcription_model:
|
|
115
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionModel::OrSymbol
|
|
116
|
-
}
|
|
117
|
-
)
|
|
118
|
-
end
|
|
119
|
-
def to_hash
|
|
120
|
-
end
|
|
121
|
-
|
|
122
|
-
# Engine identifier for Soniox transcription service
|
|
123
|
-
module TranscriptionEngine
|
|
124
|
-
extend Telnyx::Internal::Type::Enum
|
|
125
|
-
|
|
126
|
-
TaggedSymbol =
|
|
127
|
-
T.type_alias do
|
|
128
|
-
T.all(
|
|
129
|
-
Symbol,
|
|
130
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionEngine
|
|
131
|
-
)
|
|
132
|
-
end
|
|
133
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
134
|
-
|
|
135
|
-
SONIOX =
|
|
136
|
-
T.let(
|
|
137
|
-
:Soniox,
|
|
138
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionEngine::TaggedSymbol
|
|
139
|
-
)
|
|
140
|
-
|
|
141
|
-
sig do
|
|
142
|
-
override.returns(
|
|
143
|
-
T::Array[
|
|
144
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionEngine::TaggedSymbol
|
|
145
|
-
]
|
|
146
|
-
)
|
|
147
|
-
end
|
|
148
|
-
def self.values
|
|
149
|
-
end
|
|
150
|
-
end
|
|
151
|
-
|
|
152
|
-
# The model to use for transcription.
|
|
153
|
-
module TranscriptionModel
|
|
154
|
-
extend Telnyx::Internal::Type::Enum
|
|
155
|
-
|
|
156
|
-
TaggedSymbol =
|
|
157
|
-
T.type_alias do
|
|
158
|
-
T.all(
|
|
159
|
-
Symbol,
|
|
160
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionModel
|
|
161
|
-
)
|
|
162
|
-
end
|
|
163
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
164
|
-
|
|
165
|
-
SONIOX_STT_RT_V4 =
|
|
166
|
-
T.let(
|
|
167
|
-
:"soniox/stt-rt-v4",
|
|
168
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionModel::TaggedSymbol
|
|
169
|
-
)
|
|
170
|
-
|
|
171
|
-
sig do
|
|
172
|
-
override.returns(
|
|
173
|
-
T::Array[
|
|
174
|
-
Telnyx::Calls::TranscriptionEngineSonioxConfig::TranscriptionModel::TaggedSymbol
|
|
175
|
-
]
|
|
176
|
-
)
|
|
177
|
-
end
|
|
178
|
-
def self.values
|
|
179
|
-
end
|
|
180
|
-
end
|
|
181
|
-
end
|
|
182
|
-
end
|
|
183
|
-
end
|
|
184
|
-
end
|