telnyx 5.87.0 → 5.89.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 (28) 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/resources/ai/assistants/versions.rb +5 -1
  11. data/lib/telnyx/resources/ai/assistants.rb +10 -2
  12. data/lib/telnyx/version.rb +1 -1
  13. data/rbi/telnyx/models/ai/assistant_create_params.rbi +419 -0
  14. data/rbi/telnyx/models/ai/assistant_update_params.rbi +419 -0
  15. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +425 -0
  16. data/rbi/telnyx/models/ai/inference_embedding.rbi +415 -0
  17. data/rbi/telnyx/models/ai/transcription_settings.rbi +11 -5
  18. data/rbi/telnyx/models/call_assistant_request.rbi +416 -8
  19. data/rbi/telnyx/resources/ai/assistants/versions.rbi +8 -0
  20. data/rbi/telnyx/resources/ai/assistants.rbi +12 -0
  21. data/sig/telnyx/models/ai/assistant_create_params.rbs +193 -0
  22. data/sig/telnyx/models/ai/assistant_update_params.rbs +193 -0
  23. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +193 -0
  24. data/sig/telnyx/models/ai/inference_embedding.rbs +193 -0
  25. data/sig/telnyx/models/call_assistant_request.rbs +197 -10
  26. data/sig/telnyx/resources/ai/assistants/versions.rbs +2 -0
  27. data/sig/telnyx/resources/ai/assistants.rbs +4 -0
  28. metadata +1 -1
@@ -30,6 +30,16 @@ module Telnyx
30
30
  # @return [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>, nil]
31
31
  optional :enabled_features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::EnabledFeatures] }
32
32
 
33
+ # @!attribute external_llm
34
+ #
35
+ # @return [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm, nil]
36
+ optional :external_llm, -> { Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm }
37
+
38
+ # @!attribute fallback_config
39
+ #
40
+ # @return [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig, nil]
41
+ optional :fallback_config, -> { Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig }
42
+
33
43
  # @!attribute greeting
34
44
  # Text that the assistant will use to start the conversation. This may be
35
45
  # templated with
@@ -136,7 +146,7 @@ module Telnyx
136
146
  # @return [Telnyx::Models::AI::WidgetSettings, nil]
137
147
  optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
138
148
 
139
- # @!method initialize(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)
149
+ # @!method initialize(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)
140
150
  # Some parameter documentations has been truncated, see
141
151
  # {Telnyx::Models::AI::Assistants::UpdateAssistant} for more details.
142
152
  #
@@ -148,6 +158,10 @@ module Telnyx
148
158
  #
149
159
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
150
160
  #
161
+ # @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm]
162
+ #
163
+ # @param fallback_config [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig]
164
+ #
151
165
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
152
166
  #
153
167
  # @param insight_settings [Telnyx::Models::AI::InsightSettings]
@@ -180,6 +194,203 @@ module Telnyx
180
194
  #
181
195
  # @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
182
196
 
197
+ # @see Telnyx::Models::AI::Assistants::UpdateAssistant#external_llm
198
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
199
+ # @!attribute base_url
200
+ # Base URL for the external LLM endpoint.
201
+ #
202
+ # @return [String]
203
+ required :base_url, String
204
+
205
+ # @!attribute model
206
+ # Model identifier to use with the external LLM endpoint.
207
+ #
208
+ # @return [String]
209
+ required :model, String
210
+
211
+ # @!attribute authentication_method
212
+ # Authentication method used when connecting to the external LLM endpoint.
213
+ #
214
+ # @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod, nil]
215
+ optional :authentication_method,
216
+ enum: -> { Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod }
217
+
218
+ # @!attribute certificate_ref
219
+ # Integration secret identifier for the client certificate used with certificate
220
+ # authentication.
221
+ #
222
+ # @return [String, nil]
223
+ optional :certificate_ref, String
224
+
225
+ # @!attribute forward_metadata
226
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
227
+ # LLM endpoint. Defaults to false. The chat completion request includes a
228
+ # top-level `extra_metadata` object when dynamic variables are available. For
229
+ # example:
230
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
231
+ #
232
+ # @return [Boolean, nil]
233
+ optional :forward_metadata, Telnyx::Internal::Type::Boolean
234
+
235
+ # @!attribute llm_api_key_ref
236
+ # Integration secret identifier for the external LLM API key.
237
+ #
238
+ # @return [String, nil]
239
+ optional :llm_api_key_ref, String
240
+
241
+ # @!attribute token_retrieval_url
242
+ # URL used to retrieve an access token when certificate authentication is enabled.
243
+ #
244
+ # @return [String, nil]
245
+ optional :token_retrieval_url, String
246
+
247
+ # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
248
+ # Some parameter documentations has been truncated, see
249
+ # {Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm} for more details.
250
+ #
251
+ # @param base_url [String] Base URL for the external LLM endpoint.
252
+ #
253
+ # @param model [String] Model identifier to use with the external LLM endpoint.
254
+ #
255
+ # @param authentication_method [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
256
+ #
257
+ # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
258
+ #
259
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
260
+ #
261
+ # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
262
+ #
263
+ # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
264
+
265
+ # Authentication method used when connecting to the external LLM endpoint.
266
+ #
267
+ # @see Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm#authentication_method
268
+ module AuthenticationMethod
269
+ extend Telnyx::Internal::Type::Enum
270
+
271
+ TOKEN = :token
272
+ CERTIFICATE = :certificate
273
+
274
+ # @!method self.values
275
+ # @return [Array<Symbol>]
276
+ end
277
+ end
278
+
279
+ # @see Telnyx::Models::AI::Assistants::UpdateAssistant#fallback_config
280
+ class FallbackConfig < Telnyx::Internal::Type::BaseModel
281
+ # @!attribute external_llm
282
+ #
283
+ # @return [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm, nil]
284
+ optional :external_llm, -> { Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm }
285
+
286
+ # @!attribute llm_api_key_ref
287
+ # Integration secret identifier for the fallback model API key.
288
+ #
289
+ # @return [String, nil]
290
+ optional :llm_api_key_ref, String
291
+
292
+ # @!attribute model
293
+ # Fallback Telnyx-hosted model to use when the primary LLM provider is
294
+ # unavailable.
295
+ #
296
+ # @return [String, nil]
297
+ optional :model, String
298
+
299
+ # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
300
+ # Some parameter documentations has been truncated, see
301
+ # {Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig} for more
302
+ # details.
303
+ #
304
+ # @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm]
305
+ #
306
+ # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
307
+ #
308
+ # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
309
+
310
+ # @see Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig#external_llm
311
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
312
+ # @!attribute base_url
313
+ # Base URL for the external LLM endpoint.
314
+ #
315
+ # @return [String]
316
+ required :base_url, String
317
+
318
+ # @!attribute model
319
+ # Model identifier to use with the external LLM endpoint.
320
+ #
321
+ # @return [String]
322
+ required :model, String
323
+
324
+ # @!attribute authentication_method
325
+ # Authentication method used when connecting to the external LLM endpoint.
326
+ #
327
+ # @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
328
+ optional :authentication_method,
329
+ enum: -> { Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod }
330
+
331
+ # @!attribute certificate_ref
332
+ # Integration secret identifier for the client certificate used with certificate
333
+ # authentication.
334
+ #
335
+ # @return [String, nil]
336
+ optional :certificate_ref, String
337
+
338
+ # @!attribute forward_metadata
339
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
340
+ # LLM endpoint. Defaults to false. The chat completion request includes a
341
+ # top-level `extra_metadata` object when dynamic variables are available. For
342
+ # example:
343
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
344
+ #
345
+ # @return [Boolean, nil]
346
+ optional :forward_metadata, Telnyx::Internal::Type::Boolean
347
+
348
+ # @!attribute llm_api_key_ref
349
+ # Integration secret identifier for the external LLM API key.
350
+ #
351
+ # @return [String, nil]
352
+ optional :llm_api_key_ref, String
353
+
354
+ # @!attribute token_retrieval_url
355
+ # URL used to retrieve an access token when certificate authentication is enabled.
356
+ #
357
+ # @return [String, nil]
358
+ optional :token_retrieval_url, String
359
+
360
+ # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
361
+ # Some parameter documentations has been truncated, see
362
+ # {Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm}
363
+ # for more details.
364
+ #
365
+ # @param base_url [String] Base URL for the external LLM endpoint.
366
+ #
367
+ # @param model [String] Model identifier to use with the external LLM endpoint.
368
+ #
369
+ # @param authentication_method [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
370
+ #
371
+ # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
372
+ #
373
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
374
+ #
375
+ # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
376
+ #
377
+ # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
378
+
379
+ # Authentication method used when connecting to the external LLM endpoint.
380
+ #
381
+ # @see Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm#authentication_method
382
+ module AuthenticationMethod
383
+ extend Telnyx::Internal::Type::Enum
384
+
385
+ TOKEN = :token
386
+ CERTIFICATE = :certificate
387
+
388
+ # @!method self.values
389
+ # @return [Array<Symbol>]
390
+ end
391
+ end
392
+ end
393
+
183
394
  # @see Telnyx::Models::AI::Assistants::UpdateAssistant#post_conversation_settings
184
395
  class PostConversationSettings < Telnyx::Internal::Type::BaseModel
185
396
  # @!attribute enabled
@@ -60,6 +60,16 @@ module Telnyx
60
60
  # @return [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>, nil]
61
61
  optional :enabled_features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::EnabledFeatures] }
62
62
 
63
+ # @!attribute external_llm
64
+ #
65
+ # @return [Telnyx::Models::AI::InferenceEmbedding::ExternalLlm, nil]
66
+ optional :external_llm, -> { Telnyx::AI::InferenceEmbedding::ExternalLlm }
67
+
68
+ # @!attribute fallback_config
69
+ #
70
+ # @return [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig, nil]
71
+ optional :fallback_config, -> { Telnyx::AI::InferenceEmbedding::FallbackConfig }
72
+
63
73
  # @!attribute greeting
64
74
  # Text that the assistant will use to start the conversation. This may be
65
75
  # templated with
@@ -145,7 +155,7 @@ module Telnyx
145
155
  # @return [Telnyx::Models::AI::WidgetSettings, nil]
146
156
  optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
147
157
 
148
- # @!method initialize(id:, created_at:, instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, import_metadata: 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, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
158
+ # @!method initialize(id:, created_at:, instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, import_metadata: 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, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
149
159
  # Some parameter documentations has been truncated, see
150
160
  # {Telnyx::Models::AI::InferenceEmbedding} for more details.
151
161
  #
@@ -167,6 +177,10 @@ module Telnyx
167
177
  #
168
178
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
169
179
  #
180
+ # @param external_llm [Telnyx::Models::AI::InferenceEmbedding::ExternalLlm]
181
+ #
182
+ # @param fallback_config [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig]
183
+ #
170
184
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
171
185
  #
172
186
  # @param import_metadata [Telnyx::Models::AI::ImportMetadata]
@@ -193,6 +207,202 @@ module Telnyx
193
207
  #
194
208
  # @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
195
209
 
210
+ # @see Telnyx::Models::AI::InferenceEmbedding#external_llm
211
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
212
+ # @!attribute base_url
213
+ # Base URL for the external LLM endpoint.
214
+ #
215
+ # @return [String]
216
+ required :base_url, String
217
+
218
+ # @!attribute model
219
+ # Model identifier to use with the external LLM endpoint.
220
+ #
221
+ # @return [String]
222
+ required :model, String
223
+
224
+ # @!attribute authentication_method
225
+ # Authentication method used when connecting to the external LLM endpoint.
226
+ #
227
+ # @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod, nil]
228
+ optional :authentication_method,
229
+ enum: -> { Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod }
230
+
231
+ # @!attribute certificate_ref
232
+ # Integration secret identifier for the client certificate used with certificate
233
+ # authentication.
234
+ #
235
+ # @return [String, nil]
236
+ optional :certificate_ref, String
237
+
238
+ # @!attribute forward_metadata
239
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
240
+ # LLM endpoint. Defaults to false. The chat completion request includes a
241
+ # top-level `extra_metadata` object when dynamic variables are available. For
242
+ # example:
243
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
244
+ #
245
+ # @return [Boolean, nil]
246
+ optional :forward_metadata, Telnyx::Internal::Type::Boolean
247
+
248
+ # @!attribute llm_api_key_ref
249
+ # Integration secret identifier for the external LLM API key.
250
+ #
251
+ # @return [String, nil]
252
+ optional :llm_api_key_ref, String
253
+
254
+ # @!attribute token_retrieval_url
255
+ # URL used to retrieve an access token when certificate authentication is enabled.
256
+ #
257
+ # @return [String, nil]
258
+ optional :token_retrieval_url, String
259
+
260
+ # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
261
+ # Some parameter documentations has been truncated, see
262
+ # {Telnyx::Models::AI::InferenceEmbedding::ExternalLlm} for more details.
263
+ #
264
+ # @param base_url [String] Base URL for the external LLM endpoint.
265
+ #
266
+ # @param model [String] Model identifier to use with the external LLM endpoint.
267
+ #
268
+ # @param authentication_method [Symbol, Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
269
+ #
270
+ # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
271
+ #
272
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
273
+ #
274
+ # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
275
+ #
276
+ # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
277
+
278
+ # Authentication method used when connecting to the external LLM endpoint.
279
+ #
280
+ # @see Telnyx::Models::AI::InferenceEmbedding::ExternalLlm#authentication_method
281
+ module AuthenticationMethod
282
+ extend Telnyx::Internal::Type::Enum
283
+
284
+ TOKEN = :token
285
+ CERTIFICATE = :certificate
286
+
287
+ # @!method self.values
288
+ # @return [Array<Symbol>]
289
+ end
290
+ end
291
+
292
+ # @see Telnyx::Models::AI::InferenceEmbedding#fallback_config
293
+ class FallbackConfig < Telnyx::Internal::Type::BaseModel
294
+ # @!attribute external_llm
295
+ #
296
+ # @return [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm, nil]
297
+ optional :external_llm, -> { Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm }
298
+
299
+ # @!attribute llm_api_key_ref
300
+ # Integration secret identifier for the fallback model API key.
301
+ #
302
+ # @return [String, nil]
303
+ optional :llm_api_key_ref, String
304
+
305
+ # @!attribute model
306
+ # Fallback Telnyx-hosted model to use when the primary LLM provider is
307
+ # unavailable.
308
+ #
309
+ # @return [String, nil]
310
+ optional :model, String
311
+
312
+ # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
313
+ # Some parameter documentations has been truncated, see
314
+ # {Telnyx::Models::AI::InferenceEmbedding::FallbackConfig} for more details.
315
+ #
316
+ # @param external_llm [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm]
317
+ #
318
+ # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
319
+ #
320
+ # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
321
+
322
+ # @see Telnyx::Models::AI::InferenceEmbedding::FallbackConfig#external_llm
323
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
324
+ # @!attribute base_url
325
+ # Base URL for the external LLM endpoint.
326
+ #
327
+ # @return [String]
328
+ required :base_url, String
329
+
330
+ # @!attribute model
331
+ # Model identifier to use with the external LLM endpoint.
332
+ #
333
+ # @return [String]
334
+ required :model, String
335
+
336
+ # @!attribute authentication_method
337
+ # Authentication method used when connecting to the external LLM endpoint.
338
+ #
339
+ # @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
340
+ optional :authentication_method,
341
+ enum: -> { Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod }
342
+
343
+ # @!attribute certificate_ref
344
+ # Integration secret identifier for the client certificate used with certificate
345
+ # authentication.
346
+ #
347
+ # @return [String, nil]
348
+ optional :certificate_ref, String
349
+
350
+ # @!attribute forward_metadata
351
+ # When enabled, Telnyx forwards the assistant's dynamic variables to the external
352
+ # LLM endpoint. Defaults to false. The chat completion request includes a
353
+ # top-level `extra_metadata` object when dynamic variables are available. For
354
+ # example:
355
+ # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
356
+ #
357
+ # @return [Boolean, nil]
358
+ optional :forward_metadata, Telnyx::Internal::Type::Boolean
359
+
360
+ # @!attribute llm_api_key_ref
361
+ # Integration secret identifier for the external LLM API key.
362
+ #
363
+ # @return [String, nil]
364
+ optional :llm_api_key_ref, String
365
+
366
+ # @!attribute token_retrieval_url
367
+ # URL used to retrieve an access token when certificate authentication is enabled.
368
+ #
369
+ # @return [String, nil]
370
+ optional :token_retrieval_url, String
371
+
372
+ # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
373
+ # Some parameter documentations has been truncated, see
374
+ # {Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm} for more
375
+ # details.
376
+ #
377
+ # @param base_url [String] Base URL for the external LLM endpoint.
378
+ #
379
+ # @param model [String] Model identifier to use with the external LLM endpoint.
380
+ #
381
+ # @param authentication_method [Symbol, Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
382
+ #
383
+ # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
384
+ #
385
+ # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
386
+ #
387
+ # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
388
+ #
389
+ # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
390
+
391
+ # Authentication method used when connecting to the external LLM endpoint.
392
+ #
393
+ # @see Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm#authentication_method
394
+ module AuthenticationMethod
395
+ extend Telnyx::Internal::Type::Enum
396
+
397
+ TOKEN = :token
398
+ CERTIFICATE = :certificate
399
+
400
+ # @!method self.values
401
+ # @return [Array<Symbol>]
402
+ end
403
+ end
404
+ end
405
+
196
406
  # @see Telnyx::Models::AI::InferenceEmbedding#post_conversation_settings
197
407
  class PostConversationSettings < Telnyx::Internal::Type::BaseModel
198
408
  # @!attribute enabled
@@ -13,7 +13,10 @@ module Telnyx
13
13
 
14
14
  # @!attribute language
15
15
  # The language of the audio to be transcribed. If not set, or if set to `auto`,
16
- # the model will automatically detect the language.
16
+ # supported models will automatically detect the language. For `deepgram/flux`,
17
+ # supported values are: `auto` (Telnyx language detection controls the language
18
+ # hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
19
+ # `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`.
17
20
  #
18
21
  # @return [String, nil]
19
22
  optional :language, String
@@ -22,7 +25,7 @@ module Telnyx
22
25
  # The speech to text model to be used by the voice assistant. All Deepgram models
23
26
  # are run on-premise.
24
27
  #
25
- # - `deepgram/flux` is optimized for turn-taking but is English-only.
28
+ # - `deepgram/flux` is optimized for turn-taking with multilingual language hints.
26
29
  # - `deepgram/nova-3` is multilingual with automatic language detection.
27
30
  # - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
28
31
  # - `azure/fast` is a multilingual Azure transcription model.
@@ -51,7 +54,7 @@ module Telnyx
51
54
  #
52
55
  # @param api_key_ref [String] Integration secret identifier for the transcription provider API key. Currently
53
56
  #
54
- # @param language [String] The language of the audio to be transcribed. If not set, or if set to `auto`, th
57
+ # @param language [String] The language of the audio to be transcribed. If not set, or if set to `auto`, su
55
58
  #
56
59
  # @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model] The speech to text model to be used by the voice assistant. All Deepgram models
57
60
  #
@@ -62,7 +65,7 @@ module Telnyx
62
65
  # The speech to text model to be used by the voice assistant. All Deepgram models
63
66
  # are run on-premise.
64
67
  #
65
- # - `deepgram/flux` is optimized for turn-taking but is English-only.
68
+ # - `deepgram/flux` is optimized for turn-taking with multilingual language hints.
66
69
  # - `deepgram/nova-3` is multilingual with automatic language detection.
67
70
  # - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
68
71
  # - `azure/fast` is a multilingual Azure transcription model.