telnyx 5.113.0 → 5.115.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.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
  5. data/lib/telnyx/models/ai/transcription_settings.rb +8 -1
  6. data/lib/telnyx/models/ai/transcription_settings_config.rb +29 -1
  7. data/lib/telnyx/models/ai/voice_settings.rb +14 -1
  8. data/lib/telnyx/models/ai_create_response_params.rb +4 -4
  9. data/lib/telnyx/models/calls/transcription_config.rb +8 -1
  10. data/lib/telnyx/models/calls/transcription_start_request.rb +175 -4
  11. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +0 -2
  12. data/lib/telnyx/resources/ai/openai.rb +1 -1
  13. data/lib/telnyx/resources/ai.rb +3 -3
  14. data/lib/telnyx/resources/calls/actions.rb +1 -1
  15. data/lib/telnyx/version.rb +1 -1
  16. data/lib/telnyx.rb +0 -1
  17. data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
  18. data/rbi/telnyx/models/ai/transcription_settings.rbi +17 -2
  19. data/rbi/telnyx/models/ai/transcription_settings_config.rbi +41 -0
  20. data/rbi/telnyx/models/ai/voice_settings.rbi +14 -1
  21. data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
  22. data/rbi/telnyx/models/calls/transcription_config.rbi +17 -2
  23. data/rbi/telnyx/models/calls/transcription_start_request.rbi +438 -5
  24. data/rbi/telnyx/resources/ai/openai.rbi +1 -1
  25. data/rbi/telnyx/resources/ai.rbi +2 -2
  26. data/rbi/telnyx/resources/calls/actions.rbi +2 -1
  27. data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
  28. data/sig/telnyx/models/ai/transcription_settings.rbs +2 -0
  29. data/sig/telnyx/models/ai/transcription_settings_config.rbs +21 -0
  30. data/sig/telnyx/models/ai/voice_settings.rbs +9 -2
  31. data/sig/telnyx/models/ai_create_response_params.rbs +4 -5
  32. data/sig/telnyx/models/calls/transcription_config.rbs +2 -0
  33. data/sig/telnyx/models/calls/transcription_start_request.rbs +177 -1
  34. data/sig/telnyx/resources/ai/openai.rbs +1 -1
  35. data/sig/telnyx/resources/ai.rbs +1 -1
  36. metadata +2 -5
  37. data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +0 -100
  38. data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +0 -289
  39. data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +0 -114
@@ -21,6 +21,14 @@ module Telnyx
21
21
  sig { params(eager_eot_threshold: Float).void }
22
22
  attr_writer :eager_eot_threshold
23
23
 
24
+ # Available only for soniox/stt-rt-v4. When true, Soniox emits end-of-utterance
25
+ # events at the cadence configured by `max_endpoint_delay_ms`.
26
+ sig { returns(T.nilable(T::Boolean)) }
27
+ attr_reader :enable_endpoint_detection
28
+
29
+ sig { params(enable_endpoint_detection: T::Boolean).void }
30
+ attr_writer :enable_endpoint_detection
31
+
24
32
  # Available only for assemblyai/universal-streaming. Confidence level required to
25
33
  # trigger an end of turn. Higher values require more certainty before ending a
26
34
  # turn.
@@ -46,6 +54,14 @@ module Telnyx
46
54
  sig { params(eot_timeout_ms: Integer).void }
47
55
  attr_writer :eot_timeout_ms
48
56
 
57
+ # Available only for soniox/stt-rt-v4. When true, Soniox streams interim
58
+ # (non-final) results in addition to finalized transcripts.
59
+ sig { returns(T.nilable(T::Boolean)) }
60
+ attr_reader :interim_results
61
+
62
+ sig { params(interim_results: T::Boolean).void }
63
+ attr_writer :interim_results
64
+
49
65
  # Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
50
66
  # key terms to boost for recognition during transcription. Helps improve accuracy
51
67
  # for domain-specific terminology, proper nouns, or uncommon words. This field may
@@ -59,6 +75,15 @@ module Telnyx
59
75
  sig { params(keyterm: String).void }
60
76
  attr_writer :keyterm
61
77
 
78
+ # Available only for soniox/stt-rt-v4. Maximum silence (in milliseconds) before
79
+ # Soniox emits an end-of-utterance event. Only honored when
80
+ # `enable_endpoint_detection` is true.
81
+ sig { returns(T.nilable(Integer)) }
82
+ attr_reader :max_endpoint_delay_ms
83
+
84
+ sig { params(max_endpoint_delay_ms: Integer).void }
85
+ attr_writer :max_endpoint_delay_ms
86
+
62
87
  # Available only for assemblyai/universal-streaming. Maximum duration of silence
63
88
  # in milliseconds before forcing an end of turn.
64
89
  sig { returns(T.nilable(Integer)) }
@@ -91,10 +116,13 @@ module Telnyx
91
116
  sig do
92
117
  params(
93
118
  eager_eot_threshold: Float,
119
+ enable_endpoint_detection: T::Boolean,
94
120
  end_of_turn_confidence_threshold: Float,
95
121
  eot_threshold: Float,
96
122
  eot_timeout_ms: Integer,
123
+ interim_results: T::Boolean,
97
124
  keyterm: String,
125
+ max_endpoint_delay_ms: Integer,
98
126
  max_turn_silence: Integer,
99
127
  min_turn_silence: Integer,
100
128
  numerals: T::Boolean,
@@ -106,6 +134,9 @@ module Telnyx
106
134
  # detection. Must be lower than or equal to eot_threshold. Setting this equal to
107
135
  # eot_threshold effectively disables eager end of turn.
108
136
  eager_eot_threshold: nil,
137
+ # Available only for soniox/stt-rt-v4. When true, Soniox emits end-of-utterance
138
+ # events at the cadence configured by `max_endpoint_delay_ms`.
139
+ enable_endpoint_detection: nil,
109
140
  # Available only for assemblyai/universal-streaming. Confidence level required to
110
141
  # trigger an end of turn. Higher values require more certainty before ending a
111
142
  # turn.
@@ -116,6 +147,9 @@ module Telnyx
116
147
  # Available only for deepgram/flux. Maximum milliseconds of silence before forcing
117
148
  # an end of turn, regardless of confidence.
118
149
  eot_timeout_ms: nil,
150
+ # Available only for soniox/stt-rt-v4. When true, Soniox streams interim
151
+ # (non-final) results in addition to finalized transcripts.
152
+ interim_results: nil,
119
153
  # Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
120
154
  # key terms to boost for recognition during transcription. Helps improve accuracy
121
155
  # for domain-specific terminology, proper nouns, or uncommon words. This field may
@@ -124,6 +158,10 @@ module Telnyx
124
158
  # using mustache syntax (e.g. `Telnyx,{{customer_name}},VoIP`). Variables are
125
159
  # resolved at call time before the value is sent to the speech-to-text engine.
126
160
  keyterm: nil,
161
+ # Available only for soniox/stt-rt-v4. Maximum silence (in milliseconds) before
162
+ # Soniox emits an end-of-utterance event. Only honored when
163
+ # `enable_endpoint_detection` is true.
164
+ max_endpoint_delay_ms: nil,
127
165
  # Available only for assemblyai/universal-streaming. Maximum duration of silence
128
166
  # in milliseconds before forcing an end of turn.
129
167
  max_turn_silence: nil,
@@ -140,10 +178,13 @@ module Telnyx
140
178
  override.returns(
141
179
  {
142
180
  eager_eot_threshold: Float,
181
+ enable_endpoint_detection: T::Boolean,
143
182
  end_of_turn_confidence_threshold: Float,
144
183
  eot_threshold: Float,
145
184
  eot_timeout_ms: Integer,
185
+ interim_results: T::Boolean,
146
186
  keyterm: String,
187
+ max_endpoint_delay_ms: Integer,
147
188
  max_turn_silence: Integer,
148
189
  min_turn_silence: Integer,
149
190
  numerals: T::Boolean,
@@ -266,16 +266,28 @@ module Telnyx
266
266
  end
267
267
  attr_accessor :value
268
268
 
269
+ # Volume level for the predefined background audio. Supports values from 0.1 to
270
+ # 1.0 in 0.1 increments.
271
+ sig { returns(T.nilable(Float)) }
272
+ attr_reader :volume
273
+
274
+ sig { params(volume: Float).void }
275
+ attr_writer :volume
276
+
269
277
  sig do
270
278
  params(
271
279
  value:
272
280
  Telnyx::AI::VoiceSettings::BackgroundAudio::PredefinedMedia::Value::OrSymbol,
281
+ volume: Float,
273
282
  type: Symbol
274
283
  ).returns(T.attached_class)
275
284
  end
276
285
  def self.new(
277
286
  # The predefined media to use. `silence` disables background audio.
278
287
  value:,
288
+ # Volume level for the predefined background audio. Supports values from 0.1 to
289
+ # 1.0 in 0.1 increments.
290
+ volume: nil,
279
291
  # Select from predefined media options.
280
292
  type: :predefined_media
281
293
  )
@@ -286,7 +298,8 @@ module Telnyx
286
298
  {
287
299
  type: Symbol,
288
300
  value:
289
- Telnyx::AI::VoiceSettings::BackgroundAudio::PredefinedMedia::Value::OrSymbol
301
+ Telnyx::AI::VoiceSettings::BackgroundAudio::PredefinedMedia::Value::OrSymbol,
302
+ volume: Float
290
303
  }
291
304
  )
292
305
  end
@@ -12,21 +12,21 @@ module Telnyx
12
12
  end
13
13
 
14
14
  sig { returns(T::Hash[Symbol, T.anything]) }
15
- attr_accessor :params
15
+ attr_accessor :body
16
16
 
17
17
  sig do
18
18
  params(
19
- params: T::Hash[Symbol, T.anything],
19
+ body: T::Hash[Symbol, T.anything],
20
20
  request_options: Telnyx::RequestOptions::OrHash
21
21
  ).returns(T.attached_class)
22
22
  end
23
- def self.new(params:, request_options: {})
23
+ def self.new(body:, request_options: {})
24
24
  end
25
25
 
26
26
  sig do
27
27
  override.returns(
28
28
  {
29
- params: T::Hash[Symbol, T.anything],
29
+ body: T::Hash[Symbol, T.anything],
30
30
  request_options: Telnyx::RequestOptions
31
31
  }
32
32
  )
@@ -14,7 +14,9 @@ module Telnyx
14
14
  # meaningful values depend on the selected transcription `model`. For
15
15
  # `deepgram/flux`, supported values are: `auto` (Telnyx language detection
16
16
  # controls the language hint), `multi` (no language hint), and language-specific
17
- # hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
17
+ # hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For
18
+ # `soniox/stt-rt-v4`, `auto` omits the language hint and lets Soniox auto-detect;
19
+ # ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language.
18
20
  sig { returns(T.nilable(String)) }
19
21
  attr_reader :language
20
22
 
@@ -30,6 +32,8 @@ module Telnyx
30
32
  # transcription.
31
33
  # - `assemblyai/universal-streaming` for live streaming transcription.
32
34
  # - `xai/grok-stt` for live streaming transcription.
35
+ # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
36
+ # automatic language detection.
33
37
  # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
34
38
  # unsupported regions require `api_key_ref`.
35
39
  # - `google/latest_long` for non-streaming multilingual transcription.
@@ -67,7 +71,9 @@ module Telnyx
67
71
  # meaningful values depend on the selected transcription `model`. For
68
72
  # `deepgram/flux`, supported values are: `auto` (Telnyx language detection
69
73
  # controls the language hint), `multi` (no language hint), and language-specific
70
- # hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
74
+ # hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For
75
+ # `soniox/stt-rt-v4`, `auto` omits the language hint and lets Soniox auto-detect;
76
+ # ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language.
71
77
  language: nil,
72
78
  # The speech to text model to be used by the voice assistant. Supported models
73
79
  # include:
@@ -78,6 +84,8 @@ module Telnyx
78
84
  # transcription.
79
85
  # - `assemblyai/universal-streaming` for live streaming transcription.
80
86
  # - `xai/grok-stt` for live streaming transcription.
87
+ # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
88
+ # automatic language detection.
81
89
  # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
82
90
  # unsupported regions require `api_key_ref`.
83
91
  # - `google/latest_long` for non-streaming multilingual transcription.
@@ -109,6 +117,8 @@ module Telnyx
109
117
  # transcription.
110
118
  # - `assemblyai/universal-streaming` for live streaming transcription.
111
119
  # - `xai/grok-stt` for live streaming transcription.
120
+ # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
121
+ # automatic language detection.
112
122
  # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
113
123
  # unsupported regions require `api_key_ref`.
114
124
  # - `google/latest_long` for non-streaming multilingual transcription.
@@ -165,6 +175,11 @@ module Telnyx
165
175
  :"xai/grok-stt",
166
176
  Telnyx::Calls::TranscriptionConfig::Model::TaggedSymbol
167
177
  )
178
+ SONIOX_STT_RT_V4 =
179
+ T.let(
180
+ :"soniox/stt-rt-v4",
181
+ Telnyx::Calls::TranscriptionConfig::Model::TaggedSymbol
182
+ )
168
183
  AZURE_FAST =
169
184
  T.let(
170
185
  :"azure/fast",