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
|
@@ -27,7 +27,7 @@ module Telnyx
|
|
|
27
27
|
|
|
28
28
|
# @!attribute transcription_engine_config
|
|
29
29
|
#
|
|
30
|
-
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::
|
|
30
|
+
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
31
31
|
optional :transcription_engine_config,
|
|
32
32
|
union: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig }
|
|
33
33
|
|
|
@@ -49,7 +49,7 @@ module Telnyx
|
|
|
49
49
|
#
|
|
50
50
|
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
51
51
|
#
|
|
52
|
-
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::
|
|
52
|
+
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
53
53
|
#
|
|
54
54
|
# @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
|
|
55
55
|
|
|
@@ -91,9 +91,10 @@ module Telnyx
|
|
|
91
91
|
|
|
92
92
|
variant :AssemblyAI, -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig }
|
|
93
93
|
|
|
94
|
-
variant :Speechmatics,
|
|
94
|
+
variant :Speechmatics,
|
|
95
|
+
-> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics }
|
|
95
96
|
|
|
96
|
-
variant :Soniox, -> { Telnyx::Calls::
|
|
97
|
+
variant :Soniox, -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox }
|
|
97
98
|
|
|
98
99
|
variant :A, -> { Telnyx::Calls::TranscriptionEngineAConfig }
|
|
99
100
|
|
|
@@ -103,8 +104,175 @@ module Telnyx
|
|
|
103
104
|
|
|
104
105
|
variant :"deepgram/nova-3", -> { Telnyx::Calls::DeepgramNova3Config }
|
|
105
106
|
|
|
107
|
+
class Speechmatics < Telnyx::Internal::Type::BaseModel
|
|
108
|
+
# @!attribute interim_results
|
|
109
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
110
|
+
# be sent.
|
|
111
|
+
#
|
|
112
|
+
# @return [Boolean, nil]
|
|
113
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
114
|
+
|
|
115
|
+
# @!attribute language
|
|
116
|
+
# Language to use for speech recognition
|
|
117
|
+
#
|
|
118
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language, nil]
|
|
119
|
+
optional :language,
|
|
120
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language }
|
|
121
|
+
|
|
122
|
+
# @!attribute transcription_engine
|
|
123
|
+
# Engine identifier for Speechmatics transcription service
|
|
124
|
+
#
|
|
125
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine, nil]
|
|
126
|
+
optional :transcription_engine,
|
|
127
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine }
|
|
128
|
+
|
|
129
|
+
# @!attribute transcription_model
|
|
130
|
+
# The model to use for transcription.
|
|
131
|
+
#
|
|
132
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel, nil]
|
|
133
|
+
optional :transcription_model,
|
|
134
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel }
|
|
135
|
+
|
|
136
|
+
# @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
|
|
137
|
+
# Some parameter documentations has been truncated, see
|
|
138
|
+
# {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics}
|
|
139
|
+
# for more details.
|
|
140
|
+
#
|
|
141
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
142
|
+
#
|
|
143
|
+
# @param language [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::Language] Language to use for speech recognition
|
|
144
|
+
#
|
|
145
|
+
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionEngine] Engine identifier for Speechmatics transcription service
|
|
146
|
+
#
|
|
147
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics::TranscriptionModel] The model to use for transcription.
|
|
148
|
+
|
|
149
|
+
# Language to use for speech recognition
|
|
150
|
+
#
|
|
151
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics#language
|
|
152
|
+
module Language
|
|
153
|
+
extend Telnyx::Internal::Type::Enum
|
|
154
|
+
|
|
155
|
+
EN = :en
|
|
156
|
+
BA = :ba
|
|
157
|
+
EU = :eu
|
|
158
|
+
GL = :gl
|
|
159
|
+
GA = :ga
|
|
160
|
+
MT = :mt
|
|
161
|
+
MN = :mn
|
|
162
|
+
SW = :sw
|
|
163
|
+
UG = :ug
|
|
164
|
+
CY = :cy
|
|
165
|
+
AR_EN = :ar_en
|
|
166
|
+
CMN_EN = :cmn_en
|
|
167
|
+
EN_MS = :en_ms
|
|
168
|
+
EN_TA = :en_ta
|
|
169
|
+
TL = :tl
|
|
170
|
+
ES_BILINGUAL_EN = :"es-bilingual-en"
|
|
171
|
+
CMN_EN_MS_TA = :cmn_en_ms_ta
|
|
172
|
+
|
|
173
|
+
# @!method self.values
|
|
174
|
+
# @return [Array<Symbol>]
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Engine identifier for Speechmatics transcription service
|
|
178
|
+
#
|
|
179
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics#transcription_engine
|
|
180
|
+
module TranscriptionEngine
|
|
181
|
+
extend Telnyx::Internal::Type::Enum
|
|
182
|
+
|
|
183
|
+
SPEECHMATICS = :Speechmatics
|
|
184
|
+
|
|
185
|
+
# @!method self.values
|
|
186
|
+
# @return [Array<Symbol>]
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
# The model to use for transcription.
|
|
190
|
+
#
|
|
191
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics#transcription_model
|
|
192
|
+
module TranscriptionModel
|
|
193
|
+
extend Telnyx::Internal::Type::Enum
|
|
194
|
+
|
|
195
|
+
SPEECHMATICS_STANDARD = :"speechmatics/standard"
|
|
196
|
+
|
|
197
|
+
# @!method self.values
|
|
198
|
+
# @return [Array<Symbol>]
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
class Soniox < Telnyx::Internal::Type::BaseModel
|
|
203
|
+
# @!attribute transcription_engine
|
|
204
|
+
# Engine identifier for Soniox transcription service
|
|
205
|
+
#
|
|
206
|
+
# @return [Symbol, :Soniox]
|
|
207
|
+
required :transcription_engine, const: :Soniox
|
|
208
|
+
|
|
209
|
+
# @!attribute enable_endpoint_detection
|
|
210
|
+
# When true, Soniox emits end-of-utterance events at the cadence configured by
|
|
211
|
+
# `max_endpoint_delay_ms`.
|
|
212
|
+
#
|
|
213
|
+
# @return [Boolean, nil]
|
|
214
|
+
optional :enable_endpoint_detection, Telnyx::Internal::Type::Boolean
|
|
215
|
+
|
|
216
|
+
# @!attribute interim_results
|
|
217
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
218
|
+
# be sent.
|
|
219
|
+
#
|
|
220
|
+
# @return [Boolean, nil]
|
|
221
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
222
|
+
|
|
223
|
+
# @!attribute language
|
|
224
|
+
# ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let
|
|
225
|
+
# Soniox auto-detect supported languages multilingually.
|
|
226
|
+
#
|
|
227
|
+
# @return [String, nil]
|
|
228
|
+
optional :language, String
|
|
229
|
+
|
|
230
|
+
# @!attribute max_endpoint_delay_ms
|
|
231
|
+
# Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
|
|
232
|
+
# Only honored when `enable_endpoint_detection` is true. Range: 500-3000 ms.
|
|
233
|
+
#
|
|
234
|
+
# @return [Integer, nil]
|
|
235
|
+
optional :max_endpoint_delay_ms, Integer
|
|
236
|
+
|
|
237
|
+
# @!attribute transcription_model
|
|
238
|
+
# The model to use for transcription.
|
|
239
|
+
#
|
|
240
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel, nil]
|
|
241
|
+
optional :transcription_model,
|
|
242
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel }
|
|
243
|
+
|
|
244
|
+
# @!method initialize(enable_endpoint_detection: nil, interim_results: nil, language: nil, max_endpoint_delay_ms: nil, transcription_model: nil, transcription_engine: :Soniox)
|
|
245
|
+
# Some parameter documentations has been truncated, see
|
|
246
|
+
# {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox}
|
|
247
|
+
# for more details.
|
|
248
|
+
#
|
|
249
|
+
# @param enable_endpoint_detection [Boolean] When true, Soniox emits end-of-utterance events at the cadence configured by `ma
|
|
250
|
+
#
|
|
251
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
252
|
+
#
|
|
253
|
+
# @param language [String] ISO 639-1 language hint (e.g. `en`, `es`), or `auto` to omit the hint and let So
|
|
254
|
+
#
|
|
255
|
+
# @param max_endpoint_delay_ms [Integer] Maximum silence (in milliseconds) before Soniox emits an end-of-utterance event.
|
|
256
|
+
#
|
|
257
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox::TranscriptionModel] The model to use for transcription.
|
|
258
|
+
#
|
|
259
|
+
# @param transcription_engine [Symbol, :Soniox] Engine identifier for Soniox transcription service
|
|
260
|
+
|
|
261
|
+
# The model to use for transcription.
|
|
262
|
+
#
|
|
263
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox#transcription_model
|
|
264
|
+
module TranscriptionModel
|
|
265
|
+
extend Telnyx::Internal::Type::Enum
|
|
266
|
+
|
|
267
|
+
SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
|
|
268
|
+
|
|
269
|
+
# @!method self.values
|
|
270
|
+
# @return [Array<Symbol>]
|
|
271
|
+
end
|
|
272
|
+
end
|
|
273
|
+
|
|
106
274
|
# @!method self.variants
|
|
107
|
-
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::
|
|
275
|
+
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Speechmatics, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Soniox, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
108
276
|
end
|
|
109
277
|
end
|
|
110
278
|
end
|
|
@@ -107,7 +107,7 @@ module Telnyx
|
|
|
107
107
|
# @!attribute voice_settings
|
|
108
108
|
# The settings associated with the voice selected
|
|
109
109
|
#
|
|
110
|
-
# @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::
|
|
110
|
+
# @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::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
|
|
111
111
|
optional :voice_settings, union: -> { Telnyx::Conferences::ActionSpeakParams::VoiceSettings }
|
|
112
112
|
|
|
113
113
|
# @!method initialize(id:, payload:, voice:, call_control_ids: nil, command_id: nil, language: nil, payload_type: nil, region: nil, voice_settings: nil, request_options: {})
|
|
@@ -130,7 +130,7 @@ module Telnyx
|
|
|
130
130
|
#
|
|
131
131
|
# @param region [Symbol, Telnyx::Models::Conferences::ActionSpeakParams::Region] Region where the conference data is located. Defaults to the region defined in u
|
|
132
132
|
#
|
|
133
|
-
# @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::
|
|
133
|
+
# @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::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
134
134
|
#
|
|
135
135
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
136
136
|
|
|
@@ -219,12 +219,23 @@ module Telnyx
|
|
|
219
219
|
|
|
220
220
|
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
221
221
|
|
|
222
|
-
variant :inworld, -> { Telnyx::
|
|
222
|
+
variant :inworld, -> { Telnyx::Conferences::ActionSpeakParams::VoiceSettings::Inworld }
|
|
223
223
|
|
|
224
224
|
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
225
225
|
|
|
226
|
+
class Inworld < Telnyx::Internal::Type::BaseModel
|
|
227
|
+
# @!attribute type
|
|
228
|
+
# Voice settings provider type
|
|
229
|
+
#
|
|
230
|
+
# @return [Symbol, :inworld]
|
|
231
|
+
required :type, const: :inworld
|
|
232
|
+
|
|
233
|
+
# @!method initialize(type: :inworld)
|
|
234
|
+
# @param type [Symbol, :inworld] Voice settings provider type
|
|
235
|
+
end
|
|
236
|
+
|
|
226
237
|
# @!method self.variants
|
|
227
|
-
# @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::
|
|
238
|
+
# @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::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
|
|
228
239
|
end
|
|
229
240
|
end
|
|
230
241
|
end
|
|
@@ -12,6 +12,12 @@ module Telnyx
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :messaging_profile_id, String
|
|
14
14
|
|
|
15
|
+
# @!attribute ai_assistant_id
|
|
16
|
+
# The ID of the AI assistant associated with this messaging profile.
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :ai_assistant_id, String, nil?: true
|
|
20
|
+
|
|
15
21
|
# @!attribute alpha_sender
|
|
16
22
|
# The alphanumeric sender ID to use when sending to destinations that require an
|
|
17
23
|
# alphanumeric sender ID.
|
|
@@ -128,12 +134,14 @@ module Telnyx
|
|
|
128
134
|
# @return [Array<String>, nil]
|
|
129
135
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
130
136
|
|
|
131
|
-
# @!method initialize(messaging_profile_id:, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
|
|
137
|
+
# @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
|
|
132
138
|
# Some parameter documentations has been truncated, see
|
|
133
139
|
# {Telnyx::Models::MessagingProfileUpdateParams} for more details.
|
|
134
140
|
#
|
|
135
141
|
# @param messaging_profile_id [String]
|
|
136
142
|
#
|
|
143
|
+
# @param ai_assistant_id [String, nil] The ID of the AI assistant associated with this messaging profile.
|
|
144
|
+
#
|
|
137
145
|
# @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
|
|
138
146
|
#
|
|
139
147
|
# @param daily_spend_limit [String] The maximum amount of money (in USD) that can be spent by this profile before mi
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::SipRegistrationStatus#retrieve
|
|
6
|
+
class SipRegistrationStatusRetrieveParams < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute connection_id
|
|
11
|
+
# Identifier of the UAC connection to look up.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :connection_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute credential_type
|
|
17
|
+
# The kind of credential to look up. Only `uac_external_credential` is supported
|
|
18
|
+
# today.
|
|
19
|
+
#
|
|
20
|
+
# @return [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType]
|
|
21
|
+
required :credential_type, enum: -> { Telnyx::SipRegistrationStatusRetrieveParams::CredentialType }
|
|
22
|
+
|
|
23
|
+
# @!method initialize(connection_id:, credential_type:, request_options: {})
|
|
24
|
+
# Some parameter documentations has been truncated, see
|
|
25
|
+
# {Telnyx::Models::SipRegistrationStatusRetrieveParams} for more details.
|
|
26
|
+
#
|
|
27
|
+
# @param connection_id [String] Identifier of the UAC connection to look up.
|
|
28
|
+
#
|
|
29
|
+
# @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType] The kind of credential to look up. Only `uac_external_credential` is supported t
|
|
30
|
+
#
|
|
31
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
32
|
+
|
|
33
|
+
# The kind of credential to look up. Only `uac_external_credential` is supported
|
|
34
|
+
# today.
|
|
35
|
+
module CredentialType
|
|
36
|
+
extend Telnyx::Internal::Type::Enum
|
|
37
|
+
|
|
38
|
+
UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
|
|
39
|
+
|
|
40
|
+
# @!method self.values
|
|
41
|
+
# @return [Array<Symbol>]
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
# @see Telnyx::Resources::SipRegistrationStatus#retrieve
|
|
6
|
+
class SipRegistrationStatusRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute connection_id
|
|
8
|
+
# Identifier of the UAC connection.
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :connection_id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute connection_name
|
|
14
|
+
# Human-readable connection name.
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :connection_name, String
|
|
18
|
+
|
|
19
|
+
# @!attribute credential_type
|
|
20
|
+
# The credential type that was looked up.
|
|
21
|
+
#
|
|
22
|
+
# @return [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType, nil]
|
|
23
|
+
optional :credential_type,
|
|
24
|
+
enum: -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType }
|
|
25
|
+
|
|
26
|
+
# @!attribute credential_username
|
|
27
|
+
# SIP username used for the registration.
|
|
28
|
+
#
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :credential_username, String
|
|
31
|
+
|
|
32
|
+
# @!attribute last_registration_response
|
|
33
|
+
# SIP response from the last registration attempt.
|
|
34
|
+
#
|
|
35
|
+
# @return [String, nil]
|
|
36
|
+
optional :last_registration_response, String
|
|
37
|
+
|
|
38
|
+
# @!attribute registered
|
|
39
|
+
# True if the endpoint is currently registered.
|
|
40
|
+
#
|
|
41
|
+
# @return [Boolean, nil]
|
|
42
|
+
optional :registered, Telnyx::Internal::Type::Boolean
|
|
43
|
+
|
|
44
|
+
# @!attribute sip_registration_details
|
|
45
|
+
# Detailed registration information reported by the registrar.
|
|
46
|
+
#
|
|
47
|
+
# @return [Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails, nil]
|
|
48
|
+
optional :sip_registration_details,
|
|
49
|
+
-> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails }
|
|
50
|
+
|
|
51
|
+
# @!attribute sip_registration_status
|
|
52
|
+
# Human-readable registration status derived from the registrar state.
|
|
53
|
+
#
|
|
54
|
+
# @return [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus, nil]
|
|
55
|
+
optional :sip_registration_status,
|
|
56
|
+
enum: -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus }
|
|
57
|
+
|
|
58
|
+
# @!method initialize(connection_id: nil, connection_name: nil, credential_type: nil, credential_username: nil, last_registration_response: nil, registered: nil, sip_registration_details: nil, sip_registration_status: nil)
|
|
59
|
+
# @param connection_id [String] Identifier of the UAC connection.
|
|
60
|
+
#
|
|
61
|
+
# @param connection_name [String] Human-readable connection name.
|
|
62
|
+
#
|
|
63
|
+
# @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType] The credential type that was looked up.
|
|
64
|
+
#
|
|
65
|
+
# @param credential_username [String] SIP username used for the registration.
|
|
66
|
+
#
|
|
67
|
+
# @param last_registration_response [String] SIP response from the last registration attempt.
|
|
68
|
+
#
|
|
69
|
+
# @param registered [Boolean] True if the endpoint is currently registered.
|
|
70
|
+
#
|
|
71
|
+
# @param sip_registration_details [Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails] Detailed registration information reported by the registrar.
|
|
72
|
+
#
|
|
73
|
+
# @param sip_registration_status [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus] Human-readable registration status derived from the registrar state.
|
|
74
|
+
|
|
75
|
+
# The credential type that was looked up.
|
|
76
|
+
#
|
|
77
|
+
# @see Telnyx::Models::SipRegistrationStatusRetrieveResponse#credential_type
|
|
78
|
+
module CredentialType
|
|
79
|
+
extend Telnyx::Internal::Type::Enum
|
|
80
|
+
|
|
81
|
+
UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
|
|
82
|
+
|
|
83
|
+
# @!method self.values
|
|
84
|
+
# @return [Array<Symbol>]
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# @see Telnyx::Models::SipRegistrationStatusRetrieveResponse#sip_registration_details
|
|
88
|
+
class SipRegistrationDetails < Telnyx::Internal::Type::BaseModel
|
|
89
|
+
# @!attribute auth_retries
|
|
90
|
+
# Number of authentication retries on the last attempt.
|
|
91
|
+
#
|
|
92
|
+
# @return [Integer, nil]
|
|
93
|
+
optional :auth_retries, Integer
|
|
94
|
+
|
|
95
|
+
# @!attribute expires
|
|
96
|
+
# Unix timestamp when the current registration expires.
|
|
97
|
+
#
|
|
98
|
+
# @return [Integer, nil]
|
|
99
|
+
optional :expires, Integer
|
|
100
|
+
|
|
101
|
+
# @!attribute failures
|
|
102
|
+
# Count of consecutive registration failures.
|
|
103
|
+
#
|
|
104
|
+
# @return [Integer, nil]
|
|
105
|
+
optional :failures, Integer
|
|
106
|
+
|
|
107
|
+
# @!attribute next_action_at
|
|
108
|
+
# Unix timestamp of the next scheduled registration action.
|
|
109
|
+
#
|
|
110
|
+
# @return [Integer, nil]
|
|
111
|
+
optional :next_action_at, Integer
|
|
112
|
+
|
|
113
|
+
# @!attribute sip_uri_user_host
|
|
114
|
+
# SIP URI user@host of the registered contact.
|
|
115
|
+
#
|
|
116
|
+
# @return [String, nil]
|
|
117
|
+
optional :sip_uri_user_host, String
|
|
118
|
+
|
|
119
|
+
# @!attribute uptime
|
|
120
|
+
# Registration uptime reported by the registrar.
|
|
121
|
+
#
|
|
122
|
+
# @return [Integer, nil]
|
|
123
|
+
optional :uptime, Integer
|
|
124
|
+
|
|
125
|
+
# @!method initialize(auth_retries: nil, expires: nil, failures: nil, next_action_at: nil, sip_uri_user_host: nil, uptime: nil)
|
|
126
|
+
# Detailed registration information reported by the registrar.
|
|
127
|
+
#
|
|
128
|
+
# @param auth_retries [Integer] Number of authentication retries on the last attempt.
|
|
129
|
+
#
|
|
130
|
+
# @param expires [Integer] Unix timestamp when the current registration expires.
|
|
131
|
+
#
|
|
132
|
+
# @param failures [Integer] Count of consecutive registration failures.
|
|
133
|
+
#
|
|
134
|
+
# @param next_action_at [Integer] Unix timestamp of the next scheduled registration action.
|
|
135
|
+
#
|
|
136
|
+
# @param sip_uri_user_host [String] SIP URI user@host of the registered contact.
|
|
137
|
+
#
|
|
138
|
+
# @param uptime [Integer] Registration uptime reported by the registrar.
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Human-readable registration status derived from the registrar state.
|
|
142
|
+
#
|
|
143
|
+
# @see Telnyx::Models::SipRegistrationStatusRetrieveResponse#sip_registration_status
|
|
144
|
+
module SipRegistrationStatus
|
|
145
|
+
extend Telnyx::Internal::Type::Enum
|
|
146
|
+
|
|
147
|
+
UNREGISTERING = :unregistering
|
|
148
|
+
CONNECTION_DISABLED = :connection_disabled
|
|
149
|
+
STANDBY = :standby
|
|
150
|
+
FAILED = :failed
|
|
151
|
+
TRYING = :trying
|
|
152
|
+
REGISTERED = :registered
|
|
153
|
+
UNKNOWN = :unknown
|
|
154
|
+
|
|
155
|
+
# @!method self.values
|
|
156
|
+
# @return [Array<Symbol>]
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
end
|
|
@@ -18,7 +18,12 @@ module Telnyx
|
|
|
18
18
|
optional :provider, enum: -> { Telnyx::SpeechToTextListProvidersParams::Provider }
|
|
19
19
|
|
|
20
20
|
# @!attribute service_type
|
|
21
|
-
# Filter to entries that support the given service type.
|
|
21
|
+
# Filter to entries that support the given service type. For backward
|
|
22
|
+
# compatibility with the values that briefly shipped before the product-aligned
|
|
23
|
+
# rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
|
|
24
|
+
# `ai_assistant_transcription` are silently accepted and normalized to
|
|
25
|
+
# `file_based`, `in_call`, and `ai_assistant` respectively. The response always
|
|
26
|
+
# emits the canonical (post-rename) values.
|
|
22
27
|
#
|
|
23
28
|
# @return [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType, nil]
|
|
24
29
|
optional :service_type, enum: -> { Telnyx::SpeechToTextListProvidersParams::ServiceType }
|
|
@@ -29,7 +34,7 @@ module Telnyx
|
|
|
29
34
|
#
|
|
30
35
|
# @param provider [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::Provider] Filter to entries for a specific STT provider. The enum mirrors the providers ad
|
|
31
36
|
#
|
|
32
|
-
# @param service_type [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType] Filter to entries that support the given service type.
|
|
37
|
+
# @param service_type [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType] Filter to entries that support the given service type. For backward compatibilit
|
|
33
38
|
#
|
|
34
39
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
35
40
|
|
|
@@ -55,13 +60,19 @@ module Telnyx
|
|
|
55
60
|
# @return [Array<Symbol>]
|
|
56
61
|
end
|
|
57
62
|
|
|
58
|
-
# Filter to entries that support the given service type.
|
|
63
|
+
# Filter to entries that support the given service type. For backward
|
|
64
|
+
# compatibility with the values that briefly shipped before the product-aligned
|
|
65
|
+
# rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
|
|
66
|
+
# `ai_assistant_transcription` are silently accepted and normalized to
|
|
67
|
+
# `file_based`, `in_call`, and `ai_assistant` respectively. The response always
|
|
68
|
+
# emits the canonical (post-rename) values.
|
|
59
69
|
module ServiceType
|
|
60
70
|
extend Telnyx::Internal::Type::Enum
|
|
61
71
|
|
|
62
72
|
STREAMING = :streaming
|
|
63
|
-
|
|
64
|
-
|
|
73
|
+
FILE_BASED = :file_based
|
|
74
|
+
IN_CALL = :in_call
|
|
75
|
+
AI_ASSISTANT = :ai_assistant
|
|
65
76
|
|
|
66
77
|
# @!method self.values
|
|
67
78
|
# @return [Array<Symbol>]
|
|
@@ -22,13 +22,6 @@ module Telnyx
|
|
|
22
22
|
# @param meta [Telnyx::Models::SpeechToTextListProvidersResponse::Meta]
|
|
23
23
|
|
|
24
24
|
class Data < Telnyx::Internal::Type::BaseModel
|
|
25
|
-
# @!attribute languages
|
|
26
|
-
# Languages this (provider, model) accepts, in the provider's native code format.
|
|
27
|
-
# `auto` indicates the provider performs language detection.
|
|
28
|
-
#
|
|
29
|
-
# @return [Array<String>]
|
|
30
|
-
required :languages, Telnyx::Internal::Type::ArrayOf[String]
|
|
31
|
-
|
|
32
25
|
# @!attribute model
|
|
33
26
|
# Provider-scoped model name.
|
|
34
27
|
#
|
|
@@ -42,36 +35,75 @@ module Telnyx
|
|
|
42
35
|
required :provider, String
|
|
43
36
|
|
|
44
37
|
# @!attribute service_types
|
|
45
|
-
# Service surfaces this (provider, model) supports.
|
|
38
|
+
# Service surfaces this (provider, model) supports. When the request filters by
|
|
39
|
+
# `service_type`, only the matching nested entry is returned for each matching
|
|
40
|
+
# model.
|
|
46
41
|
#
|
|
47
|
-
# @return [Array<
|
|
42
|
+
# @return [Array<Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType>]
|
|
48
43
|
required :service_types,
|
|
49
|
-
-> { Telnyx::Internal::Type::ArrayOf[
|
|
44
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType] }
|
|
50
45
|
|
|
51
|
-
# @!method initialize(
|
|
46
|
+
# @!method initialize(model:, provider:, service_types:)
|
|
52
47
|
# Some parameter documentations has been truncated, see
|
|
53
48
|
# {Telnyx::Models::SpeechToTextListProvidersResponse::Data} for more details.
|
|
54
49
|
#
|
|
55
|
-
# A (provider, model) tuple along with
|
|
56
|
-
#
|
|
57
|
-
# @param languages [Array<String>] Languages this (provider, model) accepts, in the provider's native code format.
|
|
50
|
+
# A (provider, model) tuple along with the service surfaces it supports. Each
|
|
51
|
+
# entry in `service_types` describes one surface and the languages accepted on it.
|
|
58
52
|
#
|
|
59
53
|
# @param model [String] Provider-scoped model name.
|
|
60
54
|
#
|
|
61
55
|
# @param provider [String] STT provider name.
|
|
62
56
|
#
|
|
63
|
-
# @param service_types [Array<
|
|
57
|
+
# @param service_types [Array<Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType>] Service surfaces this (provider, model) supports. When the request filters by `s
|
|
58
|
+
|
|
59
|
+
class ServiceType < Telnyx::Internal::Type::BaseModel
|
|
60
|
+
# @!attribute languages
|
|
61
|
+
# Languages accepted on this service surface, in the provider's native code
|
|
62
|
+
# format. `auto` indicates the provider performs language detection.
|
|
63
|
+
#
|
|
64
|
+
# @return [Array<String>]
|
|
65
|
+
required :languages, Telnyx::Internal::Type::ArrayOf[String]
|
|
66
|
+
|
|
67
|
+
# @!attribute type
|
|
68
|
+
# Service surface a model is available on. `ai_assistant` is the STT surface
|
|
69
|
+
# configured via Call Control voice-assistant transcription; it covers both
|
|
70
|
+
# live-streaming and non-streaming/batch models (matching the
|
|
71
|
+
# `TranscriptionConfig.model` enum on `call-control` voice assistants).
|
|
72
|
+
#
|
|
73
|
+
# @return [Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type]
|
|
74
|
+
required :type, enum: -> { Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type }
|
|
75
|
+
|
|
76
|
+
# @!method initialize(languages:, type:)
|
|
77
|
+
# Some parameter documentations has been truncated, see
|
|
78
|
+
# {Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType} for more
|
|
79
|
+
# details.
|
|
80
|
+
#
|
|
81
|
+
# A supported service surface for a given (provider, model), along with the
|
|
82
|
+
# language codes accepted on that surface. Language support can differ per surface
|
|
83
|
+
# — for example, a model may accept a narrower language set for streaming than for
|
|
84
|
+
# file transcription.
|
|
85
|
+
#
|
|
86
|
+
# @param languages [Array<String>] Languages accepted on this service surface, in the provider's native code format
|
|
87
|
+
#
|
|
88
|
+
# @param type [Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type] Service surface a model is available on. `ai_assistant` is the STT surface confi
|
|
64
89
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
90
|
+
# Service surface a model is available on. `ai_assistant` is the STT surface
|
|
91
|
+
# configured via Call Control voice-assistant transcription; it covers both
|
|
92
|
+
# live-streaming and non-streaming/batch models (matching the
|
|
93
|
+
# `TranscriptionConfig.model` enum on `call-control` voice assistants).
|
|
94
|
+
#
|
|
95
|
+
# @see Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType#type
|
|
96
|
+
module Type
|
|
97
|
+
extend Telnyx::Internal::Type::Enum
|
|
68
98
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
99
|
+
STREAMING = :streaming
|
|
100
|
+
FILE_BASED = :file_based
|
|
101
|
+
IN_CALL = :in_call
|
|
102
|
+
AI_ASSISTANT = :ai_assistant
|
|
72
103
|
|
|
73
|
-
|
|
74
|
-
|
|
104
|
+
# @!method self.values
|
|
105
|
+
# @return [Array<Symbol>]
|
|
106
|
+
end
|
|
75
107
|
end
|
|
76
108
|
end
|
|
77
109
|
|