telnyx 5.89.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -227
- data/lib/telnyx/models/ai/assistant_update_params.rb +9 -227
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -232
- data/lib/telnyx/models/ai/external_llm.rb +87 -0
- data/lib/telnyx/models/ai/external_llm_req.rb +87 -0
- data/lib/telnyx/models/ai/fallback_config.rb +37 -0
- data/lib/telnyx/models/ai/fallback_config_req.rb +37 -0
- data/lib/telnyx/models/ai/inference_embedding.rb +9 -230
- data/lib/telnyx/models/ai/post_conversation_settings.rb +30 -0
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +30 -0
- data/lib/telnyx/models/message_send_whatsapp_params.rb +9 -1
- data/lib/telnyx/models/whatsapp/phone_numbers/profile_update_params.rb +17 -1
- data/lib/telnyx/models/whatsapp/phone_numbers/whatsapp_profile_data.rb +8 -1
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/messages.rb +3 -1
- data/lib/telnyx/resources/whatsapp/phone_numbers/profile.rb +3 -1
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +6 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -455
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -455
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -461
- data/rbi/telnyx/models/ai/external_llm.rbi +157 -0
- data/rbi/telnyx/models/ai/external_llm_req.rbi +157 -0
- data/rbi/telnyx/models/ai/fallback_config.rbi +64 -0
- data/rbi/telnyx/models/ai/fallback_config_req.rbi +64 -0
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -452
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +45 -0
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +45 -0
- data/rbi/telnyx/models/message_send_whatsapp_params.rbi +11 -0
- data/rbi/telnyx/models/whatsapp/phone_numbers/profile_update_params.rbi +11 -0
- data/rbi/telnyx/models/whatsapp/phone_numbers/whatsapp_profile_data.rbi +9 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -5
- data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
- data/rbi/telnyx/resources/messages.rbi +3 -0
- data/rbi/telnyx/resources/whatsapp/phone_numbers/profile.rbi +3 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -205
- data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -205
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -205
- data/sig/telnyx/models/ai/external_llm.rbs +75 -0
- data/sig/telnyx/models/ai/external_llm_req.rbs +75 -0
- data/sig/telnyx/models/ai/fallback_config.rbs +38 -0
- data/sig/telnyx/models/ai/fallback_config_req.rbs +40 -0
- data/sig/telnyx/models/ai/inference_embedding.rbs +17 -206
- data/sig/telnyx/models/ai/post_conversation_settings.rbs +17 -0
- data/sig/telnyx/models/ai/post_conversation_settings_req.rbs +17 -0
- data/sig/telnyx/models/message_send_whatsapp_params.rbs +7 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/profile_update_params.rbs +7 -0
- data/sig/telnyx/models/whatsapp/phone_numbers/whatsapp_profile_data.rbs +7 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +6 -6
- data/sig/telnyx/resources/messages.rbs +1 -0
- data/sig/telnyx/resources/whatsapp/phone_numbers/profile.rbs +1 -0
- metadata +20 -2
|
@@ -62,13 +62,13 @@ module Telnyx
|
|
|
62
62
|
|
|
63
63
|
# @!attribute external_llm
|
|
64
64
|
#
|
|
65
|
-
# @return [Telnyx::Models::AI::
|
|
66
|
-
optional :external_llm, -> { Telnyx::AI::
|
|
65
|
+
# @return [Telnyx::Models::AI::ExternalLlm, nil]
|
|
66
|
+
optional :external_llm, -> { Telnyx::AI::ExternalLlm }
|
|
67
67
|
|
|
68
68
|
# @!attribute fallback_config
|
|
69
69
|
#
|
|
70
|
-
# @return [Telnyx::Models::AI::
|
|
71
|
-
optional :fallback_config, -> { Telnyx::AI::
|
|
70
|
+
# @return [Telnyx::Models::AI::FallbackConfig, nil]
|
|
71
|
+
optional :fallback_config, -> { Telnyx::AI::FallbackConfig }
|
|
72
72
|
|
|
73
73
|
# @!attribute greeting
|
|
74
74
|
# Text that the assistant will use to start the conversation. This may be
|
|
@@ -119,8 +119,8 @@ module Telnyx
|
|
|
119
119
|
# Telephony-control tools (e.g. hangup, transfer) are unavailable
|
|
120
120
|
# post-conversation. Beta feature.
|
|
121
121
|
#
|
|
122
|
-
# @return [Telnyx::Models::AI::
|
|
123
|
-
optional :post_conversation_settings, -> { Telnyx::AI::
|
|
122
|
+
# @return [Telnyx::Models::AI::PostConversationSettings, nil]
|
|
123
|
+
optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettings }
|
|
124
124
|
|
|
125
125
|
# @!attribute privacy_settings
|
|
126
126
|
#
|
|
@@ -177,9 +177,9 @@ module Telnyx
|
|
|
177
177
|
#
|
|
178
178
|
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
179
179
|
#
|
|
180
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
180
|
+
# @param external_llm [Telnyx::Models::AI::ExternalLlm]
|
|
181
181
|
#
|
|
182
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
182
|
+
# @param fallback_config [Telnyx::Models::AI::FallbackConfig]
|
|
183
183
|
#
|
|
184
184
|
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
185
185
|
#
|
|
@@ -193,7 +193,7 @@ module Telnyx
|
|
|
193
193
|
#
|
|
194
194
|
# @param observability_settings [Telnyx::Models::AI::Observability]
|
|
195
195
|
#
|
|
196
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
196
|
+
# @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
|
|
197
197
|
#
|
|
198
198
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
199
199
|
#
|
|
@@ -206,227 +206,6 @@ module Telnyx
|
|
|
206
206
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
207
207
|
#
|
|
208
208
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
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
|
-
|
|
406
|
-
# @see Telnyx::Models::AI::InferenceEmbedding#post_conversation_settings
|
|
407
|
-
class PostConversationSettings < Telnyx::Internal::Type::BaseModel
|
|
408
|
-
# @!attribute enabled
|
|
409
|
-
# Whether post-conversation processing is enabled. When true, the assistant will
|
|
410
|
-
# be invoked after the conversation ends to perform any final tool calls. Defaults
|
|
411
|
-
# to false.
|
|
412
|
-
#
|
|
413
|
-
# @return [Boolean, nil]
|
|
414
|
-
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
415
|
-
|
|
416
|
-
# @!method initialize(enabled: nil)
|
|
417
|
-
# Some parameter documentations has been truncated, see
|
|
418
|
-
# {Telnyx::Models::AI::InferenceEmbedding::PostConversationSettings} for more
|
|
419
|
-
# details.
|
|
420
|
-
#
|
|
421
|
-
# Configuration for post-conversation processing. When enabled, the assistant
|
|
422
|
-
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
423
|
-
# execute tool calls such as logging to a CRM or sending a summary. The assistant
|
|
424
|
-
# can execute multiple parallel or sequential tools during this phase.
|
|
425
|
-
# Telephony-control tools (e.g. hangup, transfer) are unavailable
|
|
426
|
-
# post-conversation. Beta feature.
|
|
427
|
-
#
|
|
428
|
-
# @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
|
|
429
|
-
end
|
|
430
209
|
end
|
|
431
210
|
end
|
|
432
211
|
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class PostConversationSettings < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute enabled
|
|
8
|
+
# Whether post-conversation processing is enabled. When true, the assistant will
|
|
9
|
+
# be invoked after the conversation ends to perform any final tool calls. Defaults
|
|
10
|
+
# to false.
|
|
11
|
+
#
|
|
12
|
+
# @return [Boolean, nil]
|
|
13
|
+
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
14
|
+
|
|
15
|
+
# @!method initialize(enabled: nil)
|
|
16
|
+
# Some parameter documentations has been truncated, see
|
|
17
|
+
# {Telnyx::Models::AI::PostConversationSettings} for more details.
|
|
18
|
+
#
|
|
19
|
+
# Configuration for post-conversation processing. When enabled, the assistant
|
|
20
|
+
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
21
|
+
# execute tool calls such as logging to a CRM or sending a summary. The assistant
|
|
22
|
+
# can execute multiple parallel or sequential tools during this phase.
|
|
23
|
+
# Telephony-control tools (e.g. hangup, transfer) are unavailable
|
|
24
|
+
# post-conversation. Beta feature.
|
|
25
|
+
#
|
|
26
|
+
# @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class PostConversationSettingsReq < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute enabled
|
|
8
|
+
# Whether post-conversation processing is enabled. When true, the assistant will
|
|
9
|
+
# be invoked after the conversation ends to perform any final tool calls. Defaults
|
|
10
|
+
# to false.
|
|
11
|
+
#
|
|
12
|
+
# @return [Boolean, nil]
|
|
13
|
+
optional :enabled, Telnyx::Internal::Type::Boolean
|
|
14
|
+
|
|
15
|
+
# @!method initialize(enabled: nil)
|
|
16
|
+
# Some parameter documentations has been truncated, see
|
|
17
|
+
# {Telnyx::Models::AI::PostConversationSettingsReq} for more details.
|
|
18
|
+
#
|
|
19
|
+
# Configuration for post-conversation processing. When enabled, the assistant
|
|
20
|
+
# receives one additional LLM turn after the conversation ends, allowing it to
|
|
21
|
+
# execute tool calls such as logging to a CRM or sending a summary. The assistant
|
|
22
|
+
# can execute multiple parallel or sequential tools during this phase.
|
|
23
|
+
# Telephony-control tools (e.g. hangup, transfer) are unavailable
|
|
24
|
+
# post-conversation. Beta feature.
|
|
25
|
+
#
|
|
26
|
+
# @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -24,6 +24,12 @@ module Telnyx
|
|
|
24
24
|
# @return [Telnyx::Models::WhatsappMessageContent]
|
|
25
25
|
required :whatsapp_message, -> { Telnyx::WhatsappMessageContent }
|
|
26
26
|
|
|
27
|
+
# @!attribute messaging_profile_id
|
|
28
|
+
# Messaging profile ID - required if the 'from' number is not SMS-enabled
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :messaging_profile_id, String
|
|
32
|
+
|
|
27
33
|
# @!attribute type
|
|
28
34
|
# Message type - must be set to "WHATSAPP"
|
|
29
35
|
#
|
|
@@ -36,13 +42,15 @@ module Telnyx
|
|
|
36
42
|
# @return [String, nil]
|
|
37
43
|
optional :webhook_url, String
|
|
38
44
|
|
|
39
|
-
# @!method initialize(from:, to:, whatsapp_message:, type: nil, webhook_url: nil, request_options: {})
|
|
45
|
+
# @!method initialize(from:, to:, whatsapp_message:, messaging_profile_id: nil, type: nil, webhook_url: nil, request_options: {})
|
|
40
46
|
# @param from [String] Phone number in +E.164 format associated with Whatsapp account
|
|
41
47
|
#
|
|
42
48
|
# @param to [String] Phone number in +E.164 format
|
|
43
49
|
#
|
|
44
50
|
# @param whatsapp_message [Telnyx::Models::WhatsappMessageContent]
|
|
45
51
|
#
|
|
52
|
+
# @param messaging_profile_id [String] Messaging profile ID - required if the 'from' number is not SMS-enabled
|
|
53
|
+
#
|
|
46
54
|
# @param type [Symbol, Telnyx::Models::MessageSendWhatsappParams::Type] Message type - must be set to "WHATSAPP"
|
|
47
55
|
#
|
|
48
56
|
# @param webhook_url [String] The URL where webhooks related to this message will be sent.
|
|
@@ -44,20 +44,36 @@ module Telnyx
|
|
|
44
44
|
# @return [String, nil]
|
|
45
45
|
optional :email, String
|
|
46
46
|
|
|
47
|
+
# @!attribute profile_id
|
|
48
|
+
# Messaging profile ID for inbound messages
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :profile_id, String
|
|
52
|
+
|
|
47
53
|
# @!attribute website
|
|
48
54
|
#
|
|
49
55
|
# @return [String, nil]
|
|
50
56
|
optional :website, String
|
|
51
57
|
|
|
52
|
-
# @!method initialize(phone_number:, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, website: nil, request_options: {})
|
|
58
|
+
# @!method initialize(phone_number:, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, profile_id: nil, website: nil, request_options: {})
|
|
53
59
|
# @param phone_number [String]
|
|
60
|
+
#
|
|
54
61
|
# @param about [String]
|
|
62
|
+
#
|
|
55
63
|
# @param address [String]
|
|
64
|
+
#
|
|
56
65
|
# @param category [String]
|
|
66
|
+
#
|
|
57
67
|
# @param description [String]
|
|
68
|
+
#
|
|
58
69
|
# @param display_name [String]
|
|
70
|
+
#
|
|
59
71
|
# @param email [String]
|
|
72
|
+
#
|
|
73
|
+
# @param profile_id [String] Messaging profile ID for inbound messages
|
|
74
|
+
#
|
|
60
75
|
# @param website [String]
|
|
76
|
+
#
|
|
61
77
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
62
78
|
end
|
|
63
79
|
end
|
|
@@ -51,6 +51,11 @@ module Telnyx
|
|
|
51
51
|
# @return [String, nil]
|
|
52
52
|
optional :phone_number_id, String
|
|
53
53
|
|
|
54
|
+
# @!attribute profile_id
|
|
55
|
+
#
|
|
56
|
+
# @return [String, nil]
|
|
57
|
+
optional :profile_id, String
|
|
58
|
+
|
|
54
59
|
# @!attribute profile_photo_url
|
|
55
60
|
#
|
|
56
61
|
# @return [String, nil]
|
|
@@ -71,7 +76,7 @@ module Telnyx
|
|
|
71
76
|
# @return [String, nil]
|
|
72
77
|
optional :website, String
|
|
73
78
|
|
|
74
|
-
# @!method initialize(id: nil, about: nil, address: nil, category: nil, created_at: nil, description: nil, display_name: nil, email: nil, phone_number_id: nil, profile_photo_url: nil, record_type: nil, updated_at: nil, website: nil)
|
|
79
|
+
# @!method initialize(id: nil, about: nil, address: nil, category: nil, created_at: nil, description: nil, display_name: nil, email: nil, phone_number_id: nil, profile_id: nil, profile_photo_url: nil, record_type: nil, updated_at: nil, website: nil)
|
|
75
80
|
# @param id [String]
|
|
76
81
|
#
|
|
77
82
|
# @param about [String]
|
|
@@ -90,6 +95,8 @@ module Telnyx
|
|
|
90
95
|
#
|
|
91
96
|
# @param phone_number_id [String] Whatsapp phone number ID
|
|
92
97
|
#
|
|
98
|
+
# @param profile_id [String]
|
|
99
|
+
#
|
|
93
100
|
# @param profile_photo_url [String]
|
|
94
101
|
#
|
|
95
102
|
# @param record_type [String]
|
|
@@ -57,9 +57,9 @@ 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::
|
|
60
|
+
# @param external_llm [Telnyx::Models::AI::ExternalLlmReq] Body param
|
|
61
61
|
#
|
|
62
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
62
|
+
# @param fallback_config [Telnyx::Models::AI::FallbackConfigReq] Body param
|
|
63
63
|
#
|
|
64
64
|
# @param greeting [String] Body param: Text that the assistant will use to start the conversation. This may
|
|
65
65
|
#
|
|
@@ -77,7 +77,7 @@ module Telnyx
|
|
|
77
77
|
#
|
|
78
78
|
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq] Body param
|
|
79
79
|
#
|
|
80
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
80
|
+
# @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Body param: Configuration for post-conversation processing. When enabled, the as
|
|
81
81
|
#
|
|
82
82
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings] Body param
|
|
83
83
|
#
|
|
@@ -50,9 +50,9 @@ module Telnyx
|
|
|
50
50
|
#
|
|
51
51
|
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
52
52
|
#
|
|
53
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
53
|
+
# @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
|
|
54
54
|
#
|
|
55
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
55
|
+
# @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
|
|
56
56
|
#
|
|
57
57
|
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
58
58
|
#
|
|
@@ -64,7 +64,7 @@ module Telnyx
|
|
|
64
64
|
#
|
|
65
65
|
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
|
|
66
66
|
#
|
|
67
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
67
|
+
# @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
|
|
68
68
|
#
|
|
69
69
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
70
70
|
#
|
|
@@ -139,9 +139,9 @@ module Telnyx
|
|
|
139
139
|
#
|
|
140
140
|
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
141
141
|
#
|
|
142
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
142
|
+
# @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
|
|
143
143
|
#
|
|
144
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
144
|
+
# @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
|
|
145
145
|
#
|
|
146
146
|
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
147
147
|
#
|
|
@@ -159,7 +159,7 @@ module Telnyx
|
|
|
159
159
|
#
|
|
160
160
|
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
|
|
161
161
|
#
|
|
162
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
162
|
+
# @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
|
|
163
163
|
#
|
|
164
164
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
165
165
|
#
|
|
@@ -353,7 +353,7 @@ module Telnyx
|
|
|
353
353
|
|
|
354
354
|
# Send a Whatsapp message
|
|
355
355
|
#
|
|
356
|
-
# @overload send_whatsapp(from:, to:, whatsapp_message:, type: nil, webhook_url: nil, request_options: {})
|
|
356
|
+
# @overload send_whatsapp(from:, to:, whatsapp_message:, messaging_profile_id: nil, type: nil, webhook_url: nil, request_options: {})
|
|
357
357
|
#
|
|
358
358
|
# @param from [String] Phone number in +E.164 format associated with Whatsapp account
|
|
359
359
|
#
|
|
@@ -361,6 +361,8 @@ module Telnyx
|
|
|
361
361
|
#
|
|
362
362
|
# @param whatsapp_message [Telnyx::Models::WhatsappMessageContent]
|
|
363
363
|
#
|
|
364
|
+
# @param messaging_profile_id [String] Messaging profile ID - required if the 'from' number is not SMS-enabled
|
|
365
|
+
#
|
|
364
366
|
# @param type [Symbol, Telnyx::Models::MessageSendWhatsappParams::Type] Message type - must be set to "WHATSAPP"
|
|
365
367
|
#
|
|
366
368
|
# @param webhook_url [String] The URL where webhooks related to this message will be sent.
|
|
@@ -32,7 +32,7 @@ module Telnyx
|
|
|
32
32
|
|
|
33
33
|
# Update phone number business profile
|
|
34
34
|
#
|
|
35
|
-
# @overload update(phone_number, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, website: nil, request_options: {})
|
|
35
|
+
# @overload update(phone_number, about: nil, address: nil, category: nil, description: nil, display_name: nil, email: nil, profile_id: nil, website: nil, request_options: {})
|
|
36
36
|
#
|
|
37
37
|
# @param phone_number [String] Phone number (E.164 format)
|
|
38
38
|
#
|
|
@@ -48,6 +48,8 @@ module Telnyx
|
|
|
48
48
|
#
|
|
49
49
|
# @param email [String]
|
|
50
50
|
#
|
|
51
|
+
# @param profile_id [String] Messaging profile ID for inbound messages
|
|
52
|
+
#
|
|
51
53
|
# @param website [String]
|
|
52
54
|
#
|
|
53
55
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -256,6 +256,10 @@ require_relative "telnyx/models/ai/embedding_similarity_search_params"
|
|
|
256
256
|
require_relative "telnyx/models/ai/embedding_similarity_search_response"
|
|
257
257
|
require_relative "telnyx/models/ai/embedding_url_params"
|
|
258
258
|
require_relative "telnyx/models/ai/enabled_features"
|
|
259
|
+
require_relative "telnyx/models/ai/external_llm"
|
|
260
|
+
require_relative "telnyx/models/ai/external_llm_req"
|
|
261
|
+
require_relative "telnyx/models/ai/fallback_config"
|
|
262
|
+
require_relative "telnyx/models/ai/fallback_config_req"
|
|
259
263
|
require_relative "telnyx/models/ai/fine_tuning/fine_tuning_job"
|
|
260
264
|
require_relative "telnyx/models/ai/fine_tuning/job_cancel_params"
|
|
261
265
|
require_relative "telnyx/models/ai/fine_tuning/job_create_params"
|
|
@@ -371,6 +375,8 @@ require_relative "telnyx/models/ai/openai/embedding_create_embeddings_params"
|
|
|
371
375
|
require_relative "telnyx/models/ai/openai/embedding_create_embeddings_response"
|
|
372
376
|
require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_params"
|
|
373
377
|
require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_response"
|
|
378
|
+
require_relative "telnyx/models/ai/post_conversation_settings"
|
|
379
|
+
require_relative "telnyx/models/ai/post_conversation_settings_req"
|
|
374
380
|
require_relative "telnyx/models/ai/privacy_settings"
|
|
375
381
|
require_relative "telnyx/models/ai/recursive_cluster"
|
|
376
382
|
require_relative "telnyx/models/ai/retrieval_tool"
|