telnyx 5.86.0 → 5.88.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 (31) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +209 -1
  5. data/lib/telnyx/models/ai/assistant_update_params.rb +209 -1
  6. data/lib/telnyx/models/ai/assistants/update_assistant.rb +212 -1
  7. data/lib/telnyx/models/ai/inference_embedding.rb +211 -1
  8. data/lib/telnyx/models/ai/transcription_settings.rb +7 -4
  9. data/lib/telnyx/models/call_assistant_request.rb +209 -6
  10. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +189 -3
  11. data/lib/telnyx/resources/ai/assistants/versions.rb +5 -1
  12. data/lib/telnyx/resources/ai/assistants.rb +10 -2
  13. data/lib/telnyx/version.rb +1 -1
  14. data/rbi/telnyx/models/ai/assistant_create_params.rbi +419 -0
  15. data/rbi/telnyx/models/ai/assistant_update_params.rbi +419 -0
  16. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +425 -0
  17. data/rbi/telnyx/models/ai/inference_embedding.rbi +415 -0
  18. data/rbi/telnyx/models/ai/transcription_settings.rbi +11 -5
  19. data/rbi/telnyx/models/call_assistant_request.rbi +416 -8
  20. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +396 -0
  21. data/rbi/telnyx/resources/ai/assistants/versions.rbi +8 -0
  22. data/rbi/telnyx/resources/ai/assistants.rbi +12 -0
  23. data/sig/telnyx/models/ai/assistant_create_params.rbs +193 -0
  24. data/sig/telnyx/models/ai/assistant_update_params.rbs +193 -0
  25. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +193 -0
  26. data/sig/telnyx/models/ai/inference_embedding.rbs +193 -0
  27. data/sig/telnyx/models/call_assistant_request.rbs +197 -10
  28. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +138 -0
  29. data/sig/telnyx/resources/ai/assistants/versions.rbs +2 -0
  30. data/sig/telnyx/resources/ai/assistants.rbs +4 -0
  31. metadata +1 -1
@@ -24,14 +24,14 @@ module Telnyx
24
24
  # @!attribute external_llm
25
25
  # External LLM configuration for bringing your own LLM endpoint.
26
26
  #
27
- # @return [Hash{Symbol=>Object}, nil]
28
- optional :external_llm, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
27
+ # @return [Telnyx::Models::CallAssistantRequest::ExternalLlm, nil]
28
+ optional :external_llm, -> { Telnyx::CallAssistantRequest::ExternalLlm }
29
29
 
30
30
  # @!attribute fallback_config
31
31
  # Fallback LLM configuration used when the primary LLM provider is unavailable.
32
32
  #
33
- # @return [Hash{Symbol=>Object}, nil]
34
- optional :fallback_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
33
+ # @return [Telnyx::Models::CallAssistantRequest::FallbackConfig, nil]
34
+ optional :fallback_config, -> { Telnyx::CallAssistantRequest::FallbackConfig }
35
35
 
36
36
  # @!attribute greeting
37
37
  # Initial greeting text spoken when the assistant starts. Can be plain text for
@@ -116,9 +116,9 @@ module Telnyx
116
116
  #
117
117
  # @param dynamic_variables [Hash{Symbol=>String, Float, Boolean}] Map of dynamic variables and their default values. Dynamic variables can be refe
118
118
  #
119
- # @param external_llm [Hash{Symbol=>Object}] External LLM configuration for bringing your own LLM endpoint.
119
+ # @param external_llm [Telnyx::Models::CallAssistantRequest::ExternalLlm] External LLM configuration for bringing your own LLM endpoint.
120
120
  #
121
- # @param fallback_config [Hash{Symbol=>Object}] Fallback LLM configuration used when the primary LLM provider is unavailable.
121
+ # @param fallback_config [Telnyx::Models::CallAssistantRequest::FallbackConfig] Fallback LLM configuration used when the primary LLM provider is unavailable.
122
122
  #
123
123
  # @param greeting [String] Initial greeting text spoken when the assistant starts. Can be plain text for an
124
124
  #
@@ -151,6 +151,209 @@ module Telnyx
151
151
  # @return [Array(String, Float, Boolean)]
152
152
  end
153
153
 
154
+ # @see Telnyx::Models::CallAssistantRequest#external_llm
155
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
156
+ # @!attribute authentication_method
157
+ # Authentication method used when connecting to the external LLM endpoint.
158
+ #
159
+ # @return [Symbol, Telnyx::Models::CallAssistantRequest::ExternalLlm::AuthenticationMethod, nil]
160
+ optional :authentication_method,
161
+ enum: -> { Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod }
162
+
163
+ # @!attribute base_url
164
+ # Base URL for the external LLM endpoint.
165
+ #
166
+ # @return [String, nil]
167
+ optional :base_url, String
168
+
169
+ # @!attribute certificate_ref
170
+ # Integration secret identifier for the client certificate used with certificate
171
+ # authentication.
172
+ #
173
+ # @return [String, nil]
174
+ optional :certificate_ref, String
175
+
176
+ # @!attribute forward_metadata
177
+ # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
178
+ # external LLM endpoint. Defaults to false. The external endpoint receives the
179
+ # standard chat completions payload with top-level `metadata` and
180
+ # `dynamic_variables` objects when values are available. For example:
181
+ # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
182
+ #
183
+ # @return [Boolean, nil]
184
+ optional :forward_metadata, Telnyx::Internal::Type::Boolean
185
+
186
+ # @!attribute llm_api_key_ref
187
+ # Integration secret identifier for the external LLM API key.
188
+ #
189
+ # @return [String, nil]
190
+ optional :llm_api_key_ref, String
191
+
192
+ # @!attribute model
193
+ # Model identifier to use with the external LLM endpoint.
194
+ #
195
+ # @return [String, nil]
196
+ optional :model, String
197
+
198
+ # @!attribute token_retrieval_url
199
+ # URL used to retrieve an access token when certificate authentication is enabled.
200
+ #
201
+ # @return [String, nil]
202
+ optional :token_retrieval_url, String
203
+
204
+ # @!method initialize(authentication_method: nil, base_url: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, model: nil, token_retrieval_url: nil)
205
+ # Some parameter documentations has been truncated, see
206
+ # {Telnyx::Models::CallAssistantRequest::ExternalLlm} for more details.
207
+ #
208
+ # External LLM configuration for bringing your own LLM endpoint.
209
+ #
210
+ # @param authentication_method [Symbol, Telnyx::Models::CallAssistantRequest::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
211
+ #
212
+ # @param base_url [String] Base URL for the external LLM endpoint.
213
+ #
214
+ # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
215
+ #
216
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
217
+ #
218
+ # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
219
+ #
220
+ # @param model [String] Model identifier to use with the external LLM endpoint.
221
+ #
222
+ # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
223
+
224
+ # Authentication method used when connecting to the external LLM endpoint.
225
+ #
226
+ # @see Telnyx::Models::CallAssistantRequest::ExternalLlm#authentication_method
227
+ module AuthenticationMethod
228
+ extend Telnyx::Internal::Type::Enum
229
+
230
+ TOKEN = :token
231
+ CERTIFICATE = :certificate
232
+
233
+ # @!method self.values
234
+ # @return [Array<Symbol>]
235
+ end
236
+ end
237
+
238
+ # @see Telnyx::Models::CallAssistantRequest#fallback_config
239
+ class FallbackConfig < Telnyx::Internal::Type::BaseModel
240
+ # @!attribute external_llm
241
+ # External LLM fallback configuration.
242
+ #
243
+ # @return [Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm, nil]
244
+ optional :external_llm, -> { Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm }
245
+
246
+ # @!attribute llm_api_key_ref
247
+ # Integration secret identifier for the fallback model API key.
248
+ #
249
+ # @return [String, nil]
250
+ optional :llm_api_key_ref, String
251
+
252
+ # @!attribute model
253
+ # Fallback Telnyx-hosted model to use when the primary LLM provider is
254
+ # unavailable.
255
+ #
256
+ # @return [String, nil]
257
+ optional :model, String
258
+
259
+ # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
260
+ # Some parameter documentations has been truncated, see
261
+ # {Telnyx::Models::CallAssistantRequest::FallbackConfig} for more details.
262
+ #
263
+ # Fallback LLM configuration used when the primary LLM provider is unavailable.
264
+ #
265
+ # @param external_llm [Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm] External LLM fallback configuration.
266
+ #
267
+ # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
268
+ #
269
+ # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
270
+
271
+ # @see Telnyx::Models::CallAssistantRequest::FallbackConfig#external_llm
272
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
273
+ # @!attribute authentication_method
274
+ # Authentication method used when connecting to the external LLM endpoint.
275
+ #
276
+ # @return [Symbol, Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
277
+ optional :authentication_method,
278
+ enum: -> { Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod }
279
+
280
+ # @!attribute base_url
281
+ # Base URL for the external LLM endpoint.
282
+ #
283
+ # @return [String, nil]
284
+ optional :base_url, String
285
+
286
+ # @!attribute certificate_ref
287
+ # Integration secret identifier for the client certificate used with certificate
288
+ # authentication.
289
+ #
290
+ # @return [String, nil]
291
+ optional :certificate_ref, String
292
+
293
+ # @!attribute forward_metadata
294
+ # When enabled, Telnyx forwards conversation metadata and dynamic variables to the
295
+ # external LLM endpoint. Defaults to false. The external endpoint receives the
296
+ # standard chat completions payload with top-level `metadata` and
297
+ # `dynamic_variables` objects when values are available. For example:
298
+ # `{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
299
+ #
300
+ # @return [Boolean, nil]
301
+ optional :forward_metadata, Telnyx::Internal::Type::Boolean
302
+
303
+ # @!attribute llm_api_key_ref
304
+ # Integration secret identifier for the external LLM API key.
305
+ #
306
+ # @return [String, nil]
307
+ optional :llm_api_key_ref, String
308
+
309
+ # @!attribute model
310
+ # Model identifier to use with the external LLM endpoint.
311
+ #
312
+ # @return [String, nil]
313
+ optional :model, String
314
+
315
+ # @!attribute token_retrieval_url
316
+ # URL used to retrieve an access token when certificate authentication is enabled.
317
+ #
318
+ # @return [String, nil]
319
+ optional :token_retrieval_url, String
320
+
321
+ # @!method initialize(authentication_method: nil, base_url: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, model: nil, token_retrieval_url: nil)
322
+ # Some parameter documentations has been truncated, see
323
+ # {Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm} for more
324
+ # details.
325
+ #
326
+ # External LLM fallback configuration.
327
+ #
328
+ # @param authentication_method [Symbol, Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
329
+ #
330
+ # @param base_url [String] Base URL for the external LLM endpoint.
331
+ #
332
+ # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
333
+ #
334
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards conversation metadata and dynamic variables to the
335
+ #
336
+ # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
337
+ #
338
+ # @param model [String] Model identifier to use with the external LLM endpoint.
339
+ #
340
+ # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
341
+
342
+ # Authentication method used when connecting to the external LLM endpoint.
343
+ #
344
+ # @see Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm#authentication_method
345
+ module AuthenticationMethod
346
+ extend Telnyx::Internal::Type::Enum
347
+
348
+ TOKEN = :token
349
+ CERTIFICATE = :certificate
350
+
351
+ # @!method self.values
352
+ # @return [Array<Symbol>]
353
+ end
354
+ end
355
+ end
356
+
154
357
  module Tool
155
358
  extend Telnyx::Internal::Type::Union
156
359
 
@@ -107,6 +107,35 @@ module Telnyx
107
107
  },
108
108
  api_name: :CustomHeaders
109
109
 
110
+ # @!attribute deepfake_detection
111
+ # Enables Deepfake Detection on the dialed call. When enabled, audio from the
112
+ # remote party is analyzed to determine whether the voice is AI-generated. Results
113
+ # are delivered asynchronously via a callback.
114
+ #
115
+ # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetection, nil]
116
+ optional :deepfake_detection,
117
+ enum: -> {
118
+ Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetection
119
+ },
120
+ api_name: :DeepfakeDetection
121
+
122
+ # @!attribute deepfake_detection_callback_method
123
+ # HTTP request type used for `DeepfakeDetectionCallbackUrl`.
124
+ #
125
+ # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetectionCallbackMethod, nil]
126
+ optional :deepfake_detection_callback_method,
127
+ enum: -> {
128
+ Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetectionCallbackMethod
129
+ },
130
+ api_name: :DeepfakeDetectionCallbackMethod
131
+
132
+ # @!attribute deepfake_detection_callback_url
133
+ # URL destination for Telnyx to send deepfake detection callback events to for the
134
+ # call.
135
+ #
136
+ # @return [String, nil]
137
+ optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
138
+
110
139
  # @!attribute detection_mode
111
140
  # Allows you to chose between Premium and Standard detections.
112
141
  #
@@ -364,7 +393,7 @@ module Telnyx
364
393
  enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithURL::URLMethod },
365
394
  api_name: :UrlMethod
366
395
 
367
- # @!method initialize(url:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url_method: nil)
396
+ # @!method initialize(url:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url_method: nil)
368
397
  # Some parameter documentations has been truncated, see
369
398
  # {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL} for more
370
399
  # details.
@@ -387,6 +416,12 @@ module Telnyx
387
416
  #
388
417
  # @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
389
418
  #
419
+ # @param deepfake_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetection] Enables Deepfake Detection on the dialed call. When enabled, audio from the remo
420
+ #
421
+ # @param deepfake_detection_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DeepfakeDetectionCallbackMethod] HTTP request type used for `DeepfakeDetectionCallbackUrl`.
422
+ #
423
+ # @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
424
+ #
390
425
  # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL::DetectionMode] Allows you to chose between Premium and Standard detections.
391
426
  #
392
427
  # @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -484,6 +519,33 @@ module Telnyx
484
519
  # @param value [String] The value of the custom header
485
520
  end
486
521
 
522
+ # Enables Deepfake Detection on the dialed call. When enabled, audio from the
523
+ # remote party is analyzed to determine whether the voice is AI-generated. Results
524
+ # are delivered asynchronously via a callback.
525
+ #
526
+ # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#deepfake_detection
527
+ module DeepfakeDetection
528
+ extend Telnyx::Internal::Type::Enum
529
+
530
+ ENABLE = :Enable
531
+
532
+ # @!method self.values
533
+ # @return [Array<Symbol>]
534
+ end
535
+
536
+ # HTTP request type used for `DeepfakeDetectionCallbackUrl`.
537
+ #
538
+ # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#deepfake_detection_callback_method
539
+ module DeepfakeDetectionCallbackMethod
540
+ extend Telnyx::Internal::Type::Enum
541
+
542
+ GET = :GET
543
+ POST = :POST
544
+
545
+ # @!method self.values
546
+ # @return [Array<Symbol>]
547
+ end
548
+
487
549
  # Allows you to chose between Premium and Standard detections.
488
550
  #
489
551
  # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithURL#detection_mode
@@ -733,6 +795,35 @@ module Telnyx
733
795
  },
734
796
  api_name: :CustomHeaders
735
797
 
798
+ # @!attribute deepfake_detection
799
+ # Enables Deepfake Detection on the dialed call. When enabled, audio from the
800
+ # remote party is analyzed to determine whether the voice is AI-generated. Results
801
+ # are delivered asynchronously via a callback.
802
+ #
803
+ # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetection, nil]
804
+ optional :deepfake_detection,
805
+ enum: -> {
806
+ Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetection
807
+ },
808
+ api_name: :DeepfakeDetection
809
+
810
+ # @!attribute deepfake_detection_callback_method
811
+ # HTTP request type used for `DeepfakeDetectionCallbackUrl`.
812
+ #
813
+ # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetectionCallbackMethod, nil]
814
+ optional :deepfake_detection_callback_method,
815
+ enum: -> {
816
+ Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetectionCallbackMethod
817
+ },
818
+ api_name: :DeepfakeDetectionCallbackMethod
819
+
820
+ # @!attribute deepfake_detection_callback_url
821
+ # URL destination for Telnyx to send deepfake detection callback events to for the
822
+ # call.
823
+ #
824
+ # @return [String, nil]
825
+ optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
826
+
736
827
  # @!attribute detection_mode
737
828
  # Allows you to chose between Premium and Standard detections.
738
829
  #
@@ -994,7 +1085,7 @@ module Telnyx
994
1085
  enum: -> { Telnyx::Texml::Accounts::CallCallsParams::Params::WithTeXml::URLMethod },
995
1086
  api_name: :UrlMethod
996
1087
 
997
- # @!method initialize(texml:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
1088
+ # @!method initialize(texml:, application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
998
1089
  # Some parameter documentations has been truncated, see
999
1090
  # {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml} for more
1000
1091
  # details.
@@ -1017,6 +1108,12 @@ module Telnyx
1017
1108
  #
1018
1109
  # @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
1019
1110
  #
1111
+ # @param deepfake_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetection] Enables Deepfake Detection on the dialed call. When enabled, audio from the remo
1112
+ #
1113
+ # @param deepfake_detection_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DeepfakeDetectionCallbackMethod] HTTP request type used for `DeepfakeDetectionCallbackUrl`.
1114
+ #
1115
+ # @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
1116
+ #
1020
1117
  # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml::DetectionMode] Allows you to chose between Premium and Standard detections.
1021
1118
  #
1022
1119
  # @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -1114,6 +1211,33 @@ module Telnyx
1114
1211
  # @param value [String] The value of the custom header
1115
1212
  end
1116
1213
 
1214
+ # Enables Deepfake Detection on the dialed call. When enabled, audio from the
1215
+ # remote party is analyzed to determine whether the voice is AI-generated. Results
1216
+ # are delivered asynchronously via a callback.
1217
+ #
1218
+ # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#deepfake_detection
1219
+ module DeepfakeDetection
1220
+ extend Telnyx::Internal::Type::Enum
1221
+
1222
+ ENABLE = :Enable
1223
+
1224
+ # @!method self.values
1225
+ # @return [Array<Symbol>]
1226
+ end
1227
+
1228
+ # HTTP request type used for `DeepfakeDetectionCallbackUrl`.
1229
+ #
1230
+ # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#deepfake_detection_callback_method
1231
+ module DeepfakeDetectionCallbackMethod
1232
+ extend Telnyx::Internal::Type::Enum
1233
+
1234
+ GET = :GET
1235
+ POST = :POST
1236
+
1237
+ # @!method self.values
1238
+ # @return [Array<Symbol>]
1239
+ end
1240
+
1117
1241
  # Allows you to chose between Premium and Standard detections.
1118
1242
  #
1119
1243
  # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::WithTeXml#detection_mode
@@ -1356,6 +1480,35 @@ module Telnyx
1356
1480
  },
1357
1481
  api_name: :CustomHeaders
1358
1482
 
1483
+ # @!attribute deepfake_detection
1484
+ # Enables Deepfake Detection on the dialed call. When enabled, audio from the
1485
+ # remote party is analyzed to determine whether the voice is AI-generated. Results
1486
+ # are delivered asynchronously via a callback.
1487
+ #
1488
+ # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetection, nil]
1489
+ optional :deepfake_detection,
1490
+ enum: -> {
1491
+ Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetection
1492
+ },
1493
+ api_name: :DeepfakeDetection
1494
+
1495
+ # @!attribute deepfake_detection_callback_method
1496
+ # HTTP request type used for `DeepfakeDetectionCallbackUrl`.
1497
+ #
1498
+ # @return [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetectionCallbackMethod, nil]
1499
+ optional :deepfake_detection_callback_method,
1500
+ enum: -> {
1501
+ Telnyx::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetectionCallbackMethod
1502
+ },
1503
+ api_name: :DeepfakeDetectionCallbackMethod
1504
+
1505
+ # @!attribute deepfake_detection_callback_url
1506
+ # URL destination for Telnyx to send deepfake detection callback events to for the
1507
+ # call.
1508
+ #
1509
+ # @return [String, nil]
1510
+ optional :deepfake_detection_callback_url, String, api_name: :DeepfakeDetectionCallbackUrl
1511
+
1359
1512
  # @!attribute detection_mode
1360
1513
  # Allows you to chose between Premium and Standard detections.
1361
1514
  #
@@ -1628,7 +1781,7 @@ module Telnyx
1628
1781
  },
1629
1782
  api_name: :UrlMethod
1630
1783
 
1631
- # @!method initialize(application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
1784
+ # @!method initialize(application_sid: nil, async_amd: nil, async_amd_status_callback: nil, async_amd_status_callback_method: nil, caller_id: nil, cancel_playback_on_detect_message_end: nil, cancel_playback_on_machine_detection: nil, custom_headers: nil, deepfake_detection: nil, deepfake_detection_callback_method: nil, deepfake_detection_callback_url: nil, detection_mode: nil, fallback_url: nil, from: nil, machine_detection: nil, machine_detection_silence_timeout: nil, machine_detection_speech_end_threshold: nil, machine_detection_speech_threshold: nil, machine_detection_timeout: nil, media_encryption: nil, preferred_codecs: nil, record: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_timeout: nil, recording_track: nil, send_recording_url: nil, sip_auth_password: nil, sip_auth_username: nil, sip_region: nil, status_callback: nil, status_callback_event: nil, status_callback_method: nil, supervise_call_sid: nil, supervising_role: nil, texml: nil, time_limit: nil, timeout: nil, to: nil, trim: nil, url: nil, url_method: nil)
1632
1785
  # Some parameter documentations has been truncated, see
1633
1786
  # {Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault}
1634
1787
  # for more details.
@@ -1649,6 +1802,12 @@ module Telnyx
1649
1802
  #
1650
1803
  # @param custom_headers [Array<Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::CustomHeader>] Custom HTTP headers to be sent with the call. Each header should be an object wi
1651
1804
  #
1805
+ # @param deepfake_detection [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetection] Enables Deepfake Detection on the dialed call. When enabled, audio from the remo
1806
+ #
1807
+ # @param deepfake_detection_callback_method [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DeepfakeDetectionCallbackMethod] HTTP request type used for `DeepfakeDetectionCallbackUrl`.
1808
+ #
1809
+ # @param deepfake_detection_callback_url [String] URL destination for Telnyx to send deepfake detection callback events to for the
1810
+ #
1652
1811
  # @param detection_mode [Symbol, Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault::DetectionMode] Allows you to chose between Premium and Standard detections.
1653
1812
  #
1654
1813
  # @param fallback_url [String] A failover URL for which Telnyx will retrieve the TeXML call instructions if the
@@ -1748,6 +1907,33 @@ module Telnyx
1748
1907
  # @param value [String] The value of the custom header
1749
1908
  end
1750
1909
 
1910
+ # Enables Deepfake Detection on the dialed call. When enabled, audio from the
1911
+ # remote party is analyzed to determine whether the voice is AI-generated. Results
1912
+ # are delivered asynchronously via a callback.
1913
+ #
1914
+ # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#deepfake_detection
1915
+ module DeepfakeDetection
1916
+ extend Telnyx::Internal::Type::Enum
1917
+
1918
+ ENABLE = :Enable
1919
+
1920
+ # @!method self.values
1921
+ # @return [Array<Symbol>]
1922
+ end
1923
+
1924
+ # HTTP request type used for `DeepfakeDetectionCallbackUrl`.
1925
+ #
1926
+ # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#deepfake_detection_callback_method
1927
+ module DeepfakeDetectionCallbackMethod
1928
+ extend Telnyx::Internal::Type::Enum
1929
+
1930
+ GET = :GET
1931
+ POST = :POST
1932
+
1933
+ # @!method self.values
1934
+ # @return [Array<Symbol>]
1935
+ end
1936
+
1751
1937
  # Allows you to chose between Premium and Standard detections.
1752
1938
  #
1753
1939
  # @see Telnyx::Models::Texml::Accounts::CallCallsParams::Params::ApplicationDefault#detection_mode
@@ -43,7 +43,7 @@ module Telnyx
43
43
  # Updates the configuration of a specific assistant version. Can not update main
44
44
  # version
45
45
  #
46
- # @overload update(version_id, assistant_id:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
46
+ # @overload update(version_id, assistant_id:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
47
47
  #
48
48
  # @param version_id [String] Path param
49
49
  #
@@ -57,6 +57,10 @@ module Telnyx
57
57
  #
58
58
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>] Body param
59
59
  #
60
+ # @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm] Body param
61
+ #
62
+ # @param fallback_config [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig] Body param
63
+ #
60
64
  # @param greeting [String] Body param: Text that the assistant will use to start the conversation. This may
61
65
  #
62
66
  # @param insight_settings [Telnyx::Models::AI::InsightSettings] Body param
@@ -34,7 +34,7 @@ module Telnyx
34
34
  #
35
35
  # Create a new AI Assistant.
36
36
  #
37
- # @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
37
+ # @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
38
38
  #
39
39
  # @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
40
40
  #
@@ -50,6 +50,10 @@ module Telnyx
50
50
  #
51
51
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
52
52
  #
53
+ # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
54
+ #
55
+ # @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
56
+ #
53
57
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
54
58
  #
55
59
  # @param insight_settings [Telnyx::Models::AI::InsightSettings]
@@ -123,7 +127,7 @@ module Telnyx
123
127
  #
124
128
  # Update an AI Assistant's attributes.
125
129
  #
126
- # @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
130
+ # @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
127
131
  #
128
132
  # @param assistant_id [String]
129
133
  #
@@ -135,6 +139,10 @@ module Telnyx
135
139
  #
136
140
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
137
141
  #
142
+ # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm]
143
+ #
144
+ # @param fallback_config [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig]
145
+ #
138
146
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
139
147
  #
140
148
  # @param insight_settings [Telnyx::Models::AI::InsightSettings]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.86.0"
4
+ VERSION = "5.88.0"
5
5
  end