telnyx 5.90.0 → 5.91.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 (42) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +9 -227
  5. data/lib/telnyx/models/ai/assistant_update_params.rb +9 -227
  6. data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -232
  7. data/lib/telnyx/models/ai/external_llm.rb +87 -0
  8. data/lib/telnyx/models/ai/external_llm_req.rb +87 -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 -230
  12. data/lib/telnyx/models/ai/post_conversation_settings.rb +30 -0
  13. data/lib/telnyx/models/ai/post_conversation_settings_req.rb +30 -0
  14. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
  15. data/lib/telnyx/resources/ai/assistants.rb +6 -6
  16. data/lib/telnyx/version.rb +1 -1
  17. data/lib/telnyx.rb +6 -0
  18. data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -455
  19. data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -455
  20. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -461
  21. data/rbi/telnyx/models/ai/external_llm.rbi +157 -0
  22. data/rbi/telnyx/models/ai/external_llm_req.rbi +157 -0
  23. data/rbi/telnyx/models/ai/fallback_config.rbi +64 -0
  24. data/rbi/telnyx/models/ai/fallback_config_req.rbi +64 -0
  25. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -452
  26. data/rbi/telnyx/models/ai/post_conversation_settings.rbi +45 -0
  27. data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +45 -0
  28. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -5
  29. data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
  30. data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -205
  31. data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -205
  32. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -205
  33. data/sig/telnyx/models/ai/external_llm.rbs +75 -0
  34. data/sig/telnyx/models/ai/external_llm_req.rbs +75 -0
  35. data/sig/telnyx/models/ai/fallback_config.rbs +38 -0
  36. data/sig/telnyx/models/ai/fallback_config_req.rbs +40 -0
  37. data/sig/telnyx/models/ai/inference_embedding.rbs +17 -206
  38. data/sig/telnyx/models/ai/post_conversation_settings.rbs +17 -0
  39. data/sig/telnyx/models/ai/post_conversation_settings_req.rbs +17 -0
  40. data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
  41. data/sig/telnyx/resources/ai/assistants.rbs +6 -6
  42. metadata +20 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c7831db6252f7443f94b6b2b33387b62f3cd05bdd417fea3d01d10123e6243b5
4
- data.tar.gz: c2731964c66d934121a13a9c026fcd9ffd49ba747a9c449c58116f27ccd37e9f
3
+ metadata.gz: 1406d358ec66c9dbb87a13bb57b272b3e8856462a92867ee1c6d5a51ebd4381c
4
+ data.tar.gz: 7037897210d20723d8d3f16bfae111114184c0770c24bfdd8739e4cc54b59410
5
5
  SHA512:
6
- metadata.gz: da94381863d975125a701a4c15d2e7a40d0c782302c33f85e6694a69d3cd38a1cf247115dc66c646645c03609eee2cccedd16a02f3adb693487862b41ece3ac7
7
- data.tar.gz: 3faf331ff5ff89c4f4b75b78c131aeee6b546916674d63364b7811e49e0611527d8ad532ec7af77407a3c144559f84885fbdd47ac7e4275439846127f496d1c7
6
+ metadata.gz: 8c2eaa0fbadbb41d46f9fcedf54640c748548628377ad8318390b8e05dd4aa019bfb2ef4bd92c481d883b173f1deb49a75fea74435034a4c4341cac415bd4f0d
7
+ data.tar.gz: 1ebb5ca97887c4573d9a88214c5d33a375053f5f62dd4e014751f7a26a0d8334c38ba088a5a92c04480f2026fa9179fd128b4388b66eedbfe45a1e145517881f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.91.0 (2026-04-29)
4
+
5
+ Full Changelog: [v5.90.0...v5.91.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.90.0...v5.91.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** manual updates ([6728962](https://github.com/team-telnyx/telnyx-ruby/commit/67289626f38bab94be5678e7ab50cba1fed10eeb))
10
+
3
11
  ## 5.90.0 (2026-04-28)
4
12
 
5
13
  Full Changelog: [v5.89.0...v5.90.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.89.0...v5.90.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.90.0"
27
+ gem "telnyx", "~> 5.91.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -55,13 +55,13 @@ module Telnyx
55
55
 
56
56
  # @!attribute external_llm
57
57
  #
58
- # @return [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm, nil]
59
- optional :external_llm, -> { Telnyx::AI::AssistantCreateParams::ExternalLlm }
58
+ # @return [Telnyx::Models::AI::ExternalLlmReq, nil]
59
+ optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
60
60
 
61
61
  # @!attribute fallback_config
62
62
  #
63
- # @return [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig, nil]
64
- optional :fallback_config, -> { Telnyx::AI::AssistantCreateParams::FallbackConfig }
63
+ # @return [Telnyx::Models::AI::FallbackConfigReq, nil]
64
+ optional :fallback_config, -> { Telnyx::AI::FallbackConfigReq }
65
65
 
66
66
  # @!attribute greeting
67
67
  # Text that the assistant will use to start the conversation. This may be
@@ -107,8 +107,8 @@ module Telnyx
107
107
  # Telephony-control tools (e.g. hangup, transfer) are unavailable
108
108
  # post-conversation. Beta feature.
109
109
  #
110
- # @return [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings, nil]
111
- optional :post_conversation_settings, -> { Telnyx::AI::AssistantCreateParams::PostConversationSettings }
110
+ # @return [Telnyx::Models::AI::PostConversationSettingsReq, nil]
111
+ optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettingsReq }
112
112
 
113
113
  # @!attribute privacy_settings
114
114
  #
@@ -166,9 +166,9 @@ module Telnyx
166
166
  #
167
167
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
168
168
  #
169
- # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
169
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
170
170
  #
171
- # @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
171
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
172
172
  #
173
173
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
174
174
  #
@@ -180,7 +180,7 @@ module Telnyx
180
180
  #
181
181
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
182
182
  #
183
- # @param post_conversation_settings [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
183
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
184
184
  #
185
185
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
186
186
  #
@@ -197,224 +197,6 @@ module Telnyx
197
197
  # @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
198
198
  #
199
199
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
200
-
201
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
202
- # @!attribute base_url
203
- # Base URL for the external LLM endpoint.
204
- #
205
- # @return [String]
206
- required :base_url, String
207
-
208
- # @!attribute model
209
- # Model identifier to use with the external LLM endpoint.
210
- #
211
- # @return [String]
212
- required :model, String
213
-
214
- # @!attribute authentication_method
215
- # Authentication method used when connecting to the external LLM endpoint.
216
- #
217
- # @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod, nil]
218
- optional :authentication_method,
219
- enum: -> { Telnyx::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod }
220
-
221
- # @!attribute certificate_ref
222
- # Integration secret identifier for the client certificate used with certificate
223
- # authentication.
224
- #
225
- # @return [String, nil]
226
- optional :certificate_ref, String
227
-
228
- # @!attribute forward_metadata
229
- # When enabled, Telnyx forwards the assistant's dynamic variables to the external
230
- # LLM endpoint. Defaults to false. The chat completion request includes a
231
- # top-level `extra_metadata` object when dynamic variables are available. For
232
- # example:
233
- # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
234
- #
235
- # @return [Boolean, nil]
236
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
237
-
238
- # @!attribute llm_api_key_ref
239
- # Integration secret identifier for the external LLM API key.
240
- #
241
- # @return [String, nil]
242
- optional :llm_api_key_ref, String
243
-
244
- # @!attribute token_retrieval_url
245
- # URL used to retrieve an access token when certificate authentication is enabled.
246
- #
247
- # @return [String, nil]
248
- optional :token_retrieval_url, String
249
-
250
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
251
- # Some parameter documentations has been truncated, see
252
- # {Telnyx::Models::AI::AssistantCreateParams::ExternalLlm} for more details.
253
- #
254
- # @param base_url [String] Base URL for the external LLM endpoint.
255
- #
256
- # @param model [String] Model identifier to use with the external LLM endpoint.
257
- #
258
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantCreateParams::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
259
- #
260
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
261
- #
262
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
263
- #
264
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
265
- #
266
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
267
-
268
- # Authentication method used when connecting to the external LLM endpoint.
269
- #
270
- # @see Telnyx::Models::AI::AssistantCreateParams::ExternalLlm#authentication_method
271
- module AuthenticationMethod
272
- extend Telnyx::Internal::Type::Enum
273
-
274
- TOKEN = :token
275
- CERTIFICATE = :certificate
276
-
277
- # @!method self.values
278
- # @return [Array<Symbol>]
279
- end
280
- end
281
-
282
- class FallbackConfig < Telnyx::Internal::Type::BaseModel
283
- # @!attribute external_llm
284
- #
285
- # @return [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm, nil]
286
- optional :external_llm, -> { Telnyx::AI::AssistantCreateParams::FallbackConfig::ExternalLlm }
287
-
288
- # @!attribute llm_api_key_ref
289
- # Integration secret identifier for the fallback model API key.
290
- #
291
- # @return [String, nil]
292
- optional :llm_api_key_ref, String
293
-
294
- # @!attribute model
295
- # Fallback Telnyx-hosted model to use when the primary LLM provider is
296
- # unavailable.
297
- #
298
- # @return [String, nil]
299
- optional :model, String
300
-
301
- # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
302
- # Some parameter documentations has been truncated, see
303
- # {Telnyx::Models::AI::AssistantCreateParams::FallbackConfig} for more details.
304
- #
305
- # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm]
306
- #
307
- # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
308
- #
309
- # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
310
-
311
- # @see Telnyx::Models::AI::AssistantCreateParams::FallbackConfig#external_llm
312
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
313
- # @!attribute base_url
314
- # Base URL for the external LLM endpoint.
315
- #
316
- # @return [String]
317
- required :base_url, String
318
-
319
- # @!attribute model
320
- # Model identifier to use with the external LLM endpoint.
321
- #
322
- # @return [String]
323
- required :model, String
324
-
325
- # @!attribute authentication_method
326
- # Authentication method used when connecting to the external LLM endpoint.
327
- #
328
- # @return [Symbol, Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
329
- optional :authentication_method,
330
- enum: -> { Telnyx::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod }
331
-
332
- # @!attribute certificate_ref
333
- # Integration secret identifier for the client certificate used with certificate
334
- # authentication.
335
- #
336
- # @return [String, nil]
337
- optional :certificate_ref, String
338
-
339
- # @!attribute forward_metadata
340
- # When enabled, Telnyx forwards the assistant's dynamic variables to the external
341
- # LLM endpoint. Defaults to false. The chat completion request includes a
342
- # top-level `extra_metadata` object when dynamic variables are available. For
343
- # example:
344
- # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
345
- #
346
- # @return [Boolean, nil]
347
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
348
-
349
- # @!attribute llm_api_key_ref
350
- # Integration secret identifier for the external LLM API key.
351
- #
352
- # @return [String, nil]
353
- optional :llm_api_key_ref, String
354
-
355
- # @!attribute token_retrieval_url
356
- # URL used to retrieve an access token when certificate authentication is enabled.
357
- #
358
- # @return [String, nil]
359
- optional :token_retrieval_url, String
360
-
361
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
362
- # Some parameter documentations has been truncated, see
363
- # {Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm} for
364
- # more details.
365
- #
366
- # @param base_url [String] Base URL for the external LLM endpoint.
367
- #
368
- # @param model [String] Model identifier to use with the external LLM endpoint.
369
- #
370
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
371
- #
372
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
373
- #
374
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
375
- #
376
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
377
- #
378
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
379
-
380
- # Authentication method used when connecting to the external LLM endpoint.
381
- #
382
- # @see Telnyx::Models::AI::AssistantCreateParams::FallbackConfig::ExternalLlm#authentication_method
383
- module AuthenticationMethod
384
- extend Telnyx::Internal::Type::Enum
385
-
386
- TOKEN = :token
387
- CERTIFICATE = :certificate
388
-
389
- # @!method self.values
390
- # @return [Array<Symbol>]
391
- end
392
- end
393
- end
394
-
395
- class PostConversationSettings < Telnyx::Internal::Type::BaseModel
396
- # @!attribute enabled
397
- # Whether post-conversation processing is enabled. When true, the assistant will
398
- # be invoked after the conversation ends to perform any final tool calls. Defaults
399
- # to false.
400
- #
401
- # @return [Boolean, nil]
402
- optional :enabled, Telnyx::Internal::Type::Boolean
403
-
404
- # @!method initialize(enabled: nil)
405
- # Some parameter documentations has been truncated, see
406
- # {Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings} for more
407
- # details.
408
- #
409
- # Configuration for post-conversation processing. When enabled, the assistant
410
- # receives one additional LLM turn after the conversation ends, allowing it to
411
- # execute tool calls such as logging to a CRM or sending a summary. The assistant
412
- # can execute multiple parallel or sequential tools during this phase.
413
- # Telephony-control tools (e.g. hangup, transfer) are unavailable
414
- # post-conversation. Beta feature.
415
- #
416
- # @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
417
- end
418
200
  end
419
201
  end
420
202
  end
@@ -40,13 +40,13 @@ module Telnyx
40
40
 
41
41
  # @!attribute external_llm
42
42
  #
43
- # @return [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm, nil]
44
- optional :external_llm, -> { Telnyx::AI::AssistantUpdateParams::ExternalLlm }
43
+ # @return [Telnyx::Models::AI::ExternalLlmReq, nil]
44
+ optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
45
45
 
46
46
  # @!attribute fallback_config
47
47
  #
48
- # @return [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig, nil]
49
- optional :fallback_config, -> { Telnyx::AI::AssistantUpdateParams::FallbackConfig }
48
+ # @return [Telnyx::Models::AI::FallbackConfigReq, nil]
49
+ optional :fallback_config, -> { Telnyx::AI::FallbackConfigReq }
50
50
 
51
51
  # @!attribute greeting
52
52
  # Text that the assistant will use to start the conversation. This may be
@@ -112,8 +112,8 @@ module Telnyx
112
112
  # Telephony-control tools (e.g. hangup, transfer) are unavailable
113
113
  # post-conversation. Beta feature.
114
114
  #
115
- # @return [Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings, nil]
116
- optional :post_conversation_settings, -> { Telnyx::AI::AssistantUpdateParams::PostConversationSettings }
115
+ # @return [Telnyx::Models::AI::PostConversationSettingsReq, nil]
116
+ optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettingsReq }
117
117
 
118
118
  # @!attribute privacy_settings
119
119
  #
@@ -174,9 +174,9 @@ module Telnyx
174
174
  #
175
175
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
176
176
  #
177
- # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm]
177
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
178
178
  #
179
- # @param fallback_config [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig]
179
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
180
180
  #
181
181
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
182
182
  #
@@ -194,7 +194,7 @@ module Telnyx
194
194
  #
195
195
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
196
196
  #
197
- # @param post_conversation_settings [Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
197
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
198
198
  #
199
199
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
200
200
  #
@@ -213,224 +213,6 @@ module Telnyx
213
213
  # @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
214
214
  #
215
215
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
216
-
217
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
218
- # @!attribute base_url
219
- # Base URL for the external LLM endpoint.
220
- #
221
- # @return [String]
222
- required :base_url, String
223
-
224
- # @!attribute model
225
- # Model identifier to use with the external LLM endpoint.
226
- #
227
- # @return [String]
228
- required :model, String
229
-
230
- # @!attribute authentication_method
231
- # Authentication method used when connecting to the external LLM endpoint.
232
- #
233
- # @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm::AuthenticationMethod, nil]
234
- optional :authentication_method,
235
- enum: -> { Telnyx::AI::AssistantUpdateParams::ExternalLlm::AuthenticationMethod }
236
-
237
- # @!attribute certificate_ref
238
- # Integration secret identifier for the client certificate used with certificate
239
- # authentication.
240
- #
241
- # @return [String, nil]
242
- optional :certificate_ref, String
243
-
244
- # @!attribute forward_metadata
245
- # When enabled, Telnyx forwards the assistant's dynamic variables to the external
246
- # LLM endpoint. Defaults to false. The chat completion request includes a
247
- # top-level `extra_metadata` object when dynamic variables are available. For
248
- # example:
249
- # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
250
- #
251
- # @return [Boolean, nil]
252
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
253
-
254
- # @!attribute llm_api_key_ref
255
- # Integration secret identifier for the external LLM API key.
256
- #
257
- # @return [String, nil]
258
- optional :llm_api_key_ref, String
259
-
260
- # @!attribute token_retrieval_url
261
- # URL used to retrieve an access token when certificate authentication is enabled.
262
- #
263
- # @return [String, nil]
264
- optional :token_retrieval_url, String
265
-
266
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
267
- # Some parameter documentations has been truncated, see
268
- # {Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm} for more details.
269
- #
270
- # @param base_url [String] Base URL for the external LLM endpoint.
271
- #
272
- # @param model [String] Model identifier to use with the external LLM endpoint.
273
- #
274
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
275
- #
276
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
277
- #
278
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
279
- #
280
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
281
- #
282
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
283
-
284
- # Authentication method used when connecting to the external LLM endpoint.
285
- #
286
- # @see Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm#authentication_method
287
- module AuthenticationMethod
288
- extend Telnyx::Internal::Type::Enum
289
-
290
- TOKEN = :token
291
- CERTIFICATE = :certificate
292
-
293
- # @!method self.values
294
- # @return [Array<Symbol>]
295
- end
296
- end
297
-
298
- class FallbackConfig < Telnyx::Internal::Type::BaseModel
299
- # @!attribute external_llm
300
- #
301
- # @return [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm, nil]
302
- optional :external_llm, -> { Telnyx::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm }
303
-
304
- # @!attribute llm_api_key_ref
305
- # Integration secret identifier for the fallback model API key.
306
- #
307
- # @return [String, nil]
308
- optional :llm_api_key_ref, String
309
-
310
- # @!attribute model
311
- # Fallback Telnyx-hosted model to use when the primary LLM provider is
312
- # unavailable.
313
- #
314
- # @return [String, nil]
315
- optional :model, String
316
-
317
- # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
318
- # Some parameter documentations has been truncated, see
319
- # {Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig} for more details.
320
- #
321
- # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm]
322
- #
323
- # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
324
- #
325
- # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
326
-
327
- # @see Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig#external_llm
328
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
329
- # @!attribute base_url
330
- # Base URL for the external LLM endpoint.
331
- #
332
- # @return [String]
333
- required :base_url, String
334
-
335
- # @!attribute model
336
- # Model identifier to use with the external LLM endpoint.
337
- #
338
- # @return [String]
339
- required :model, String
340
-
341
- # @!attribute authentication_method
342
- # Authentication method used when connecting to the external LLM endpoint.
343
- #
344
- # @return [Symbol, Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
345
- optional :authentication_method,
346
- enum: -> { Telnyx::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm::AuthenticationMethod }
347
-
348
- # @!attribute certificate_ref
349
- # Integration secret identifier for the client certificate used with certificate
350
- # authentication.
351
- #
352
- # @return [String, nil]
353
- optional :certificate_ref, String
354
-
355
- # @!attribute forward_metadata
356
- # When enabled, Telnyx forwards the assistant's dynamic variables to the external
357
- # LLM endpoint. Defaults to false. The chat completion request includes a
358
- # top-level `extra_metadata` object when dynamic variables are available. For
359
- # example:
360
- # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
361
- #
362
- # @return [Boolean, nil]
363
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
364
-
365
- # @!attribute llm_api_key_ref
366
- # Integration secret identifier for the external LLM API key.
367
- #
368
- # @return [String, nil]
369
- optional :llm_api_key_ref, String
370
-
371
- # @!attribute token_retrieval_url
372
- # URL used to retrieve an access token when certificate authentication is enabled.
373
- #
374
- # @return [String, nil]
375
- optional :token_retrieval_url, String
376
-
377
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
378
- # Some parameter documentations has been truncated, see
379
- # {Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm} for
380
- # more details.
381
- #
382
- # @param base_url [String] Base URL for the external LLM endpoint.
383
- #
384
- # @param model [String] Model identifier to use with the external LLM endpoint.
385
- #
386
- # @param authentication_method [Symbol, Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
387
- #
388
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
389
- #
390
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
391
- #
392
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
393
- #
394
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
395
-
396
- # Authentication method used when connecting to the external LLM endpoint.
397
- #
398
- # @see Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig::ExternalLlm#authentication_method
399
- module AuthenticationMethod
400
- extend Telnyx::Internal::Type::Enum
401
-
402
- TOKEN = :token
403
- CERTIFICATE = :certificate
404
-
405
- # @!method self.values
406
- # @return [Array<Symbol>]
407
- end
408
- end
409
- end
410
-
411
- class PostConversationSettings < Telnyx::Internal::Type::BaseModel
412
- # @!attribute enabled
413
- # Whether post-conversation processing is enabled. When true, the assistant will
414
- # be invoked after the conversation ends to perform any final tool calls. Defaults
415
- # to false.
416
- #
417
- # @return [Boolean, nil]
418
- optional :enabled, Telnyx::Internal::Type::Boolean
419
-
420
- # @!method initialize(enabled: nil)
421
- # Some parameter documentations has been truncated, see
422
- # {Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings} for more
423
- # details.
424
- #
425
- # Configuration for post-conversation processing. When enabled, the assistant
426
- # receives one additional LLM turn after the conversation ends, allowing it to
427
- # execute tool calls such as logging to a CRM or sending a summary. The assistant
428
- # can execute multiple parallel or sequential tools during this phase.
429
- # Telephony-control tools (e.g. hangup, transfer) are unavailable
430
- # post-conversation. Beta feature.
431
- #
432
- # @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
433
- end
434
216
  end
435
217
  end
436
218
  end