telnyx 5.97.0 → 5.99.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 (67) 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/assistant_create_params.rb +9 -231
  5. data/lib/telnyx/models/ai/assistant_update_params.rb +9 -231
  6. data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -236
  7. data/lib/telnyx/models/ai/external_llm.rb +89 -0
  8. data/lib/telnyx/models/ai/external_llm_req.rb +89 -0
  9. data/lib/telnyx/models/ai/fallback_config.rb +37 -0
  10. data/lib/telnyx/models/ai/fallback_config_req.rb +37 -0
  11. data/lib/telnyx/models/ai/inference_embedding.rb +9 -234
  12. data/lib/telnyx/models/ai/observability.rb +57 -1
  13. data/lib/telnyx/models/ai/observability_req.rb +57 -1
  14. data/lib/telnyx/models/ai/post_conversation_settings.rb +30 -0
  15. data/lib/telnyx/models/ai/post_conversation_settings_req.rb +30 -0
  16. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +26 -3
  17. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +26 -3
  18. data/lib/telnyx/models/calls/action_speak_params.rb +26 -3
  19. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +26 -3
  20. data/lib/telnyx/models/conferences/action_speak_params.rb +26 -3
  21. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
  22. data/lib/telnyx/resources/ai/assistants.rb +6 -6
  23. data/lib/telnyx/resources/calls/actions.rb +4 -4
  24. data/lib/telnyx/resources/conferences/actions.rb +1 -1
  25. data/lib/telnyx/version.rb +1 -1
  26. data/lib/telnyx.rb +6 -0
  27. data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -463
  28. data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -463
  29. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -469
  30. data/rbi/telnyx/models/ai/external_llm.rbi +161 -0
  31. data/rbi/telnyx/models/ai/external_llm_req.rbi +161 -0
  32. data/rbi/telnyx/models/ai/fallback_config.rbi +64 -0
  33. data/rbi/telnyx/models/ai/fallback_config_req.rbi +64 -0
  34. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -460
  35. data/rbi/telnyx/models/ai/observability.rbi +85 -0
  36. data/rbi/telnyx/models/ai/observability_req.rbi +86 -0
  37. data/rbi/telnyx/models/ai/post_conversation_settings.rbi +45 -0
  38. data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +45 -0
  39. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +50 -5
  40. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +50 -5
  41. data/rbi/telnyx/models/calls/action_speak_params.rbi +50 -5
  42. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +50 -5
  43. data/rbi/telnyx/models/conferences/action_speak_params.rbi +50 -5
  44. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -5
  45. data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
  46. data/rbi/telnyx/resources/calls/actions.rbi +16 -4
  47. data/rbi/telnyx/resources/conferences/actions.rbi +4 -1
  48. data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -205
  49. data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -205
  50. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -205
  51. data/sig/telnyx/models/ai/external_llm.rbs +75 -0
  52. data/sig/telnyx/models/ai/external_llm_req.rbs +75 -0
  53. data/sig/telnyx/models/ai/fallback_config.rbs +38 -0
  54. data/sig/telnyx/models/ai/fallback_config_req.rbs +40 -0
  55. data/sig/telnyx/models/ai/inference_embedding.rbs +17 -206
  56. data/sig/telnyx/models/ai/observability.rbs +41 -0
  57. data/sig/telnyx/models/ai/observability_req.rbs +41 -0
  58. data/sig/telnyx/models/ai/post_conversation_settings.rbs +17 -0
  59. data/sig/telnyx/models/ai/post_conversation_settings_req.rbs +17 -0
  60. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +15 -0
  61. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +15 -0
  62. data/sig/telnyx/models/calls/action_speak_params.rbs +15 -0
  63. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +15 -0
  64. data/sig/telnyx/models/conferences/action_speak_params.rbs +15 -0
  65. data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
  66. data/sig/telnyx/resources/ai/assistants.rbs +6 -6
  67. metadata +20 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 37930142e3066a7e6e12a55c37a5e1fae1b2cb7dc64eeea0e599bc000ae9b811
4
- data.tar.gz: 2f65e5fa943c8329552600511f3e2db68b448810c09432d353299fd64b351e87
3
+ metadata.gz: dc569d102597936e9a6c73c0deaa2511beb3d2febb2c05d76871c72705b02f78
4
+ data.tar.gz: a6842c07dcfeeaec595415dd65ff740767678d05370fb6082c8b1d18ead625fc
5
5
  SHA512:
6
- metadata.gz: a6a51b4037ae476aa1e76c67089174d509ec4906362a9ff8f750cca843c0f2c8e8bcc3d4b78f2e064c8f565452e2e1926bc310647f51c13b3851fab0097a0641
7
- data.tar.gz: 6ed01b6c22abff8014a09d9d1be26ff4bf5af1290e8076586ad5baaf4779efe02f443358d6259ff1ff63d88c5a783280dcef99c66214c88dd9619044f02c4059
6
+ metadata.gz: d9580f23f1138595528cf1af1525245d95a11204c18252628fd7767247f816031646e1ba9dfff94d2e92b7fe2710f231d4dd7814bf2d358428856708795f73a2
7
+ data.tar.gz: f2dd33b1ad31c203390819a10b51e9b5527990302eaf32e252e681e8040be01ebc7a6b815ee6f3b43ae0fc4ae6c62aaa5e70be39675a7c450a40a0a621d67a46
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.99.0 (2026-05-04)
4
+
5
+ Full Changelog: [v5.98.0...v5.99.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.98.0...v5.99.0)
6
+
7
+ ### Features
8
+
9
+ * Add xAI and missing voice providers to Call Control API ([ac7bf88](https://github.com/team-telnyx/telnyx-ruby/commit/ac7bf888359b90cfc3d8cdcbf60fbbf80d0f2bf6))
10
+
11
+ ## 5.98.0 (2026-05-03)
12
+
13
+ Full Changelog: [v5.97.0...v5.98.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.97.0...v5.98.0)
14
+
15
+ ### Features
16
+
17
+ * Update observability ([99e3f4b](https://github.com/team-telnyx/telnyx-ruby/commit/99e3f4b3a421178714aa3f17dae81e306034aba6))
18
+
3
19
  ## 5.97.0 (2026-04-30)
4
20
 
5
21
  Full Changelog: [v5.96.0...v5.97.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.96.0...v5.97.0)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.97.0"
27
+ gem "telnyx", "~> 5.99.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -60,13 +60,13 @@ module Telnyx
60
60
 
61
61
  # @!attribute external_llm
62
62
  #
63
- # @return [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm, nil]
64
- optional :external_llm, -> { Telnyx::AI::AssistantCreateParams::ExternalLlm }
63
+ # @return [Telnyx::Models::AI::ExternalLlmReq, nil]
64
+ optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
65
65
 
66
66
  # @!attribute fallback_config
67
67
  #
68
- # @return [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig, nil]
69
- optional :fallback_config, -> { Telnyx::AI::AssistantCreateParams::FallbackConfig }
68
+ # @return [Telnyx::Models::AI::FallbackConfigReq, nil]
69
+ optional :fallback_config, -> { Telnyx::AI::FallbackConfigReq }
70
70
 
71
71
  # @!attribute greeting
72
72
  # Text that the assistant will use to start the conversation. This may be
@@ -152,8 +152,8 @@ module Telnyx
152
152
  # Telephony-control tools (e.g. hangup, transfer) are unavailable
153
153
  # post-conversation. Beta feature.
154
154
  #
155
- # @return [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings, nil]
156
- optional :post_conversation_settings, -> { Telnyx::AI::AssistantCreateParams::PostConversationSettings }
155
+ # @return [Telnyx::Models::AI::PostConversationSettingsReq, nil]
156
+ optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettingsReq }
157
157
 
158
158
  # @!attribute privacy_settings
159
159
  #
@@ -221,9 +221,9 @@ module Telnyx
221
221
  #
222
222
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
223
223
  #
224
- # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
224
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
225
225
  #
226
- # @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
226
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
227
227
  #
228
228
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
229
229
  #
@@ -243,7 +243,7 @@ module Telnyx
243
243
  #
244
244
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
245
245
  #
246
- # @param post_conversation_settings [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
246
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
247
247
  #
248
248
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
249
249
  #
@@ -263,204 +263,6 @@ module Telnyx
263
263
  #
264
264
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
265
265
 
266
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
267
- # @!attribute base_url
268
- # Base URL for the external LLM endpoint.
269
- #
270
- # @return [String]
271
- required :base_url, String
272
-
273
- # @!attribute model
274
- # Model identifier to use with the external LLM endpoint.
275
- #
276
- # @return [String]
277
- required :model, String
278
-
279
- # @!attribute authentication_method
280
- # Authentication method used when connecting to the external LLM endpoint.
281
- #
282
- # @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod, nil]
283
- optional :authentication_method,
284
- enum: -> { Telnyx::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod }
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 `true`, Telnyx forwards the assistant's dynamic variables to the external
295
- # LLM endpoint as a top-level `extra_metadata` object on the chat completion
296
- # request body. Defaults to `false`. Example payload sent to the external
297
- # endpoint:
298
- # `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
299
- # Distinct from OpenAI's native `metadata` field, which has its own size and type
300
- # limits.
301
- #
302
- # @return [Boolean, nil]
303
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
304
-
305
- # @!attribute llm_api_key_ref
306
- # Integration secret identifier for the external LLM API key.
307
- #
308
- # @return [String, nil]
309
- optional :llm_api_key_ref, String
310
-
311
- # @!attribute token_retrieval_url
312
- # URL used to retrieve an access token when certificate authentication is enabled.
313
- #
314
- # @return [String, nil]
315
- optional :token_retrieval_url, String
316
-
317
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
318
- # Some parameter documentations has been truncated, see
319
- # {Telnyx::Models::AI::AssistantCreateParams::ExternalLlm} for more details.
320
- #
321
- # @param base_url [String] Base URL for the external LLM endpoint.
322
- #
323
- # @param model [String] Model identifier to use with the external LLM endpoint.
324
- #
325
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
326
- #
327
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
328
- #
329
- # @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
330
- #
331
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
332
- #
333
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
334
-
335
- # Authentication method used when connecting to the external LLM endpoint.
336
- #
337
- # @see Telnyx::Models::AI::AssistantCreateParams::ExternalLlm#authentication_method
338
- module AuthenticationMethod
339
- extend Telnyx::Internal::Type::Enum
340
-
341
- TOKEN = :token
342
- CERTIFICATE = :certificate
343
-
344
- # @!method self.values
345
- # @return [Array<Symbol>]
346
- end
347
- end
348
-
349
- class FallbackConfig < Telnyx::Internal::Type::BaseModel
350
- # @!attribute external_llm
351
- #
352
- # @return [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm, nil]
353
- optional :external_llm, -> { Telnyx::AI::AssistantCreateParams::FallbackConfig::ExternalLlm }
354
-
355
- # @!attribute llm_api_key_ref
356
- # Integration secret identifier for the fallback model API key.
357
- #
358
- # @return [String, nil]
359
- optional :llm_api_key_ref, String
360
-
361
- # @!attribute model
362
- # Fallback Telnyx-hosted model to use when the primary LLM provider is
363
- # unavailable.
364
- #
365
- # @return [String, nil]
366
- optional :model, String
367
-
368
- # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
369
- # Some parameter documentations has been truncated, see
370
- # {Telnyx::Models::AI::AssistantCreateParams::FallbackConfig} for more details.
371
- #
372
- # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm]
373
- #
374
- # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
375
- #
376
- # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
377
-
378
- # @see Telnyx::Models::AI::AssistantCreateParams::FallbackConfig#external_llm
379
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
380
- # @!attribute base_url
381
- # Base URL for the external LLM endpoint.
382
- #
383
- # @return [String]
384
- required :base_url, String
385
-
386
- # @!attribute model
387
- # Model identifier to use with the external LLM endpoint.
388
- #
389
- # @return [String]
390
- required :model, String
391
-
392
- # @!attribute authentication_method
393
- # Authentication method used when connecting to the external LLM endpoint.
394
- #
395
- # @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
396
- optional :authentication_method,
397
- enum: -> { Telnyx::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod }
398
-
399
- # @!attribute certificate_ref
400
- # Integration secret identifier for the client certificate used with certificate
401
- # authentication.
402
- #
403
- # @return [String, nil]
404
- optional :certificate_ref, String
405
-
406
- # @!attribute forward_metadata
407
- # When `true`, Telnyx forwards the assistant's dynamic variables to the external
408
- # LLM endpoint as a top-level `extra_metadata` object on the chat completion
409
- # request body. Defaults to `false`. Example payload sent to the external
410
- # endpoint:
411
- # `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
412
- # Distinct from OpenAI's native `metadata` field, which has its own size and type
413
- # limits.
414
- #
415
- # @return [Boolean, nil]
416
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
417
-
418
- # @!attribute llm_api_key_ref
419
- # Integration secret identifier for the external LLM API key.
420
- #
421
- # @return [String, nil]
422
- optional :llm_api_key_ref, String
423
-
424
- # @!attribute token_retrieval_url
425
- # URL used to retrieve an access token when certificate authentication is enabled.
426
- #
427
- # @return [String, nil]
428
- optional :token_retrieval_url, String
429
-
430
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
431
- # Some parameter documentations has been truncated, see
432
- # {Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm} for
433
- # more details.
434
- #
435
- # @param base_url [String] Base URL for the external LLM endpoint.
436
- #
437
- # @param model [String] Model identifier to use with the external LLM endpoint.
438
- #
439
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
440
- #
441
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
442
- #
443
- # @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
444
- #
445
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
446
- #
447
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
448
-
449
- # Authentication method used when connecting to the external LLM endpoint.
450
- #
451
- # @see Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm#authentication_method
452
- module AuthenticationMethod
453
- extend Telnyx::Internal::Type::Enum
454
-
455
- TOKEN = :token
456
- CERTIFICATE = :certificate
457
-
458
- # @!method self.values
459
- # @return [Array<Symbol>]
460
- end
461
- end
462
- end
463
-
464
266
  class Integration < Telnyx::Internal::Type::BaseModel
465
267
  # @!attribute integration_id
466
268
  # Catalog integration ID to attach. This is the `id` from the integrations catalog
@@ -619,30 +421,6 @@ module Telnyx
619
421
  #
620
422
  # @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
621
423
  end
622
-
623
- class PostConversationSettings < Telnyx::Internal::Type::BaseModel
624
- # @!attribute enabled
625
- # Whether post-conversation processing is enabled. When true, the assistant will
626
- # be invoked after the conversation ends to perform any final tool calls. Defaults
627
- # to false.
628
- #
629
- # @return [Boolean, nil]
630
- optional :enabled, Telnyx::Internal::Type::Boolean
631
-
632
- # @!method initialize(enabled: nil)
633
- # Some parameter documentations has been truncated, see
634
- # {Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings} for more
635
- # details.
636
- #
637
- # Configuration for post-conversation processing. When enabled, the assistant
638
- # receives one additional LLM turn after the conversation ends, allowing it to
639
- # execute tool calls such as logging to a CRM or sending a summary. The assistant
640
- # can execute multiple parallel or sequential tools during this phase.
641
- # Telephony-control tools (e.g. hangup, transfer) are unavailable
642
- # post-conversation. Beta feature.
643
- #
644
- # @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
645
- end
646
424
  end
647
425
  end
648
426
  end
@@ -53,13 +53,13 @@ module Telnyx
53
53
 
54
54
  # @!attribute external_llm
55
55
  #
56
- # @return [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm, nil]
57
- optional :external_llm, -> { Telnyx::AI::AssistantUpdateParams::ExternalLlm }
56
+ # @return [Telnyx::Models::AI::ExternalLlmReq, nil]
57
+ optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
58
58
 
59
59
  # @!attribute fallback_config
60
60
  #
61
- # @return [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig, nil]
62
- optional :fallback_config, -> { Telnyx::AI::AssistantUpdateParams::FallbackConfig }
61
+ # @return [Telnyx::Models::AI::FallbackConfigReq, nil]
62
+ optional :fallback_config, -> { Telnyx::AI::FallbackConfigReq }
63
63
 
64
64
  # @!attribute greeting
65
65
  # Text that the assistant will use to start the conversation. This may be
@@ -157,8 +157,8 @@ module Telnyx
157
157
  # Telephony-control tools (e.g. hangup, transfer) are unavailable
158
158
  # post-conversation. Beta feature.
159
159
  #
160
- # @return [Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings, nil]
161
- optional :post_conversation_settings, -> { Telnyx::AI::AssistantUpdateParams::PostConversationSettings }
160
+ # @return [Telnyx::Models::AI::PostConversationSettingsReq, nil]
161
+ optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettingsReq }
162
162
 
163
163
  # @!attribute privacy_settings
164
164
  #
@@ -237,9 +237,9 @@ module Telnyx
237
237
  #
238
238
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
239
239
  #
240
- # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm]
240
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
241
241
  #
242
- # @param fallback_config [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig]
242
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
243
243
  #
244
244
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
245
245
  #
@@ -263,7 +263,7 @@ module Telnyx
263
263
  #
264
264
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
265
265
  #
266
- # @param post_conversation_settings [Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
266
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
267
267
  #
268
268
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
269
269
  #
@@ -287,204 +287,6 @@ module Telnyx
287
287
  #
288
288
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
289
289
 
290
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
291
- # @!attribute base_url
292
- # Base URL for the external LLM endpoint.
293
- #
294
- # @return [String]
295
- required :base_url, String
296
-
297
- # @!attribute model
298
- # Model identifier to use with the external LLM endpoint.
299
- #
300
- # @return [String]
301
- required :model, String
302
-
303
- # @!attribute authentication_method
304
- # Authentication method used when connecting to the external LLM endpoint.
305
- #
306
- # @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm::AuthenticationMethod, nil]
307
- optional :authentication_method,
308
- enum: -> { Telnyx::AI::AssistantUpdateParams::ExternalLlm::AuthenticationMethod }
309
-
310
- # @!attribute certificate_ref
311
- # Integration secret identifier for the client certificate used with certificate
312
- # authentication.
313
- #
314
- # @return [String, nil]
315
- optional :certificate_ref, String
316
-
317
- # @!attribute forward_metadata
318
- # When `true`, Telnyx forwards the assistant's dynamic variables to the external
319
- # LLM endpoint as a top-level `extra_metadata` object on the chat completion
320
- # request body. Defaults to `false`. Example payload sent to the external
321
- # endpoint:
322
- # `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
323
- # Distinct from OpenAI's native `metadata` field, which has its own size and type
324
- # limits.
325
- #
326
- # @return [Boolean, nil]
327
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
328
-
329
- # @!attribute llm_api_key_ref
330
- # Integration secret identifier for the external LLM API key.
331
- #
332
- # @return [String, nil]
333
- optional :llm_api_key_ref, String
334
-
335
- # @!attribute token_retrieval_url
336
- # URL used to retrieve an access token when certificate authentication is enabled.
337
- #
338
- # @return [String, nil]
339
- optional :token_retrieval_url, String
340
-
341
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
342
- # Some parameter documentations has been truncated, see
343
- # {Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm} for more details.
344
- #
345
- # @param base_url [String] Base URL for the external LLM endpoint.
346
- #
347
- # @param model [String] Model identifier to use with the external LLM endpoint.
348
- #
349
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
350
- #
351
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
352
- #
353
- # @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
354
- #
355
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
356
- #
357
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
358
-
359
- # Authentication method used when connecting to the external LLM endpoint.
360
- #
361
- # @see Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm#authentication_method
362
- module AuthenticationMethod
363
- extend Telnyx::Internal::Type::Enum
364
-
365
- TOKEN = :token
366
- CERTIFICATE = :certificate
367
-
368
- # @!method self.values
369
- # @return [Array<Symbol>]
370
- end
371
- end
372
-
373
- class FallbackConfig < Telnyx::Internal::Type::BaseModel
374
- # @!attribute external_llm
375
- #
376
- # @return [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm, nil]
377
- optional :external_llm, -> { Telnyx::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm }
378
-
379
- # @!attribute llm_api_key_ref
380
- # Integration secret identifier for the fallback model API key.
381
- #
382
- # @return [String, nil]
383
- optional :llm_api_key_ref, String
384
-
385
- # @!attribute model
386
- # Fallback Telnyx-hosted model to use when the primary LLM provider is
387
- # unavailable.
388
- #
389
- # @return [String, nil]
390
- optional :model, String
391
-
392
- # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
393
- # Some parameter documentations has been truncated, see
394
- # {Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig} for more details.
395
- #
396
- # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm]
397
- #
398
- # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
399
- #
400
- # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
401
-
402
- # @see Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig#external_llm
403
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
404
- # @!attribute base_url
405
- # Base URL for the external LLM endpoint.
406
- #
407
- # @return [String]
408
- required :base_url, String
409
-
410
- # @!attribute model
411
- # Model identifier to use with the external LLM endpoint.
412
- #
413
- # @return [String]
414
- required :model, String
415
-
416
- # @!attribute authentication_method
417
- # Authentication method used when connecting to the external LLM endpoint.
418
- #
419
- # @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
420
- optional :authentication_method,
421
- enum: -> { Telnyx::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm::AuthenticationMethod }
422
-
423
- # @!attribute certificate_ref
424
- # Integration secret identifier for the client certificate used with certificate
425
- # authentication.
426
- #
427
- # @return [String, nil]
428
- optional :certificate_ref, String
429
-
430
- # @!attribute forward_metadata
431
- # When `true`, Telnyx forwards the assistant's dynamic variables to the external
432
- # LLM endpoint as a top-level `extra_metadata` object on the chat completion
433
- # request body. Defaults to `false`. Example payload sent to the external
434
- # endpoint:
435
- # `{"extra_metadata": {"customer_name": "Jane", "account_id": "acct_789", "telnyx_agent_target": "+13125550100", "telnyx_end_user_target": "+13125550123"}}`.
436
- # Distinct from OpenAI's native `metadata` field, which has its own size and type
437
- # limits.
438
- #
439
- # @return [Boolean, nil]
440
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
441
-
442
- # @!attribute llm_api_key_ref
443
- # Integration secret identifier for the external LLM API key.
444
- #
445
- # @return [String, nil]
446
- optional :llm_api_key_ref, String
447
-
448
- # @!attribute token_retrieval_url
449
- # URL used to retrieve an access token when certificate authentication is enabled.
450
- #
451
- # @return [String, nil]
452
- optional :token_retrieval_url, String
453
-
454
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
455
- # Some parameter documentations has been truncated, see
456
- # {Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm} for
457
- # more details.
458
- #
459
- # @param base_url [String] Base URL for the external LLM endpoint.
460
- #
461
- # @param model [String] Model identifier to use with the external LLM endpoint.
462
- #
463
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
464
- #
465
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
466
- #
467
- # @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
468
- #
469
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
470
- #
471
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
472
-
473
- # Authentication method used when connecting to the external LLM endpoint.
474
- #
475
- # @see Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm#authentication_method
476
- module AuthenticationMethod
477
- extend Telnyx::Internal::Type::Enum
478
-
479
- TOKEN = :token
480
- CERTIFICATE = :certificate
481
-
482
- # @!method self.values
483
- # @return [Array<Symbol>]
484
- end
485
- end
486
- end
487
-
488
290
  class Integration < Telnyx::Internal::Type::BaseModel
489
291
  # @!attribute integration_id
490
292
  # Catalog integration ID to attach. This is the `id` from the integrations catalog
@@ -643,30 +445,6 @@ module Telnyx
643
445
  #
644
446
  # @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
645
447
  end
646
-
647
- class PostConversationSettings < Telnyx::Internal::Type::BaseModel
648
- # @!attribute enabled
649
- # Whether post-conversation processing is enabled. When true, the assistant will
650
- # be invoked after the conversation ends to perform any final tool calls. Defaults
651
- # to false.
652
- #
653
- # @return [Boolean, nil]
654
- optional :enabled, Telnyx::Internal::Type::Boolean
655
-
656
- # @!method initialize(enabled: nil)
657
- # Some parameter documentations has been truncated, see
658
- # {Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings} for more
659
- # details.
660
- #
661
- # Configuration for post-conversation processing. When enabled, the assistant
662
- # receives one additional LLM turn after the conversation ends, allowing it to
663
- # execute tool calls such as logging to a CRM or sending a summary. The assistant
664
- # can execute multiple parallel or sequential tools during this phase.
665
- # Telephony-control tools (e.g. hangup, transfer) are unavailable
666
- # post-conversation. Beta feature.
667
- #
668
- # @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
669
- end
670
448
  end
671
449
  end
672
450
  end