telnyx 5.38.1 → 5.39.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 +8 -0
- data/README.md +1 -1
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +195 -3
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +218 -15
- data/lib/telnyx/models/calls/action_speak_params.rb +214 -15
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +197 -3
- data/lib/telnyx/models/conferences/action_speak_params.rb +216 -15
- data/lib/telnyx/resources/calls/actions.rb +4 -4
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/version.rb +1 -1
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +488 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +530 -29
- data/rbi/telnyx/models/calls/action_speak_params.rbi +530 -29
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +488 -5
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +530 -29
- data/rbi/telnyx/resources/calls/actions.rbi +58 -28
- data/rbi/telnyx/resources/conferences/actions.rbi +25 -13
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +179 -0
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +179 -0
- data/sig/telnyx/models/calls/action_speak_params.rbs +179 -0
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +179 -0
- data/sig/telnyx/models/conferences/action_speak_params.rbs +179 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 653aa2f9c9b16fb4ae643ddd4fb852835ca99c5fcbe0f5faa67238a0dc8bf9c3
|
|
4
|
+
data.tar.gz: 60f97a6a177182330c9704e1469b0b557fe6ea34c6e42fc651df251a430070bc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b8d3bbc4fdd44683d21cad84726d6960e44e29d9567a25577bd493fddf8a7beacd4f08378dab352a7b9e0f1a2428888bad9896144b44bd464c530a9b59f945c4
|
|
7
|
+
data.tar.gz: 0a68a6fee99b15ab5fa90b2c020309b0e479064425b44e2d110bcf93920f5a2246ee36b725fa0c8b55d9af5bb7558217783e3fc89339eb53e4530ecc54adb60e
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.39.0 (2026-02-25)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.38.1...v5.39.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.38.1...v5.39.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Add missing TTS voice settings schemas and update voice descriptions ([eb43986](https://github.com/team-telnyx/telnyx-ruby/commit/eb439865bd26c00206ecc63ded05f811a520d0b4))
|
|
10
|
+
|
|
3
11
|
## 5.38.1 (2026-02-24)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v5.38.0...v5.38.1](https://github.com/team-telnyx/telnyx-ruby/compare/v5.38.0...v5.38.1)
|
data/README.md
CHANGED
|
@@ -135,7 +135,7 @@ module Telnyx
|
|
|
135
135
|
# @!attribute voice_settings
|
|
136
136
|
# The settings associated with the voice selected
|
|
137
137
|
#
|
|
138
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, nil]
|
|
138
|
+
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Rime, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble, nil]
|
|
139
139
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings }
|
|
140
140
|
|
|
141
141
|
# @!method initialize(parameters:, assistant: nil, client_state: nil, command_id: nil, gather_ended_speech: nil, greeting: nil, interruption_settings: nil, language: nil, message_history: nil, send_message_history_updates: nil, send_partial_results: nil, transcription: nil, user_response_timeout_ms: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
@@ -170,7 +170,7 @@ module Telnyx
|
|
|
170
170
|
#
|
|
171
171
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
172
172
|
#
|
|
173
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings] The settings associated with the voice selected
|
|
173
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Rime, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble] The settings associated with the voice selected
|
|
174
174
|
#
|
|
175
175
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
176
176
|
|
|
@@ -218,8 +218,200 @@ module Telnyx
|
|
|
218
218
|
|
|
219
219
|
variant :aws, -> { Telnyx::Calls::AwsVoiceSettings }
|
|
220
220
|
|
|
221
|
+
variant :azure, -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure }
|
|
222
|
+
|
|
223
|
+
variant :rime, -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Rime }
|
|
224
|
+
|
|
225
|
+
variant :resemble, -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble }
|
|
226
|
+
|
|
227
|
+
class Azure < Telnyx::Internal::Type::BaseModel
|
|
228
|
+
# @!attribute type
|
|
229
|
+
# Voice settings provider type
|
|
230
|
+
#
|
|
231
|
+
# @return [Symbol, :azure]
|
|
232
|
+
required :type, const: :azure
|
|
233
|
+
|
|
234
|
+
# @!attribute api_key_ref
|
|
235
|
+
# The `identifier` for an integration secret that refers to your Azure Speech API
|
|
236
|
+
# key.
|
|
237
|
+
#
|
|
238
|
+
# @return [String, nil]
|
|
239
|
+
optional :api_key_ref, String
|
|
240
|
+
|
|
241
|
+
# @!attribute deployment_id
|
|
242
|
+
# The deployment ID for a custom Azure neural voice.
|
|
243
|
+
#
|
|
244
|
+
# @return [String, nil]
|
|
245
|
+
optional :deployment_id, String
|
|
246
|
+
|
|
247
|
+
# @!attribute effect
|
|
248
|
+
# Audio effect to apply.
|
|
249
|
+
#
|
|
250
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure::Effect, nil]
|
|
251
|
+
optional :effect, enum: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure::Effect }
|
|
252
|
+
|
|
253
|
+
# @!attribute gender
|
|
254
|
+
# Voice gender filter.
|
|
255
|
+
#
|
|
256
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure::Gender, nil]
|
|
257
|
+
optional :gender, enum: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure::Gender }
|
|
258
|
+
|
|
259
|
+
# @!attribute region
|
|
260
|
+
# The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required
|
|
261
|
+
# when using a custom API key.
|
|
262
|
+
#
|
|
263
|
+
# @return [String, nil]
|
|
264
|
+
optional :region, String
|
|
265
|
+
|
|
266
|
+
# @!method initialize(api_key_ref: nil, deployment_id: nil, effect: nil, gender: nil, region: nil, type: :azure)
|
|
267
|
+
# Some parameter documentations has been truncated, see
|
|
268
|
+
# {Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure} for
|
|
269
|
+
# more details.
|
|
270
|
+
#
|
|
271
|
+
# @param api_key_ref [String] The `identifier` for an integration secret that refers to your Azure Speech API
|
|
272
|
+
#
|
|
273
|
+
# @param deployment_id [String] The deployment ID for a custom Azure neural voice.
|
|
274
|
+
#
|
|
275
|
+
# @param effect [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure::Effect] Audio effect to apply.
|
|
276
|
+
#
|
|
277
|
+
# @param gender [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure::Gender] Voice gender filter.
|
|
278
|
+
#
|
|
279
|
+
# @param region [String] The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required
|
|
280
|
+
#
|
|
281
|
+
# @param type [Symbol, :azure] Voice settings provider type
|
|
282
|
+
|
|
283
|
+
# Audio effect to apply.
|
|
284
|
+
#
|
|
285
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure#effect
|
|
286
|
+
module Effect
|
|
287
|
+
extend Telnyx::Internal::Type::Enum
|
|
288
|
+
|
|
289
|
+
EQ_CAR = :eq_car
|
|
290
|
+
EQ_TELECOMHP8K = :eq_telecomhp8k
|
|
291
|
+
|
|
292
|
+
# @!method self.values
|
|
293
|
+
# @return [Array<Symbol>]
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
# Voice gender filter.
|
|
297
|
+
#
|
|
298
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure#gender
|
|
299
|
+
module Gender
|
|
300
|
+
extend Telnyx::Internal::Type::Enum
|
|
301
|
+
|
|
302
|
+
MALE = :Male
|
|
303
|
+
FEMALE = :Female
|
|
304
|
+
|
|
305
|
+
# @!method self.values
|
|
306
|
+
# @return [Array<Symbol>]
|
|
307
|
+
end
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
class Rime < Telnyx::Internal::Type::BaseModel
|
|
311
|
+
# @!attribute type
|
|
312
|
+
# Voice settings provider type
|
|
313
|
+
#
|
|
314
|
+
# @return [Symbol, :rime]
|
|
315
|
+
required :type, const: :rime
|
|
316
|
+
|
|
317
|
+
# @!attribute voice_speed
|
|
318
|
+
# Speech speed multiplier. Default is 1.0.
|
|
319
|
+
#
|
|
320
|
+
# @return [Float, nil]
|
|
321
|
+
optional :voice_speed, Float
|
|
322
|
+
|
|
323
|
+
# @!method initialize(voice_speed: nil, type: :rime)
|
|
324
|
+
# @param voice_speed [Float] Speech speed multiplier. Default is 1.0.
|
|
325
|
+
#
|
|
326
|
+
# @param type [Symbol, :rime] Voice settings provider type
|
|
327
|
+
end
|
|
328
|
+
|
|
329
|
+
class Resemble < Telnyx::Internal::Type::BaseModel
|
|
330
|
+
# @!attribute type
|
|
331
|
+
# Voice settings provider type
|
|
332
|
+
#
|
|
333
|
+
# @return [Symbol, :resemble]
|
|
334
|
+
required :type, const: :resemble
|
|
335
|
+
|
|
336
|
+
# @!attribute format_
|
|
337
|
+
# Output audio format.
|
|
338
|
+
#
|
|
339
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::Format, nil]
|
|
340
|
+
optional :format_,
|
|
341
|
+
enum: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::Format },
|
|
342
|
+
api_name: :format
|
|
343
|
+
|
|
344
|
+
# @!attribute precision
|
|
345
|
+
# Audio precision format.
|
|
346
|
+
#
|
|
347
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::Precision, nil]
|
|
348
|
+
optional :precision,
|
|
349
|
+
enum: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::Precision }
|
|
350
|
+
|
|
351
|
+
# @!attribute sample_rate
|
|
352
|
+
# Audio sample rate in Hz.
|
|
353
|
+
#
|
|
354
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::SampleRate, nil]
|
|
355
|
+
optional :sample_rate,
|
|
356
|
+
enum: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::SampleRate }
|
|
357
|
+
|
|
358
|
+
# @!method initialize(format_: nil, precision: nil, sample_rate: nil, type: :resemble)
|
|
359
|
+
# @param format_ [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::Format] Output audio format.
|
|
360
|
+
#
|
|
361
|
+
# @param precision [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::Precision] Audio precision format.
|
|
362
|
+
#
|
|
363
|
+
# @param sample_rate [Symbol, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble::SampleRate] Audio sample rate in Hz.
|
|
364
|
+
#
|
|
365
|
+
# @param type [Symbol, :resemble] Voice settings provider type
|
|
366
|
+
|
|
367
|
+
# Output audio format.
|
|
368
|
+
#
|
|
369
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble#format_
|
|
370
|
+
module Format
|
|
371
|
+
extend Telnyx::Internal::Type::Enum
|
|
372
|
+
|
|
373
|
+
WAV = :wav
|
|
374
|
+
MP3 = :mp3
|
|
375
|
+
|
|
376
|
+
# @!method self.values
|
|
377
|
+
# @return [Array<Symbol>]
|
|
378
|
+
end
|
|
379
|
+
|
|
380
|
+
# Audio precision format.
|
|
381
|
+
#
|
|
382
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble#precision
|
|
383
|
+
module Precision
|
|
384
|
+
extend Telnyx::Internal::Type::Enum
|
|
385
|
+
|
|
386
|
+
PCM_16 = :PCM_16
|
|
387
|
+
PCM_24 = :PCM_24
|
|
388
|
+
PCM_32 = :PCM_32
|
|
389
|
+
MULAW = :MULAW
|
|
390
|
+
|
|
391
|
+
# @!method self.values
|
|
392
|
+
# @return [Array<Symbol>]
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
# Audio sample rate in Hz.
|
|
396
|
+
#
|
|
397
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble#sample_rate
|
|
398
|
+
module SampleRate
|
|
399
|
+
extend Telnyx::Internal::Type::Enum
|
|
400
|
+
|
|
401
|
+
SAMPLE_RATE_8000 = :"8000"
|
|
402
|
+
SAMPLE_RATE_16000 = :"16000"
|
|
403
|
+
SAMPLE_RATE_22050 = :"22050"
|
|
404
|
+
SAMPLE_RATE_32000 = :"32000"
|
|
405
|
+
SAMPLE_RATE_44100 = :"44100"
|
|
406
|
+
SAMPLE_RATE_48000 = :"48000"
|
|
407
|
+
|
|
408
|
+
# @!method self.values
|
|
409
|
+
# @return [Array<Symbol>]
|
|
410
|
+
end
|
|
411
|
+
end
|
|
412
|
+
|
|
221
413
|
# @!method self.variants
|
|
222
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings)]
|
|
414
|
+
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Azure, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Rime, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Resemble)]
|
|
223
415
|
end
|
|
224
416
|
end
|
|
225
417
|
end
|
|
@@ -27,25 +27,34 @@ module Telnyx
|
|
|
27
27
|
# the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
|
|
28
28
|
# [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
|
|
29
29
|
# for compatibility.
|
|
30
|
-
# - **Azure:** Use `Azure.<VoiceId
|
|
31
|
-
# Azure.en-
|
|
32
|
-
# Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
|
|
33
|
-
# [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).
|
|
30
|
+
# - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
|
|
31
|
+
# `Azure.en-US-BrianMultilingualNeural`,
|
|
32
|
+
# `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
|
|
33
|
+
# [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery). Use
|
|
34
|
+
# `voice_settings` to configure custom deployments, regions, or API keys.
|
|
34
35
|
# - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
|
|
35
36
|
# `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`). The `ModelId` part
|
|
36
37
|
# is optional. To use ElevenLabs, you must provide your ElevenLabs API key as an
|
|
37
38
|
# integration identifier secret in
|
|
38
|
-
# `"voice_settings": {"api_key_ref": "<secret_identifier>"}`.
|
|
39
|
+
# `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. See
|
|
40
|
+
# [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
41
|
+
# for details. Check
|
|
39
42
|
# [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
40
|
-
# - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
|
|
43
|
+
# - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
|
|
44
|
+
# Use `voice_settings` to configure voice_speed and other synthesis parameters.
|
|
41
45
|
# - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
|
|
42
46
|
# `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
|
|
43
|
-
# `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`.
|
|
44
|
-
#
|
|
45
|
-
#
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
47
|
+
# `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
|
|
48
|
+
# to configure speed, volume, pitch, and language_boost.
|
|
49
|
+
# - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
|
|
50
|
+
# Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
|
|
51
|
+
# voice_speed.
|
|
52
|
+
# - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
|
|
53
|
+
# `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
|
|
54
|
+
# `voice_settings` to configure precision, sample_rate, and format.
|
|
55
|
+
#
|
|
56
|
+
# For service_level basic, you may define the gender of the speaker (male or
|
|
57
|
+
# female).
|
|
49
58
|
#
|
|
50
59
|
# @return [String]
|
|
51
60
|
required :voice, String
|
|
@@ -142,7 +151,7 @@ module Telnyx
|
|
|
142
151
|
# @!attribute voice_settings
|
|
143
152
|
# The settings associated with the voice selected
|
|
144
153
|
#
|
|
145
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, nil]
|
|
154
|
+
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Rime, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble, nil]
|
|
146
155
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings }
|
|
147
156
|
|
|
148
157
|
# @!method initialize(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: {})
|
|
@@ -180,7 +189,7 @@ module Telnyx
|
|
|
180
189
|
#
|
|
181
190
|
# @param valid_digits [String] A list of all digits accepted as valid.
|
|
182
191
|
#
|
|
183
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings] The settings associated with the voice selected
|
|
192
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Rime, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble] The settings associated with the voice selected
|
|
184
193
|
#
|
|
185
194
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
186
195
|
|
|
@@ -261,8 +270,202 @@ module Telnyx
|
|
|
261
270
|
|
|
262
271
|
variant :minimax, -> { Telnyx::MinimaxVoiceSettings }
|
|
263
272
|
|
|
273
|
+
variant :azure, -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure }
|
|
274
|
+
|
|
275
|
+
variant :rime, -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Rime }
|
|
276
|
+
|
|
277
|
+
variant :resemble, -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble }
|
|
278
|
+
|
|
279
|
+
class Azure < Telnyx::Internal::Type::BaseModel
|
|
280
|
+
# @!attribute type
|
|
281
|
+
# Voice settings provider type
|
|
282
|
+
#
|
|
283
|
+
# @return [Symbol, :azure]
|
|
284
|
+
required :type, const: :azure
|
|
285
|
+
|
|
286
|
+
# @!attribute api_key_ref
|
|
287
|
+
# The `identifier` for an integration secret that refers to your Azure Speech API
|
|
288
|
+
# key.
|
|
289
|
+
#
|
|
290
|
+
# @return [String, nil]
|
|
291
|
+
optional :api_key_ref, String
|
|
292
|
+
|
|
293
|
+
# @!attribute deployment_id
|
|
294
|
+
# The deployment ID for a custom Azure neural voice.
|
|
295
|
+
#
|
|
296
|
+
# @return [String, nil]
|
|
297
|
+
optional :deployment_id, String
|
|
298
|
+
|
|
299
|
+
# @!attribute effect
|
|
300
|
+
# Audio effect to apply.
|
|
301
|
+
#
|
|
302
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure::Effect, nil]
|
|
303
|
+
optional :effect, enum: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure::Effect }
|
|
304
|
+
|
|
305
|
+
# @!attribute gender
|
|
306
|
+
# Voice gender filter.
|
|
307
|
+
#
|
|
308
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure::Gender, nil]
|
|
309
|
+
optional :gender, enum: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure::Gender }
|
|
310
|
+
|
|
311
|
+
# @!attribute region
|
|
312
|
+
# The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required
|
|
313
|
+
# when using a custom API key.
|
|
314
|
+
#
|
|
315
|
+
# @return [String, nil]
|
|
316
|
+
optional :region, String
|
|
317
|
+
|
|
318
|
+
# @!method initialize(api_key_ref: nil, deployment_id: nil, effect: nil, gender: nil, region: nil, type: :azure)
|
|
319
|
+
# Some parameter documentations has been truncated, see
|
|
320
|
+
# {Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure} for
|
|
321
|
+
# more details.
|
|
322
|
+
#
|
|
323
|
+
# @param api_key_ref [String] The `identifier` for an integration secret that refers to your Azure Speech API
|
|
324
|
+
#
|
|
325
|
+
# @param deployment_id [String] The deployment ID for a custom Azure neural voice.
|
|
326
|
+
#
|
|
327
|
+
# @param effect [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure::Effect] Audio effect to apply.
|
|
328
|
+
#
|
|
329
|
+
# @param gender [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure::Gender] Voice gender filter.
|
|
330
|
+
#
|
|
331
|
+
# @param region [String] The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required
|
|
332
|
+
#
|
|
333
|
+
# @param type [Symbol, :azure] Voice settings provider type
|
|
334
|
+
|
|
335
|
+
# Audio effect to apply.
|
|
336
|
+
#
|
|
337
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure#effect
|
|
338
|
+
module Effect
|
|
339
|
+
extend Telnyx::Internal::Type::Enum
|
|
340
|
+
|
|
341
|
+
EQ_CAR = :eq_car
|
|
342
|
+
EQ_TELECOMHP8K = :eq_telecomhp8k
|
|
343
|
+
|
|
344
|
+
# @!method self.values
|
|
345
|
+
# @return [Array<Symbol>]
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
# Voice gender filter.
|
|
349
|
+
#
|
|
350
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure#gender
|
|
351
|
+
module Gender
|
|
352
|
+
extend Telnyx::Internal::Type::Enum
|
|
353
|
+
|
|
354
|
+
MALE = :Male
|
|
355
|
+
FEMALE = :Female
|
|
356
|
+
|
|
357
|
+
# @!method self.values
|
|
358
|
+
# @return [Array<Symbol>]
|
|
359
|
+
end
|
|
360
|
+
end
|
|
361
|
+
|
|
362
|
+
class Rime < Telnyx::Internal::Type::BaseModel
|
|
363
|
+
# @!attribute type
|
|
364
|
+
# Voice settings provider type
|
|
365
|
+
#
|
|
366
|
+
# @return [Symbol, :rime]
|
|
367
|
+
required :type, const: :rime
|
|
368
|
+
|
|
369
|
+
# @!attribute voice_speed
|
|
370
|
+
# Speech speed multiplier. Default is 1.0.
|
|
371
|
+
#
|
|
372
|
+
# @return [Float, nil]
|
|
373
|
+
optional :voice_speed, Float
|
|
374
|
+
|
|
375
|
+
# @!method initialize(voice_speed: nil, type: :rime)
|
|
376
|
+
# @param voice_speed [Float] Speech speed multiplier. Default is 1.0.
|
|
377
|
+
#
|
|
378
|
+
# @param type [Symbol, :rime] Voice settings provider type
|
|
379
|
+
end
|
|
380
|
+
|
|
381
|
+
class Resemble < Telnyx::Internal::Type::BaseModel
|
|
382
|
+
# @!attribute type
|
|
383
|
+
# Voice settings provider type
|
|
384
|
+
#
|
|
385
|
+
# @return [Symbol, :resemble]
|
|
386
|
+
required :type, const: :resemble
|
|
387
|
+
|
|
388
|
+
# @!attribute format_
|
|
389
|
+
# Output audio format.
|
|
390
|
+
#
|
|
391
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::Format, nil]
|
|
392
|
+
optional :format_,
|
|
393
|
+
enum: -> {
|
|
394
|
+
Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::Format
|
|
395
|
+
},
|
|
396
|
+
api_name: :format
|
|
397
|
+
|
|
398
|
+
# @!attribute precision
|
|
399
|
+
# Audio precision format.
|
|
400
|
+
#
|
|
401
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::Precision, nil]
|
|
402
|
+
optional :precision,
|
|
403
|
+
enum: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::Precision }
|
|
404
|
+
|
|
405
|
+
# @!attribute sample_rate
|
|
406
|
+
# Audio sample rate in Hz.
|
|
407
|
+
#
|
|
408
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::SampleRate, nil]
|
|
409
|
+
optional :sample_rate,
|
|
410
|
+
enum: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::SampleRate }
|
|
411
|
+
|
|
412
|
+
# @!method initialize(format_: nil, precision: nil, sample_rate: nil, type: :resemble)
|
|
413
|
+
# @param format_ [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::Format] Output audio format.
|
|
414
|
+
#
|
|
415
|
+
# @param precision [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::Precision] Audio precision format.
|
|
416
|
+
#
|
|
417
|
+
# @param sample_rate [Symbol, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble::SampleRate] Audio sample rate in Hz.
|
|
418
|
+
#
|
|
419
|
+
# @param type [Symbol, :resemble] Voice settings provider type
|
|
420
|
+
|
|
421
|
+
# Output audio format.
|
|
422
|
+
#
|
|
423
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble#format_
|
|
424
|
+
module Format
|
|
425
|
+
extend Telnyx::Internal::Type::Enum
|
|
426
|
+
|
|
427
|
+
WAV = :wav
|
|
428
|
+
MP3 = :mp3
|
|
429
|
+
|
|
430
|
+
# @!method self.values
|
|
431
|
+
# @return [Array<Symbol>]
|
|
432
|
+
end
|
|
433
|
+
|
|
434
|
+
# Audio precision format.
|
|
435
|
+
#
|
|
436
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble#precision
|
|
437
|
+
module Precision
|
|
438
|
+
extend Telnyx::Internal::Type::Enum
|
|
439
|
+
|
|
440
|
+
PCM_16 = :PCM_16
|
|
441
|
+
PCM_24 = :PCM_24
|
|
442
|
+
PCM_32 = :PCM_32
|
|
443
|
+
MULAW = :MULAW
|
|
444
|
+
|
|
445
|
+
# @!method self.values
|
|
446
|
+
# @return [Array<Symbol>]
|
|
447
|
+
end
|
|
448
|
+
|
|
449
|
+
# Audio sample rate in Hz.
|
|
450
|
+
#
|
|
451
|
+
# @see Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble#sample_rate
|
|
452
|
+
module SampleRate
|
|
453
|
+
extend Telnyx::Internal::Type::Enum
|
|
454
|
+
|
|
455
|
+
SAMPLE_RATE_8000 = :"8000"
|
|
456
|
+
SAMPLE_RATE_16000 = :"16000"
|
|
457
|
+
SAMPLE_RATE_22050 = :"22050"
|
|
458
|
+
SAMPLE_RATE_32000 = :"32000"
|
|
459
|
+
SAMPLE_RATE_44100 = :"44100"
|
|
460
|
+
SAMPLE_RATE_48000 = :"48000"
|
|
461
|
+
|
|
462
|
+
# @!method self.values
|
|
463
|
+
# @return [Array<Symbol>]
|
|
464
|
+
end
|
|
465
|
+
end
|
|
466
|
+
|
|
264
467
|
# @!method self.variants
|
|
265
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings)]
|
|
468
|
+
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Azure, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Rime, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Resemble)]
|
|
266
469
|
end
|
|
267
470
|
end
|
|
268
471
|
end
|