telnyx 5.92.0 → 5.94.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 +265 -37
- data/lib/telnyx/models/ai/assistant_tool.rb +108 -21
- data/lib/telnyx/models/ai/assistant_update_params.rb +266 -30
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +267 -30
- data/lib/telnyx/models/ai/inference_embedding.rb +287 -29
- data/lib/telnyx/models/ai/transfer_tool.rb +48 -22
- data/lib/telnyx/resources/ai/assistants/versions.rb +18 -6
- data/lib/telnyx/resources/ai/assistants.rb +35 -13
- data/lib/telnyx/version.rb +1 -1
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +510 -52
- data/rbi/telnyx/models/ai/assistant_tool.rbi +171 -32
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +510 -44
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +526 -44
- data/rbi/telnyx/models/ai/inference_embedding.rbi +540 -44
- data/rbi/telnyx/models/ai/transfer_tool.rbi +64 -30
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +61 -13
- data/rbi/telnyx/resources/ai/assistants.rbi +112 -27
- data/sig/telnyx/models/ai/assistant_create_params.rbs +172 -5
- data/sig/telnyx/models/ai/assistant_tool.rbs +53 -12
- data/sig/telnyx/models/ai/assistant_update_params.rbs +172 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +175 -0
- data/sig/telnyx/models/ai/inference_embedding.rbs +193 -0
- data/sig/telnyx/models/ai/transfer_tool.rbs +22 -12
- data/sig/telnyx/resources/ai/assistants/versions.rbs +6 -0
- data/sig/telnyx/resources/ai/assistants.rbs +12 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 99ee1431030d5e934cef1f55e43d65d5ec32a16385dc59b7b1935468a942f2b8
|
|
4
|
+
data.tar.gz: 43ac6b2527321cd883735d0e566b7ca8c6bbe96eec82990c5eeb085021151fdb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 790b845d4bb2eb03ed6142139cebff3595b0334439697a89911cad8f63b7f60ef8b1ba9dccce1c1f216c98d073b96e3e821cd188c4d48a2391dbf6e5820c00d9
|
|
7
|
+
data.tar.gz: fb1c8230ec6bb4de8b91006449bcb401789a2b3e9116639e602fd4a9bd6ff2415f44563c1c2f6141cf3f2e51610ff5aa290b5dbcd49fc71fb6e3fd1f811c27ff
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.94.0 (2026-04-30)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.93.0...v5.94.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.93.0...v5.94.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Assistant tool targets master ([b06b562](https://github.com/team-telnyx/telnyx-ruby/commit/b06b562ff66c80a5afd7f0c82a2aa42241f7811c))
|
|
10
|
+
|
|
11
|
+
## 5.93.0 (2026-04-29)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v5.92.0...v5.93.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.92.0...v5.93.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* Document assistant CRUD fields ([10e9601](https://github.com/team-telnyx/telnyx-ruby/commit/10e9601fe87a10dd015d455f23b81156e5a05612))
|
|
18
|
+
|
|
3
19
|
## 5.92.0 (2026-04-29)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v5.91.0...v5.92.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.91.0...v5.92.0)
|
data/README.md
CHANGED
|
@@ -15,14 +15,6 @@ module Telnyx
|
|
|
15
15
|
# @return [String]
|
|
16
16
|
required :instructions, String
|
|
17
17
|
|
|
18
|
-
# @!attribute model
|
|
19
|
-
# ID of the model to use. You can use the
|
|
20
|
-
# [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
|
|
21
|
-
# to see all of your available models,
|
|
22
|
-
#
|
|
23
|
-
# @return [String]
|
|
24
|
-
required :model, String
|
|
25
|
-
|
|
26
18
|
# @!attribute name
|
|
27
19
|
#
|
|
28
20
|
# @return [String]
|
|
@@ -39,11 +31,24 @@ module Telnyx
|
|
|
39
31
|
# @return [Hash{Symbol=>Object}, nil]
|
|
40
32
|
optional :dynamic_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
41
33
|
|
|
34
|
+
# @!attribute dynamic_variables_webhook_timeout_ms
|
|
35
|
+
# Timeout in milliseconds for the dynamic variables webhook. Must be between 1 and
|
|
36
|
+
# 10000 ms. If the webhook does not respond within this timeout, the call proceeds
|
|
37
|
+
# with default values. See the
|
|
38
|
+
# [dynamic variables guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
|
|
39
|
+
#
|
|
40
|
+
# @return [Integer, nil]
|
|
41
|
+
optional :dynamic_variables_webhook_timeout_ms, Integer
|
|
42
|
+
|
|
42
43
|
# @!attribute dynamic_variables_webhook_url
|
|
43
|
-
# If
|
|
44
|
-
#
|
|
45
|
-
#
|
|
46
|
-
#
|
|
44
|
+
# If `dynamic_variables_webhook_url` is set, Telnyx sends a POST request to this
|
|
45
|
+
# URL at the start of the conversation to resolve dynamic variables. **Gotcha:**
|
|
46
|
+
# the webhook response must wrap variables under a top-level `dynamic_variables`
|
|
47
|
+
# object, e.g. `{"dynamic_variables": {"customer_name": "Jane"}}`. Returning a
|
|
48
|
+
# flat object will be ignored and variables will fall back to their defaults. See
|
|
49
|
+
# the
|
|
50
|
+
# [dynamic variables guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
51
|
+
# for the full request/response format and timeout behavior.
|
|
47
52
|
#
|
|
48
53
|
# @return [String, nil]
|
|
49
54
|
optional :dynamic_variables_webhook_url, String
|
|
@@ -79,21 +84,61 @@ module Telnyx
|
|
|
79
84
|
# @return [Telnyx::Models::AI::InsightSettings, nil]
|
|
80
85
|
optional :insight_settings, -> { Telnyx::AI::InsightSettings }
|
|
81
86
|
|
|
87
|
+
# @!attribute integrations
|
|
88
|
+
# Connected integrations attached to the assistant. The catalog of available
|
|
89
|
+
# integrations is at `/ai/integrations`; the user's connected integrations are at
|
|
90
|
+
# `/ai/integrations/connections`. Each item references a catalog integration by
|
|
91
|
+
# `integration_id`.
|
|
92
|
+
#
|
|
93
|
+
# @return [Array<Telnyx::Models::AI::AssistantCreateParams::Integration>, nil]
|
|
94
|
+
optional :integrations,
|
|
95
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::Integration] }
|
|
96
|
+
|
|
97
|
+
# @!attribute interruption_settings
|
|
98
|
+
# Settings for interruptions and how the assistant decides the user has finished
|
|
99
|
+
# speaking. These timings are most relevant when using non turn-taking
|
|
100
|
+
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
101
|
+
# behavior is controlled by the transcription end-of-turn settings under
|
|
102
|
+
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
103
|
+
# `eager_eot_threshold`).
|
|
104
|
+
#
|
|
105
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings, nil]
|
|
106
|
+
optional :interruption_settings, -> { Telnyx::AI::AssistantCreateParams::InterruptionSettings }
|
|
107
|
+
|
|
82
108
|
# @!attribute llm_api_key_ref
|
|
83
|
-
# This is only needed when using third-party inference providers
|
|
84
|
-
# for an integration secret
|
|
109
|
+
# This is only needed when using third-party inference providers selected by
|
|
110
|
+
# `model`. The `identifier` for an integration secret
|
|
85
111
|
# [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
86
|
-
# that refers to your LLM provider's API key.
|
|
87
|
-
#
|
|
112
|
+
# that refers to your LLM provider's API key. For bring-your-own endpoint
|
|
113
|
+
# authentication, use `external_llm.llm_api_key_ref` instead. Warning: Free plans
|
|
114
|
+
# are unlikely to work with this integration.
|
|
88
115
|
#
|
|
89
116
|
# @return [String, nil]
|
|
90
117
|
optional :llm_api_key_ref, String
|
|
91
118
|
|
|
119
|
+
# @!attribute mcp_servers
|
|
120
|
+
# MCP servers attached to the assistant. Create MCP servers with
|
|
121
|
+
# `/ai/mcp_servers`, then reference them by `id` here.
|
|
122
|
+
#
|
|
123
|
+
# @return [Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>, nil]
|
|
124
|
+
optional :mcp_servers,
|
|
125
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::McpServer] }
|
|
126
|
+
|
|
92
127
|
# @!attribute messaging_settings
|
|
93
128
|
#
|
|
94
129
|
# @return [Telnyx::Models::AI::MessagingSettings, nil]
|
|
95
130
|
optional :messaging_settings, -> { Telnyx::AI::MessagingSettings }
|
|
96
131
|
|
|
132
|
+
# @!attribute model
|
|
133
|
+
# ID of the model to use when `external_llm` is not set. You can use the
|
|
134
|
+
# [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
|
|
135
|
+
# to see available models. If `external_llm` is provided, the assistant uses
|
|
136
|
+
# `external_llm` instead of this field. If neither `model` nor `external_llm` is
|
|
137
|
+
# provided, Telnyx applies the default model.
|
|
138
|
+
#
|
|
139
|
+
# @return [String, nil]
|
|
140
|
+
optional :model, String
|
|
141
|
+
|
|
97
142
|
# @!attribute observability_settings
|
|
98
143
|
#
|
|
99
144
|
# @return [Telnyx::Models::AI::ObservabilityReq, nil]
|
|
@@ -115,19 +160,29 @@ module Telnyx
|
|
|
115
160
|
# @return [Telnyx::Models::AI::PrivacySettings, nil]
|
|
116
161
|
optional :privacy_settings, -> { Telnyx::AI::PrivacySettings }
|
|
117
162
|
|
|
163
|
+
# @!attribute tags
|
|
164
|
+
# Tags associated with the assistant. Tags can also be managed with the assistant
|
|
165
|
+
# tag endpoints.
|
|
166
|
+
#
|
|
167
|
+
# @return [Array<String>, nil]
|
|
168
|
+
optional :tags, Telnyx::Internal::Type::ArrayOf[String]
|
|
169
|
+
|
|
118
170
|
# @!attribute telephony_settings
|
|
119
171
|
#
|
|
120
172
|
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
121
173
|
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
122
174
|
|
|
123
175
|
# @!attribute tool_ids
|
|
176
|
+
# IDs of shared tools to attach to the assistant. New integrations should prefer
|
|
177
|
+
# `tool_ids` over inline `tools`.
|
|
124
178
|
#
|
|
125
179
|
# @return [Array<String>, nil]
|
|
126
180
|
optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
127
181
|
|
|
128
182
|
# @!attribute tools
|
|
129
|
-
#
|
|
130
|
-
#
|
|
183
|
+
# Deprecated for new integrations. Inline tool definitions available to the
|
|
184
|
+
# assistant. Prefer `tool_ids` to attach shared tools created with the AI Tools
|
|
185
|
+
# endpoints.
|
|
131
186
|
#
|
|
132
187
|
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>, nil]
|
|
133
188
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
@@ -148,21 +203,21 @@ module Telnyx
|
|
|
148
203
|
# @return [Telnyx::Models::AI::WidgetSettings, nil]
|
|
149
204
|
optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
|
|
150
205
|
|
|
151
|
-
# @!method initialize(instructions:,
|
|
206
|
+
# @!method initialize(instructions:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
152
207
|
# Some parameter documentations has been truncated, see
|
|
153
208
|
# {Telnyx::Models::AI::AssistantCreateParams} for more details.
|
|
154
209
|
#
|
|
155
210
|
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
156
211
|
#
|
|
157
|
-
# @param model [String] ID of the model to use. You can use the [Get models API](https://developers.teln
|
|
158
|
-
#
|
|
159
212
|
# @param name [String]
|
|
160
213
|
#
|
|
161
214
|
# @param description [String]
|
|
162
215
|
#
|
|
163
216
|
# @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their default values
|
|
164
217
|
#
|
|
165
|
-
# @param
|
|
218
|
+
# @param dynamic_variables_webhook_timeout_ms [Integer] Timeout in milliseconds for the dynamic variables webhook. Must be between 1 and
|
|
219
|
+
#
|
|
220
|
+
# @param dynamic_variables_webhook_url [String] If `dynamic_variables_webhook_url` is set, Telnyx sends a POST request to this U
|
|
166
221
|
#
|
|
167
222
|
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
168
223
|
#
|
|
@@ -174,21 +229,31 @@ module Telnyx
|
|
|
174
229
|
#
|
|
175
230
|
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
176
231
|
#
|
|
177
|
-
# @param
|
|
232
|
+
# @param integrations [Array<Telnyx::Models::AI::AssistantCreateParams::Integration>] Connected integrations attached to the assistant. The catalog of available integ
|
|
233
|
+
#
|
|
234
|
+
# @param interruption_settings [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
|
|
235
|
+
#
|
|
236
|
+
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
|
|
237
|
+
#
|
|
238
|
+
# @param mcp_servers [Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
|
|
178
239
|
#
|
|
179
240
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
180
241
|
#
|
|
242
|
+
# @param model [String] ID of the model to use when `external_llm` is not set. You can use the [Get mode
|
|
243
|
+
#
|
|
181
244
|
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
|
|
182
245
|
#
|
|
183
246
|
# @param post_conversation_settings [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
|
|
184
247
|
#
|
|
185
248
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
186
249
|
#
|
|
250
|
+
# @param tags [Array<String>] Tags associated with the assistant. Tags can also be managed with the assistant
|
|
251
|
+
#
|
|
187
252
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
188
253
|
#
|
|
189
|
-
# @param tool_ids [Array<String>]
|
|
254
|
+
# @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
|
|
190
255
|
#
|
|
191
|
-
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>]
|
|
256
|
+
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] Deprecated for new integrations. Inline tool definitions available to the assist
|
|
192
257
|
#
|
|
193
258
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
194
259
|
#
|
|
@@ -226,11 +291,13 @@ module Telnyx
|
|
|
226
291
|
optional :certificate_ref, String
|
|
227
292
|
|
|
228
293
|
# @!attribute forward_metadata
|
|
229
|
-
# When
|
|
230
|
-
# LLM endpoint
|
|
231
|
-
#
|
|
232
|
-
#
|
|
233
|
-
# `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
|
|
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.
|
|
234
301
|
#
|
|
235
302
|
# @return [Boolean, nil]
|
|
236
303
|
optional :forward_metadata, Telnyx::Internal::Type::Boolean
|
|
@@ -259,7 +326,7 @@ module Telnyx
|
|
|
259
326
|
#
|
|
260
327
|
# @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
|
|
261
328
|
#
|
|
262
|
-
# @param forward_metadata [Boolean] When
|
|
329
|
+
# @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
|
|
263
330
|
#
|
|
264
331
|
# @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
|
|
265
332
|
#
|
|
@@ -337,11 +404,13 @@ module Telnyx
|
|
|
337
404
|
optional :certificate_ref, String
|
|
338
405
|
|
|
339
406
|
# @!attribute forward_metadata
|
|
340
|
-
# When
|
|
341
|
-
# LLM endpoint
|
|
342
|
-
#
|
|
343
|
-
#
|
|
344
|
-
# `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
|
|
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.
|
|
345
414
|
#
|
|
346
415
|
# @return [Boolean, nil]
|
|
347
416
|
optional :forward_metadata, Telnyx::Internal::Type::Boolean
|
|
@@ -371,7 +440,7 @@ module Telnyx
|
|
|
371
440
|
#
|
|
372
441
|
# @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
|
|
373
442
|
#
|
|
374
|
-
# @param forward_metadata [Boolean] When
|
|
443
|
+
# @param forward_metadata [Boolean] When `true`, Telnyx forwards the assistant's dynamic variables to the external L
|
|
375
444
|
#
|
|
376
445
|
# @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
|
|
377
446
|
#
|
|
@@ -392,6 +461,165 @@ module Telnyx
|
|
|
392
461
|
end
|
|
393
462
|
end
|
|
394
463
|
|
|
464
|
+
class Integration < Telnyx::Internal::Type::BaseModel
|
|
465
|
+
# @!attribute integration_id
|
|
466
|
+
# Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
467
|
+
# at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
468
|
+
# entries returned by `/ai/integrations/connections`). It is **not** the
|
|
469
|
+
# connection-level `id` from `/ai/integrations/connections`.
|
|
470
|
+
#
|
|
471
|
+
# @return [String]
|
|
472
|
+
required :integration_id, String
|
|
473
|
+
|
|
474
|
+
# @!attribute allowed_list
|
|
475
|
+
# Optional per-assistant allowlist of integration tool names. When omitted or
|
|
476
|
+
# empty, all tools allowed by the connected integration are available to the
|
|
477
|
+
# assistant.
|
|
478
|
+
#
|
|
479
|
+
# @return [Array<String>, nil]
|
|
480
|
+
optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
|
|
481
|
+
|
|
482
|
+
# @!method initialize(integration_id:, allowed_list: nil)
|
|
483
|
+
# Some parameter documentations has been truncated, see
|
|
484
|
+
# {Telnyx::Models::AI::AssistantCreateParams::Integration} for more details.
|
|
485
|
+
#
|
|
486
|
+
# Reference to a connected integration attached to an assistant. Discover
|
|
487
|
+
# available integrations with `/ai/integrations` and connected integrations with
|
|
488
|
+
# `/ai/integrations/connections`.
|
|
489
|
+
#
|
|
490
|
+
# @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
491
|
+
#
|
|
492
|
+
# @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
|
|
493
|
+
end
|
|
494
|
+
|
|
495
|
+
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
496
|
+
# @!attribute enable
|
|
497
|
+
# Whether users can interrupt the assistant while it is speaking.
|
|
498
|
+
#
|
|
499
|
+
# @return [Boolean, nil]
|
|
500
|
+
optional :enable, Telnyx::Internal::Type::Boolean
|
|
501
|
+
|
|
502
|
+
# @!attribute start_speaking_plan
|
|
503
|
+
# Controls when the assistant starts speaking after the user stops. These
|
|
504
|
+
# thresholds primarily apply to non turn-taking transcription models. For
|
|
505
|
+
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
506
|
+
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
507
|
+
#
|
|
508
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan, nil]
|
|
509
|
+
optional :start_speaking_plan,
|
|
510
|
+
-> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan }
|
|
511
|
+
|
|
512
|
+
# @!method initialize(enable: nil, start_speaking_plan: nil)
|
|
513
|
+
# Some parameter documentations has been truncated, see
|
|
514
|
+
# {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings} for more
|
|
515
|
+
# details.
|
|
516
|
+
#
|
|
517
|
+
# Settings for interruptions and how the assistant decides the user has finished
|
|
518
|
+
# speaking. These timings are most relevant when using non turn-taking
|
|
519
|
+
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
520
|
+
# behavior is controlled by the transcription end-of-turn settings under
|
|
521
|
+
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
522
|
+
# `eager_eot_threshold`).
|
|
523
|
+
#
|
|
524
|
+
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
525
|
+
#
|
|
526
|
+
# @param start_speaking_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
527
|
+
|
|
528
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings#start_speaking_plan
|
|
529
|
+
class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
|
|
530
|
+
# @!attribute transcription_endpointing_plan
|
|
531
|
+
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
532
|
+
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
533
|
+
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
534
|
+
# `eager_eot_threshold`.
|
|
535
|
+
#
|
|
536
|
+
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
|
|
537
|
+
optional :transcription_endpointing_plan,
|
|
538
|
+
-> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
|
|
539
|
+
|
|
540
|
+
# @!attribute wait_seconds
|
|
541
|
+
# Minimum seconds to wait before the assistant starts speaking.
|
|
542
|
+
#
|
|
543
|
+
# @return [Float, nil]
|
|
544
|
+
optional :wait_seconds, Float
|
|
545
|
+
|
|
546
|
+
# @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
|
|
547
|
+
# Some parameter documentations has been truncated, see
|
|
548
|
+
# {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan}
|
|
549
|
+
# for more details.
|
|
550
|
+
#
|
|
551
|
+
# Controls when the assistant starts speaking after the user stops. These
|
|
552
|
+
# thresholds primarily apply to non turn-taking transcription models. For
|
|
553
|
+
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
554
|
+
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
555
|
+
#
|
|
556
|
+
# @param transcription_endpointing_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
|
|
557
|
+
#
|
|
558
|
+
# @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
|
|
559
|
+
|
|
560
|
+
# @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
|
|
561
|
+
class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
|
|
562
|
+
# @!attribute on_no_punctuation_seconds
|
|
563
|
+
# Seconds to wait after the transcript ends without punctuation.
|
|
564
|
+
#
|
|
565
|
+
# @return [Float, nil]
|
|
566
|
+
optional :on_no_punctuation_seconds, Float
|
|
567
|
+
|
|
568
|
+
# @!attribute on_number_seconds
|
|
569
|
+
# Seconds to wait after the transcript ends with a number.
|
|
570
|
+
#
|
|
571
|
+
# @return [Float, nil]
|
|
572
|
+
optional :on_number_seconds, Float
|
|
573
|
+
|
|
574
|
+
# @!attribute on_punctuation_seconds
|
|
575
|
+
# Seconds to wait after the transcript ends with punctuation.
|
|
576
|
+
#
|
|
577
|
+
# @return [Float, nil]
|
|
578
|
+
optional :on_punctuation_seconds, Float
|
|
579
|
+
|
|
580
|
+
# @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
|
|
581
|
+
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
582
|
+
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
583
|
+
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
584
|
+
# `eager_eot_threshold`.
|
|
585
|
+
#
|
|
586
|
+
# @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
|
|
587
|
+
#
|
|
588
|
+
# @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
|
|
589
|
+
#
|
|
590
|
+
# @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
|
|
591
|
+
end
|
|
592
|
+
end
|
|
593
|
+
end
|
|
594
|
+
|
|
595
|
+
class McpServer < Telnyx::Internal::Type::BaseModel
|
|
596
|
+
# @!attribute id
|
|
597
|
+
# ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
598
|
+
# by the `/ai/mcp_servers` endpoints.
|
|
599
|
+
#
|
|
600
|
+
# @return [String]
|
|
601
|
+
required :id, String
|
|
602
|
+
|
|
603
|
+
# @!attribute allowed_tools
|
|
604
|
+
# Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
605
|
+
# uses the MCP server's configured `allowed_tools`.
|
|
606
|
+
#
|
|
607
|
+
# @return [Array<String>, nil]
|
|
608
|
+
optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
|
|
609
|
+
|
|
610
|
+
# @!method initialize(id:, allowed_tools: nil)
|
|
611
|
+
# Some parameter documentations has been truncated, see
|
|
612
|
+
# {Telnyx::Models::AI::AssistantCreateParams::McpServer} for more details.
|
|
613
|
+
#
|
|
614
|
+
# Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
615
|
+
# servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
616
|
+
# ID.
|
|
617
|
+
#
|
|
618
|
+
# @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
619
|
+
#
|
|
620
|
+
# @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
621
|
+
end
|
|
622
|
+
|
|
395
623
|
class PostConversationSettings < Telnyx::Internal::Type::BaseModel
|
|
396
624
|
# @!attribute enabled
|
|
397
625
|
# Whether post-conversation processing is enabled. When true, the assistant will
|
|
@@ -140,11 +140,12 @@ module Telnyx
|
|
|
140
140
|
|
|
141
141
|
# @!attribute targets
|
|
142
142
|
# The different possible targets of the transfer. The assistant will be able to
|
|
143
|
-
# choose one of the targets to transfer the call to.
|
|
143
|
+
# choose one of the targets to transfer the call to. This can also be a dynamic
|
|
144
|
+
# variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
145
|
+
# variables webhook and resolves to an array of target objects at runtime.
|
|
144
146
|
#
|
|
145
|
-
# @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::
|
|
146
|
-
required :targets,
|
|
147
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantTool::Transfer::Transfer::Target] }
|
|
147
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0>, String]
|
|
148
|
+
required :targets, union: -> { Telnyx::AI::AssistantTool::Transfer::Transfer::Targets }
|
|
148
149
|
|
|
149
150
|
# @!attribute custom_headers
|
|
150
151
|
# Custom headers to be added to the SIP INVITE for the transfer command.
|
|
@@ -183,7 +184,7 @@ module Telnyx
|
|
|
183
184
|
#
|
|
184
185
|
# @param from [String] Number or SIP URI placing the call.
|
|
185
186
|
#
|
|
186
|
-
# @param targets [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::
|
|
187
|
+
# @param targets [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0>, String] The different possible targets of the transfer. The assistant will be able to ch
|
|
187
188
|
#
|
|
188
189
|
# @param custom_headers [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::CustomHeader>] Custom headers to be added to the SIP INVITE for the transfer command.
|
|
189
190
|
#
|
|
@@ -193,23 +194,47 @@ module Telnyx
|
|
|
193
194
|
#
|
|
194
195
|
# @param warm_transfer_instructions [String] Natural language instructions for your agent for how to provide context for the
|
|
195
196
|
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
197
|
+
# The different possible targets of the transfer. The assistant will be able to
|
|
198
|
+
# choose one of the targets to transfer the call to. This can also be a dynamic
|
|
199
|
+
# variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
200
|
+
# variables webhook and resolves to an array of target objects at runtime.
|
|
201
|
+
#
|
|
202
|
+
# @see Telnyx::Models::AI::AssistantTool::Transfer::Transfer#targets
|
|
203
|
+
module Targets
|
|
204
|
+
extend Telnyx::Internal::Type::Union
|
|
202
205
|
|
|
203
|
-
|
|
204
|
-
# The destination number or SIP URI of the call.
|
|
205
|
-
#
|
|
206
|
-
# @return [String, nil]
|
|
207
|
-
optional :to, String
|
|
206
|
+
variant -> { Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0Array }
|
|
208
207
|
|
|
209
|
-
#
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
208
|
+
# A dynamic variable string like `{{ targets }}` where `targets` is returned by the dynamic variables webhook and resolves to an array of target objects at runtime.
|
|
209
|
+
variant String
|
|
210
|
+
|
|
211
|
+
class UnionMember0 < Telnyx::Internal::Type::BaseModel
|
|
212
|
+
# @!attribute to
|
|
213
|
+
# The destination number or SIP URI of the call.
|
|
214
|
+
#
|
|
215
|
+
# @return [String]
|
|
216
|
+
required :to, String
|
|
217
|
+
|
|
218
|
+
# @!attribute name
|
|
219
|
+
# The name of the target.
|
|
220
|
+
#
|
|
221
|
+
# @return [String, nil]
|
|
222
|
+
optional :name, String
|
|
223
|
+
|
|
224
|
+
# @!method initialize(to:, name: nil)
|
|
225
|
+
# @param to [String] The destination number or SIP URI of the call.
|
|
226
|
+
#
|
|
227
|
+
# @param name [String] The name of the target.
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# @!method self.variants
|
|
231
|
+
# @return [Array(Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0>, String)]
|
|
232
|
+
|
|
233
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
234
|
+
UnionMember0Array =
|
|
235
|
+
Telnyx::Internal::Type::ArrayOf[-> {
|
|
236
|
+
Telnyx::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0
|
|
237
|
+
}]
|
|
213
238
|
end
|
|
214
239
|
|
|
215
240
|
class CustomHeader < Telnyx::Internal::Type::BaseModel
|
|
@@ -512,6 +537,21 @@ module Telnyx
|
|
|
512
537
|
# @return [String, nil]
|
|
513
538
|
optional :from, String
|
|
514
539
|
|
|
540
|
+
# @!attribute targets
|
|
541
|
+
# The different possible targets of the invite. The assistant will be able to
|
|
542
|
+
# choose one of the targets to invite to the call. This can also be a dynamic
|
|
543
|
+
# variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
544
|
+
# variables webhook and resolves to an array of target objects at runtime. If
|
|
545
|
+
# omitted or null, the invite tool can still be configured and targets may be
|
|
546
|
+
# supplied dynamically at runtime.
|
|
547
|
+
#
|
|
548
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Invite::InviteConfig::Targets::UnionMember0>, String, nil]
|
|
549
|
+
optional :targets,
|
|
550
|
+
union: -> {
|
|
551
|
+
Telnyx::AI::AssistantTool::Invite::InviteConfig::Targets
|
|
552
|
+
},
|
|
553
|
+
nil?: true
|
|
554
|
+
|
|
515
555
|
# @!attribute voicemail_detection
|
|
516
556
|
# Configuration for voicemail detection (AMD - Answering Machine Detection) on the
|
|
517
557
|
# invited call.
|
|
@@ -519,7 +559,7 @@ module Telnyx
|
|
|
519
559
|
# @return [Telnyx::Models::AI::AssistantTool::Invite::InviteConfig::VoicemailDetection, nil]
|
|
520
560
|
optional :voicemail_detection, -> { Telnyx::AI::AssistantTool::Invite::InviteConfig::VoicemailDetection }
|
|
521
561
|
|
|
522
|
-
# @!method initialize(custom_headers: nil, from: nil, voicemail_detection: nil)
|
|
562
|
+
# @!method initialize(custom_headers: nil, from: nil, targets: nil, voicemail_detection: nil)
|
|
523
563
|
# Some parameter documentations has been truncated, see
|
|
524
564
|
# {Telnyx::Models::AI::AssistantTool::Invite::InviteConfig} for more details.
|
|
525
565
|
#
|
|
@@ -527,6 +567,8 @@ module Telnyx
|
|
|
527
567
|
#
|
|
528
568
|
# @param from [String] Number or SIP URI placing the call.
|
|
529
569
|
#
|
|
570
|
+
# @param targets [Array<Telnyx::Models::AI::AssistantTool::Invite::InviteConfig::Targets::UnionMember0>, String, nil] The different possible targets of the invite. The assistant will be able to choo
|
|
571
|
+
#
|
|
530
572
|
# @param voicemail_detection [Telnyx::Models::AI::AssistantTool::Invite::InviteConfig::VoicemailDetection] Configuration for voicemail detection (AMD - Answering Machine Detection) on the
|
|
531
573
|
|
|
532
574
|
class CustomHeader < Telnyx::Internal::Type::BaseModel
|
|
@@ -554,6 +596,51 @@ module Telnyx
|
|
|
554
596
|
# @param value [String] The value of the header. Note that we support mustache templating for the value.
|
|
555
597
|
end
|
|
556
598
|
|
|
599
|
+
# The different possible targets of the invite. The assistant will be able to
|
|
600
|
+
# choose one of the targets to invite to the call. This can also be a dynamic
|
|
601
|
+
# variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
602
|
+
# variables webhook and resolves to an array of target objects at runtime. If
|
|
603
|
+
# omitted or null, the invite tool can still be configured and targets may be
|
|
604
|
+
# supplied dynamically at runtime.
|
|
605
|
+
#
|
|
606
|
+
# @see Telnyx::Models::AI::AssistantTool::Invite::InviteConfig#targets
|
|
607
|
+
module Targets
|
|
608
|
+
extend Telnyx::Internal::Type::Union
|
|
609
|
+
|
|
610
|
+
variant -> { Telnyx::Models::AI::AssistantTool::Invite::InviteConfig::Targets::UnionMember0Array }
|
|
611
|
+
|
|
612
|
+
# A dynamic variable string like `{{ targets }}` where `targets` is returned by the dynamic variables webhook and resolves to an array of target objects at runtime.
|
|
613
|
+
variant String
|
|
614
|
+
|
|
615
|
+
class UnionMember0 < Telnyx::Internal::Type::BaseModel
|
|
616
|
+
# @!attribute to
|
|
617
|
+
# The destination number or SIP URI of the call.
|
|
618
|
+
#
|
|
619
|
+
# @return [String]
|
|
620
|
+
required :to, String
|
|
621
|
+
|
|
622
|
+
# @!attribute name
|
|
623
|
+
# The name of the target.
|
|
624
|
+
#
|
|
625
|
+
# @return [String, nil]
|
|
626
|
+
optional :name, String
|
|
627
|
+
|
|
628
|
+
# @!method initialize(to:, name: nil)
|
|
629
|
+
# @param to [String] The destination number or SIP URI of the call.
|
|
630
|
+
#
|
|
631
|
+
# @param name [String] The name of the target.
|
|
632
|
+
end
|
|
633
|
+
|
|
634
|
+
# @!method self.variants
|
|
635
|
+
# @return [Array(Array<Telnyx::Models::AI::AssistantTool::Invite::InviteConfig::Targets::UnionMember0>, String)]
|
|
636
|
+
|
|
637
|
+
# @type [Telnyx::Internal::Type::Converter]
|
|
638
|
+
UnionMember0Array =
|
|
639
|
+
Telnyx::Internal::Type::ArrayOf[-> {
|
|
640
|
+
Telnyx::AI::AssistantTool::Invite::InviteConfig::Targets::UnionMember0
|
|
641
|
+
}]
|
|
642
|
+
end
|
|
643
|
+
|
|
557
644
|
# @see Telnyx::Models::AI::AssistantTool::Invite::InviteConfig#voicemail_detection
|
|
558
645
|
class VoicemailDetection < Telnyx::Internal::Type::BaseModel
|
|
559
646
|
# @!attribute detection_mode
|