telnyx 5.103.0 → 5.104.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 +21 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -170
- data/lib/telnyx/models/ai/assistant_integration.rb +38 -0
- data/lib/telnyx/models/ai/assistant_mcp_server.rb +35 -0
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
- data/lib/telnyx/models/ai/assistant_update_params.rb +9 -170
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +3 -123
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +3 -125
- data/lib/telnyx/models/ai/assistants/clause.rb +54 -0
- data/lib/telnyx/models/ai/assistants/rollout_slot.rb +27 -0
- data/lib/telnyx/models/ai/assistants/rule_input.rb +40 -0
- data/lib/telnyx/models/ai/assistants/rule_output.rb +40 -0
- data/lib/telnyx/models/ai/assistants/serve.rb +33 -0
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -171
- data/lib/telnyx/models/ai/inference_embedding.rb +9 -169
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
- data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -31
- data/lib/telnyx/models/ai/start_speaking_plan.rb +37 -0
- data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +39 -0
- data/lib/telnyx/models/ai/transfer_tool.rb +7 -9
- data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -31
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -23
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +4 -23
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +5 -167
- data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
- data/lib/telnyx/models/model_metadata.rb +33 -0
- data/lib/telnyx/models/network_list_interfaces_response.rb +112 -2
- data/lib/telnyx/models/public_internet_gateway_create_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_delete_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_read.rb +83 -0
- data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +3 -8
- data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
- data/lib/telnyx/models/uac_connection.rb +412 -0
- data/lib/telnyx/models/uac_connection_create_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_create_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_delete_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +3 -879
- data/lib/telnyx/models/uac_connection_update_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_update_response.rb +3 -878
- data/lib/telnyx/models/uac_external_settings.rb +101 -0
- data/lib/telnyx/models/uac_inbound.rb +210 -0
- data/lib/telnyx/models/uac_internal_settings.rb +25 -0
- data/lib/telnyx/models/uac_outbound.rb +131 -0
- data/lib/telnyx/models/virtual_cross_connect_combined.rb +212 -0
- data/lib/telnyx/models/virtual_cross_connect_create_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_update_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_create_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_delete_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_read.rb +136 -0
- data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +3 -8
- data/lib/telnyx/models/xai_voice_settings.rb +36 -0
- data/lib/telnyx/models.rb +20 -0
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/calls/actions.rb +5 -5
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/uac_connections.rb +8 -8
- data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
- data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +22 -4
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -341
- data/rbi/telnyx/models/ai/assistant_integration.rbi +60 -0
- data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +51 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -341
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +4 -290
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +3 -301
- data/rbi/telnyx/models/ai/assistants/clause.rbi +91 -0
- data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +36 -0
- data/rbi/telnyx/models/ai/assistants/rule_input.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/rule_output.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/serve.rbi +61 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -355
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -340
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -56
- data/rbi/telnyx/models/ai/start_speaking_plan.rbi +70 -0
- data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +71 -0
- data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -51
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +5 -41
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +10 -480
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/model_metadata.rbi +44 -0
- data/rbi/telnyx/models/network_list_interfaces_response.rbi +181 -4
- data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_read.rbi +128 -0
- data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
- data/rbi/telnyx/models/uac_connection.rbi +684 -0
- data/rbi/telnyx/models/uac_connection_create_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_create_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_update_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_update_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_external_settings.rbi +146 -0
- data/rbi/telnyx/models/uac_inbound.rbi +410 -0
- data/rbi/telnyx/models/uac_internal_settings.rbi +39 -0
- data/rbi/telnyx/models/uac_outbound.rbi +224 -0
- data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +345 -0
- data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_create_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_read.rbi +213 -0
- data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +6 -36
- data/rbi/telnyx/models/xai_voice_settings.rbi +64 -0
- data/rbi/telnyx/models.rbi +20 -0
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +2 -4
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -9
- data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
- data/rbi/telnyx/resources/calls/actions.rbi +6 -6
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/uac_connections.rbi +7 -13
- data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
- data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -142
- data/sig/telnyx/models/ai/assistant_integration.rbs +26 -0
- data/sig/telnyx/models/ai/assistant_mcp_server.rbs +19 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
- data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -142
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +6 -113
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +4 -109
- data/sig/telnyx/models/ai/assistants/clause.rbs +46 -0
- data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +19 -0
- data/sig/telnyx/models/ai/assistants/rule_input.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/rule_output.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/serve.rbs +35 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -145
- data/sig/telnyx/models/ai/inference_embedding.rbs +18 -142
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -39
- data/sig/telnyx/models/ai/start_speaking_plan.rbs +33 -0
- data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +38 -0
- data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -39
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -15
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +2 -184
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/model_metadata.rbs +32 -0
- data/sig/telnyx/models/network_list_interfaces_response.rbs +106 -4
- data/sig/telnyx/models/public_internet_gateway_create_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_read.rbs +80 -0
- data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
- data/sig/telnyx/models/uac_connection.rbs +338 -0
- data/sig/telnyx/models/uac_connection_create_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_create_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_delete_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_update_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_update_response.rbs +5 -731
- data/sig/telnyx/models/uac_external_settings.rbs +73 -0
- data/sig/telnyx/models/uac_inbound.rbs +190 -0
- data/sig/telnyx/models/uac_internal_settings.rbs +15 -0
- data/sig/telnyx/models/uac_outbound.rbs +113 -0
- data/sig/telnyx/models/virtual_cross_connect_combined.rbs +190 -0
- data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_create_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_delete_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_read.rbs +127 -0
- data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/xai_voice_settings.rbs +34 -0
- data/sig/telnyx/models.rbs +20 -0
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +6 -6
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/uac_connections.rbs +7 -7
- data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
- data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
- metadata +68 -14
- data/lib/telnyx/models/public_internet_gateway_list_response.rb +0 -10
- data/lib/telnyx/models/uac_connection_list_response.rb +0 -876
- data/lib/telnyx/models/virtual_cross_connect_list_response.rb +0 -10
- data/lib/telnyx/models/wireguard_interface_list_response.rb +0 -10
- data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +0 -23
- data/rbi/telnyx/models/uac_connection_list_response.rbi +0 -1727
- data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +0 -23
- data/rbi/telnyx/models/wireguard_interface_list_response.rbi +0 -23
- data/sig/telnyx/models/public_internet_gateway_list_response.rbs +0 -11
- data/sig/telnyx/models/uac_connection_list_response.rbs +0 -722
- data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +0 -11
- data/sig/telnyx/models/wireguard_interface_list_response.rbs +0 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2154962c4e4f5afd97c711f82206b39e6850e15b9380af208f7b7ef3ae60fa7b
|
|
4
|
+
data.tar.gz: '068f80cd9166458d035233bd8a77428c6df724341d9fdaf58b4dc229fdc9e5f0'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d0a6a1b2d40ab8fc74e635912e6b9e8399ded26087a7c3fd7615257466c62846545e5d9eb03d49628fbce130382432d34cc64e636bafe9a318ba00a0f7effc58
|
|
7
|
+
data.tar.gz: 962b77ba9d3e53c837a067298b335e291d4dba926eff6d3b4b89e5961bb400582363a546e9bed4d90489cb9a714abb84cfdc7845be01e9e933a036d4b9e4b4d1
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.104.0 (2026-05-08)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.103.1...v5.104.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.103.1...v5.104.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* AI-2289 add disable greeting interruption OpenAPI fields ([fcfa59d](https://github.com/team-telnyx/telnyx-ruby/commit/fcfa59d6de2187835003320ff333b0eef128e154))
|
|
10
|
+
|
|
11
|
+
## 5.103.1 (2026-05-07)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v5.103.0...v5.103.1](https://github.com/team-telnyx/telnyx-ruby/compare/v5.103.0...v5.103.1)
|
|
14
|
+
|
|
15
|
+
### Bug Fixes
|
|
16
|
+
|
|
17
|
+
* update UAC internal settings URI examples ([07542f9](https://github.com/team-telnyx/telnyx-ruby/commit/07542f9b0d6330a9d76652d110e7f5ccefc4830c))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Reverts
|
|
21
|
+
|
|
22
|
+
* restore stainless.yml from before 964956c ([dc4498d](https://github.com/team-telnyx/telnyx-ruby/commit/dc4498ddf4139f473022ff6c252075ab07d4d976))
|
|
23
|
+
|
|
3
24
|
## 5.103.0 (2026-05-07)
|
|
4
25
|
|
|
5
26
|
Full Changelog: [v5.102.1...v5.103.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.102.1...v5.103.0)
|
data/README.md
CHANGED
|
@@ -90,9 +90,8 @@ module Telnyx
|
|
|
90
90
|
# `/ai/integrations/connections`. Each item references a catalog integration by
|
|
91
91
|
# `integration_id`.
|
|
92
92
|
#
|
|
93
|
-
# @return [Array<Telnyx::Models::AI::
|
|
94
|
-
optional :integrations,
|
|
95
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::Integration] }
|
|
93
|
+
# @return [Array<Telnyx::Models::AI::AssistantIntegration>, nil]
|
|
94
|
+
optional :integrations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantIntegration] }
|
|
96
95
|
|
|
97
96
|
# @!attribute interruption_settings
|
|
98
97
|
# Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -102,8 +101,8 @@ module Telnyx
|
|
|
102
101
|
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
103
102
|
# `eager_eot_threshold`).
|
|
104
103
|
#
|
|
105
|
-
# @return [Telnyx::Models::AI::
|
|
106
|
-
optional :interruption_settings, -> { Telnyx::AI::
|
|
104
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings, nil]
|
|
105
|
+
optional :interruption_settings, -> { Telnyx::AI::InferenceEmbeddingInterruptionSettings }
|
|
107
106
|
|
|
108
107
|
# @!attribute llm_api_key_ref
|
|
109
108
|
# This is only needed when using third-party inference providers selected by
|
|
@@ -120,9 +119,8 @@ module Telnyx
|
|
|
120
119
|
# MCP servers attached to the assistant. Create MCP servers with
|
|
121
120
|
# `/ai/mcp_servers`, then reference them by `id` here.
|
|
122
121
|
#
|
|
123
|
-
# @return [Array<Telnyx::Models::AI::
|
|
124
|
-
optional :mcp_servers,
|
|
125
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::McpServer] }
|
|
122
|
+
# @return [Array<Telnyx::Models::AI::AssistantMcpServer>, nil]
|
|
123
|
+
optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantMcpServer] }
|
|
126
124
|
|
|
127
125
|
# @!attribute messaging_settings
|
|
128
126
|
#
|
|
@@ -229,13 +227,13 @@ module Telnyx
|
|
|
229
227
|
#
|
|
230
228
|
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
231
229
|
#
|
|
232
|
-
# @param integrations [Array<Telnyx::Models::AI::
|
|
230
|
+
# @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
|
|
233
231
|
#
|
|
234
|
-
# @param interruption_settings [Telnyx::Models::AI::
|
|
232
|
+
# @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
|
|
235
233
|
#
|
|
236
234
|
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
|
|
237
235
|
#
|
|
238
|
-
# @param mcp_servers [Array<Telnyx::Models::AI::
|
|
236
|
+
# @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
|
|
239
237
|
#
|
|
240
238
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
241
239
|
#
|
|
@@ -262,165 +260,6 @@ module Telnyx
|
|
|
262
260
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
263
261
|
#
|
|
264
262
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
265
|
-
|
|
266
|
-
class Integration < Telnyx::Internal::Type::BaseModel
|
|
267
|
-
# @!attribute integration_id
|
|
268
|
-
# Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
269
|
-
# at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
270
|
-
# entries returned by `/ai/integrations/connections`). It is **not** the
|
|
271
|
-
# connection-level `id` from `/ai/integrations/connections`.
|
|
272
|
-
#
|
|
273
|
-
# @return [String]
|
|
274
|
-
required :integration_id, String
|
|
275
|
-
|
|
276
|
-
# @!attribute allowed_list
|
|
277
|
-
# Optional per-assistant allowlist of integration tool names. When omitted or
|
|
278
|
-
# empty, all tools allowed by the connected integration are available to the
|
|
279
|
-
# assistant.
|
|
280
|
-
#
|
|
281
|
-
# @return [Array<String>, nil]
|
|
282
|
-
optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
|
|
283
|
-
|
|
284
|
-
# @!method initialize(integration_id:, allowed_list: nil)
|
|
285
|
-
# Some parameter documentations has been truncated, see
|
|
286
|
-
# {Telnyx::Models::AI::AssistantCreateParams::Integration} for more details.
|
|
287
|
-
#
|
|
288
|
-
# Reference to a connected integration attached to an assistant. Discover
|
|
289
|
-
# available integrations with `/ai/integrations` and connected integrations with
|
|
290
|
-
# `/ai/integrations/connections`.
|
|
291
|
-
#
|
|
292
|
-
# @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
293
|
-
#
|
|
294
|
-
# @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
|
|
295
|
-
end
|
|
296
|
-
|
|
297
|
-
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
298
|
-
# @!attribute enable
|
|
299
|
-
# Whether users can interrupt the assistant while it is speaking.
|
|
300
|
-
#
|
|
301
|
-
# @return [Boolean, nil]
|
|
302
|
-
optional :enable, Telnyx::Internal::Type::Boolean
|
|
303
|
-
|
|
304
|
-
# @!attribute start_speaking_plan
|
|
305
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
306
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
307
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
308
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
309
|
-
#
|
|
310
|
-
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan, nil]
|
|
311
|
-
optional :start_speaking_plan,
|
|
312
|
-
-> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan }
|
|
313
|
-
|
|
314
|
-
# @!method initialize(enable: nil, start_speaking_plan: nil)
|
|
315
|
-
# Some parameter documentations has been truncated, see
|
|
316
|
-
# {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings} for more
|
|
317
|
-
# details.
|
|
318
|
-
#
|
|
319
|
-
# Settings for interruptions and how the assistant decides the user has finished
|
|
320
|
-
# speaking. These timings are most relevant when using non turn-taking
|
|
321
|
-
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
322
|
-
# behavior is controlled by the transcription end-of-turn settings under
|
|
323
|
-
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
324
|
-
# `eager_eot_threshold`).
|
|
325
|
-
#
|
|
326
|
-
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
327
|
-
#
|
|
328
|
-
# @param start_speaking_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
329
|
-
|
|
330
|
-
# @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings#start_speaking_plan
|
|
331
|
-
class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
|
|
332
|
-
# @!attribute transcription_endpointing_plan
|
|
333
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
334
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
335
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
336
|
-
# `eager_eot_threshold`.
|
|
337
|
-
#
|
|
338
|
-
# @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
|
|
339
|
-
optional :transcription_endpointing_plan,
|
|
340
|
-
-> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
|
|
341
|
-
|
|
342
|
-
# @!attribute wait_seconds
|
|
343
|
-
# Minimum seconds to wait before the assistant starts speaking.
|
|
344
|
-
#
|
|
345
|
-
# @return [Float, nil]
|
|
346
|
-
optional :wait_seconds, Float
|
|
347
|
-
|
|
348
|
-
# @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
|
|
349
|
-
# Some parameter documentations has been truncated, see
|
|
350
|
-
# {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan}
|
|
351
|
-
# for more details.
|
|
352
|
-
#
|
|
353
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
354
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
355
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
356
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
357
|
-
#
|
|
358
|
-
# @param transcription_endpointing_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
|
|
359
|
-
#
|
|
360
|
-
# @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
|
|
361
|
-
|
|
362
|
-
# @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
|
|
363
|
-
class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
|
|
364
|
-
# @!attribute on_no_punctuation_seconds
|
|
365
|
-
# Seconds to wait after the transcript ends without punctuation.
|
|
366
|
-
#
|
|
367
|
-
# @return [Float, nil]
|
|
368
|
-
optional :on_no_punctuation_seconds, Float
|
|
369
|
-
|
|
370
|
-
# @!attribute on_number_seconds
|
|
371
|
-
# Seconds to wait after the transcript ends with a number.
|
|
372
|
-
#
|
|
373
|
-
# @return [Float, nil]
|
|
374
|
-
optional :on_number_seconds, Float
|
|
375
|
-
|
|
376
|
-
# @!attribute on_punctuation_seconds
|
|
377
|
-
# Seconds to wait after the transcript ends with punctuation.
|
|
378
|
-
#
|
|
379
|
-
# @return [Float, nil]
|
|
380
|
-
optional :on_punctuation_seconds, Float
|
|
381
|
-
|
|
382
|
-
# @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
|
|
383
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
384
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
385
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
386
|
-
# `eager_eot_threshold`.
|
|
387
|
-
#
|
|
388
|
-
# @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
|
|
389
|
-
#
|
|
390
|
-
# @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
|
|
391
|
-
#
|
|
392
|
-
# @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
|
|
393
|
-
end
|
|
394
|
-
end
|
|
395
|
-
end
|
|
396
|
-
|
|
397
|
-
class McpServer < Telnyx::Internal::Type::BaseModel
|
|
398
|
-
# @!attribute id
|
|
399
|
-
# ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
400
|
-
# by the `/ai/mcp_servers` endpoints.
|
|
401
|
-
#
|
|
402
|
-
# @return [String]
|
|
403
|
-
required :id, String
|
|
404
|
-
|
|
405
|
-
# @!attribute allowed_tools
|
|
406
|
-
# Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
407
|
-
# uses the MCP server's configured `allowed_tools`.
|
|
408
|
-
#
|
|
409
|
-
# @return [Array<String>, nil]
|
|
410
|
-
optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
|
|
411
|
-
|
|
412
|
-
# @!method initialize(id:, allowed_tools: nil)
|
|
413
|
-
# Some parameter documentations has been truncated, see
|
|
414
|
-
# {Telnyx::Models::AI::AssistantCreateParams::McpServer} for more details.
|
|
415
|
-
#
|
|
416
|
-
# Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
417
|
-
# servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
418
|
-
# ID.
|
|
419
|
-
#
|
|
420
|
-
# @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
421
|
-
#
|
|
422
|
-
# @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
423
|
-
end
|
|
424
263
|
end
|
|
425
264
|
end
|
|
426
265
|
end
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class AssistantIntegration < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute integration_id
|
|
8
|
+
# Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
9
|
+
# at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
10
|
+
# entries returned by `/ai/integrations/connections`). It is **not** the
|
|
11
|
+
# connection-level `id` from `/ai/integrations/connections`.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :integration_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute allowed_list
|
|
17
|
+
# Optional per-assistant allowlist of integration tool names. When omitted or
|
|
18
|
+
# empty, all tools allowed by the connected integration are available to the
|
|
19
|
+
# assistant.
|
|
20
|
+
#
|
|
21
|
+
# @return [Array<String>, nil]
|
|
22
|
+
optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
|
|
23
|
+
|
|
24
|
+
# @!method initialize(integration_id:, allowed_list: nil)
|
|
25
|
+
# Some parameter documentations has been truncated, see
|
|
26
|
+
# {Telnyx::Models::AI::AssistantIntegration} for more details.
|
|
27
|
+
#
|
|
28
|
+
# Reference to a connected integration attached to an assistant. Discover
|
|
29
|
+
# available integrations with `/ai/integrations` and connected integrations with
|
|
30
|
+
# `/ai/integrations/connections`.
|
|
31
|
+
#
|
|
32
|
+
# @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
33
|
+
#
|
|
34
|
+
# @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class AssistantMcpServer < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
9
|
+
# by the `/ai/mcp_servers` endpoints.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :id, String
|
|
13
|
+
|
|
14
|
+
# @!attribute allowed_tools
|
|
15
|
+
# Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
16
|
+
# uses the MCP server's configured `allowed_tools`.
|
|
17
|
+
#
|
|
18
|
+
# @return [Array<String>, nil]
|
|
19
|
+
optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
|
|
20
|
+
|
|
21
|
+
# @!method initialize(id:, allowed_tools: nil)
|
|
22
|
+
# Some parameter documentations has been truncated, see
|
|
23
|
+
# {Telnyx::Models::AI::AssistantMcpServer} for more details.
|
|
24
|
+
#
|
|
25
|
+
# Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
26
|
+
# servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
27
|
+
# ID.
|
|
28
|
+
#
|
|
29
|
+
# @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
30
|
+
#
|
|
31
|
+
# @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -144,7 +144,7 @@ module Telnyx
|
|
|
144
144
|
# variable string like `{{ targets }}` where `targets` is returned by the dynamic
|
|
145
145
|
# variables webhook and resolves to an array of target objects at runtime.
|
|
146
146
|
#
|
|
147
|
-
# @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::
|
|
147
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList>, String]
|
|
148
148
|
required :targets, union: -> { Telnyx::AI::AssistantTool::Transfer::Transfer::Targets }
|
|
149
149
|
|
|
150
150
|
# @!attribute custom_headers
|
|
@@ -184,7 +184,7 @@ module Telnyx
|
|
|
184
184
|
#
|
|
185
185
|
# @param from [String] Number or SIP URI placing the call.
|
|
186
186
|
#
|
|
187
|
-
# @param targets [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::
|
|
187
|
+
# @param targets [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList>, String] The different possible targets of the transfer. The assistant will be able to ch
|
|
188
188
|
#
|
|
189
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.
|
|
190
190
|
#
|
|
@@ -203,12 +203,12 @@ module Telnyx
|
|
|
203
203
|
module Targets
|
|
204
204
|
extend Telnyx::Internal::Type::Union
|
|
205
205
|
|
|
206
|
-
variant -> { Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::
|
|
206
|
+
variant -> { Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsListArray }
|
|
207
207
|
|
|
208
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
209
|
variant String
|
|
210
210
|
|
|
211
|
-
class
|
|
211
|
+
class TargetsList < Telnyx::Internal::Type::BaseModel
|
|
212
212
|
# @!attribute to
|
|
213
213
|
# The destination number or SIP URI of the call.
|
|
214
214
|
#
|
|
@@ -228,12 +228,12 @@ module Telnyx
|
|
|
228
228
|
end
|
|
229
229
|
|
|
230
230
|
# @!method self.variants
|
|
231
|
-
# @return [Array(Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::
|
|
231
|
+
# @return [Array(Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList>, String)]
|
|
232
232
|
|
|
233
233
|
# @type [Telnyx::Internal::Type::Converter]
|
|
234
|
-
|
|
234
|
+
TargetsListArray =
|
|
235
235
|
Telnyx::Internal::Type::ArrayOf[-> {
|
|
236
|
-
Telnyx::AI::AssistantTool::Transfer::Transfer::Targets::
|
|
236
|
+
Telnyx::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList
|
|
237
237
|
}]
|
|
238
238
|
end
|
|
239
239
|
|
|
@@ -545,7 +545,7 @@ module Telnyx
|
|
|
545
545
|
# omitted or null, the invite tool can still be configured and targets may be
|
|
546
546
|
# supplied dynamically at runtime.
|
|
547
547
|
#
|
|
548
|
-
# @return [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::
|
|
548
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsList>, String, nil]
|
|
549
549
|
optional :targets, union: -> { Telnyx::AI::AssistantTool::Invite::Invite::Targets }, nil?: true
|
|
550
550
|
|
|
551
551
|
# @!attribute voicemail_detection
|
|
@@ -563,7 +563,7 @@ module Telnyx
|
|
|
563
563
|
#
|
|
564
564
|
# @param custom_headers [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::CustomHeader>] Custom headers to be added to the SIP INVITE for the invite command.
|
|
565
565
|
#
|
|
566
|
-
# @param targets [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::
|
|
566
|
+
# @param targets [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsList>, String, nil] The different possible targets of the invite. The assistant will be able to choo
|
|
567
567
|
#
|
|
568
568
|
# @param voicemail_detection [Telnyx::Models::AI::AssistantTool::Invite::Invite::VoicemailDetection] Configuration for voicemail detection (AMD - Answering Machine Detection) on the
|
|
569
569
|
|
|
@@ -603,12 +603,12 @@ module Telnyx
|
|
|
603
603
|
module Targets
|
|
604
604
|
extend Telnyx::Internal::Type::Union
|
|
605
605
|
|
|
606
|
-
variant -> { Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::
|
|
606
|
+
variant -> { Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsListArray }
|
|
607
607
|
|
|
608
608
|
# 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.
|
|
609
609
|
variant String
|
|
610
610
|
|
|
611
|
-
class
|
|
611
|
+
class TargetsList < Telnyx::Internal::Type::BaseModel
|
|
612
612
|
# @!attribute to
|
|
613
613
|
# The destination number or SIP URI of the call.
|
|
614
614
|
#
|
|
@@ -628,12 +628,12 @@ module Telnyx
|
|
|
628
628
|
end
|
|
629
629
|
|
|
630
630
|
# @!method self.variants
|
|
631
|
-
# @return [Array(Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::
|
|
631
|
+
# @return [Array(Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsList>, String)]
|
|
632
632
|
|
|
633
633
|
# @type [Telnyx::Internal::Type::Converter]
|
|
634
|
-
|
|
634
|
+
TargetsListArray =
|
|
635
635
|
Telnyx::Internal::Type::ArrayOf[-> {
|
|
636
|
-
Telnyx::AI::AssistantTool::Invite::Invite::Targets::
|
|
636
|
+
Telnyx::AI::AssistantTool::Invite::Invite::Targets::TargetsList
|
|
637
637
|
}]
|
|
638
638
|
end
|
|
639
639
|
|
|
@@ -90,9 +90,8 @@ module Telnyx
|
|
|
90
90
|
# `/ai/integrations/connections`. Each item references a catalog integration by
|
|
91
91
|
# `integration_id`.
|
|
92
92
|
#
|
|
93
|
-
# @return [Array<Telnyx::Models::AI::
|
|
94
|
-
optional :integrations,
|
|
95
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantUpdateParams::Integration] }
|
|
93
|
+
# @return [Array<Telnyx::Models::AI::AssistantIntegration>, nil]
|
|
94
|
+
optional :integrations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantIntegration] }
|
|
96
95
|
|
|
97
96
|
# @!attribute interruption_settings
|
|
98
97
|
# Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -102,8 +101,8 @@ module Telnyx
|
|
|
102
101
|
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
103
102
|
# `eager_eot_threshold`).
|
|
104
103
|
#
|
|
105
|
-
# @return [Telnyx::Models::AI::
|
|
106
|
-
optional :interruption_settings, -> { Telnyx::AI::
|
|
104
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings, nil]
|
|
105
|
+
optional :interruption_settings, -> { Telnyx::AI::InferenceEmbeddingInterruptionSettings }
|
|
107
106
|
|
|
108
107
|
# @!attribute llm_api_key_ref
|
|
109
108
|
# This is only needed when using third-party inference providers selected by
|
|
@@ -120,9 +119,8 @@ module Telnyx
|
|
|
120
119
|
# MCP servers attached to the assistant. Create MCP servers with
|
|
121
120
|
# `/ai/mcp_servers`, then reference them by `id` here.
|
|
122
121
|
#
|
|
123
|
-
# @return [Array<Telnyx::Models::AI::
|
|
124
|
-
optional :mcp_servers,
|
|
125
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantUpdateParams::McpServer] }
|
|
122
|
+
# @return [Array<Telnyx::Models::AI::AssistantMcpServer>, nil]
|
|
123
|
+
optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantMcpServer] }
|
|
126
124
|
|
|
127
125
|
# @!attribute messaging_settings
|
|
128
126
|
#
|
|
@@ -247,13 +245,13 @@ module Telnyx
|
|
|
247
245
|
#
|
|
248
246
|
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
249
247
|
#
|
|
250
|
-
# @param integrations [Array<Telnyx::Models::AI::
|
|
248
|
+
# @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
|
|
251
249
|
#
|
|
252
|
-
# @param interruption_settings [Telnyx::Models::AI::
|
|
250
|
+
# @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
|
|
253
251
|
#
|
|
254
252
|
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
|
|
255
253
|
#
|
|
256
|
-
# @param mcp_servers [Array<Telnyx::Models::AI::
|
|
254
|
+
# @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
|
|
257
255
|
#
|
|
258
256
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
259
257
|
#
|
|
@@ -286,165 +284,6 @@ module Telnyx
|
|
|
286
284
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
287
285
|
#
|
|
288
286
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
289
|
-
|
|
290
|
-
class Integration < Telnyx::Internal::Type::BaseModel
|
|
291
|
-
# @!attribute integration_id
|
|
292
|
-
# Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
293
|
-
# at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
294
|
-
# entries returned by `/ai/integrations/connections`). It is **not** the
|
|
295
|
-
# connection-level `id` from `/ai/integrations/connections`.
|
|
296
|
-
#
|
|
297
|
-
# @return [String]
|
|
298
|
-
required :integration_id, String
|
|
299
|
-
|
|
300
|
-
# @!attribute allowed_list
|
|
301
|
-
# Optional per-assistant allowlist of integration tool names. When omitted or
|
|
302
|
-
# empty, all tools allowed by the connected integration are available to the
|
|
303
|
-
# assistant.
|
|
304
|
-
#
|
|
305
|
-
# @return [Array<String>, nil]
|
|
306
|
-
optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
|
|
307
|
-
|
|
308
|
-
# @!method initialize(integration_id:, allowed_list: nil)
|
|
309
|
-
# Some parameter documentations has been truncated, see
|
|
310
|
-
# {Telnyx::Models::AI::AssistantUpdateParams::Integration} for more details.
|
|
311
|
-
#
|
|
312
|
-
# Reference to a connected integration attached to an assistant. Discover
|
|
313
|
-
# available integrations with `/ai/integrations` and connected integrations with
|
|
314
|
-
# `/ai/integrations/connections`.
|
|
315
|
-
#
|
|
316
|
-
# @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
317
|
-
#
|
|
318
|
-
# @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
|
|
319
|
-
end
|
|
320
|
-
|
|
321
|
-
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
322
|
-
# @!attribute enable
|
|
323
|
-
# Whether users can interrupt the assistant while it is speaking.
|
|
324
|
-
#
|
|
325
|
-
# @return [Boolean, nil]
|
|
326
|
-
optional :enable, Telnyx::Internal::Type::Boolean
|
|
327
|
-
|
|
328
|
-
# @!attribute start_speaking_plan
|
|
329
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
330
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
331
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
332
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
333
|
-
#
|
|
334
|
-
# @return [Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan, nil]
|
|
335
|
-
optional :start_speaking_plan,
|
|
336
|
-
-> { Telnyx::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan }
|
|
337
|
-
|
|
338
|
-
# @!method initialize(enable: nil, start_speaking_plan: nil)
|
|
339
|
-
# Some parameter documentations has been truncated, see
|
|
340
|
-
# {Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings} for more
|
|
341
|
-
# details.
|
|
342
|
-
#
|
|
343
|
-
# Settings for interruptions and how the assistant decides the user has finished
|
|
344
|
-
# speaking. These timings are most relevant when using non turn-taking
|
|
345
|
-
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
346
|
-
# behavior is controlled by the transcription end-of-turn settings under
|
|
347
|
-
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
348
|
-
# `eager_eot_threshold`).
|
|
349
|
-
#
|
|
350
|
-
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
351
|
-
#
|
|
352
|
-
# @param start_speaking_plan [Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
353
|
-
|
|
354
|
-
# @see Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings#start_speaking_plan
|
|
355
|
-
class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
|
|
356
|
-
# @!attribute transcription_endpointing_plan
|
|
357
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
358
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
359
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
360
|
-
# `eager_eot_threshold`.
|
|
361
|
-
#
|
|
362
|
-
# @return [Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
|
|
363
|
-
optional :transcription_endpointing_plan,
|
|
364
|
-
-> { Telnyx::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
|
|
365
|
-
|
|
366
|
-
# @!attribute wait_seconds
|
|
367
|
-
# Minimum seconds to wait before the assistant starts speaking.
|
|
368
|
-
#
|
|
369
|
-
# @return [Float, nil]
|
|
370
|
-
optional :wait_seconds, Float
|
|
371
|
-
|
|
372
|
-
# @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
|
|
373
|
-
# Some parameter documentations has been truncated, see
|
|
374
|
-
# {Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan}
|
|
375
|
-
# for more details.
|
|
376
|
-
#
|
|
377
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
378
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
379
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
380
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
381
|
-
#
|
|
382
|
-
# @param transcription_endpointing_plan [Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
|
|
383
|
-
#
|
|
384
|
-
# @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
|
|
385
|
-
|
|
386
|
-
# @see Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
|
|
387
|
-
class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
|
|
388
|
-
# @!attribute on_no_punctuation_seconds
|
|
389
|
-
# Seconds to wait after the transcript ends without punctuation.
|
|
390
|
-
#
|
|
391
|
-
# @return [Float, nil]
|
|
392
|
-
optional :on_no_punctuation_seconds, Float
|
|
393
|
-
|
|
394
|
-
# @!attribute on_number_seconds
|
|
395
|
-
# Seconds to wait after the transcript ends with a number.
|
|
396
|
-
#
|
|
397
|
-
# @return [Float, nil]
|
|
398
|
-
optional :on_number_seconds, Float
|
|
399
|
-
|
|
400
|
-
# @!attribute on_punctuation_seconds
|
|
401
|
-
# Seconds to wait after the transcript ends with punctuation.
|
|
402
|
-
#
|
|
403
|
-
# @return [Float, nil]
|
|
404
|
-
optional :on_punctuation_seconds, Float
|
|
405
|
-
|
|
406
|
-
# @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
|
|
407
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
408
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
409
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
410
|
-
# `eager_eot_threshold`.
|
|
411
|
-
#
|
|
412
|
-
# @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
|
|
413
|
-
#
|
|
414
|
-
# @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
|
|
415
|
-
#
|
|
416
|
-
# @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
|
|
417
|
-
end
|
|
418
|
-
end
|
|
419
|
-
end
|
|
420
|
-
|
|
421
|
-
class McpServer < Telnyx::Internal::Type::BaseModel
|
|
422
|
-
# @!attribute id
|
|
423
|
-
# ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
424
|
-
# by the `/ai/mcp_servers` endpoints.
|
|
425
|
-
#
|
|
426
|
-
# @return [String]
|
|
427
|
-
required :id, String
|
|
428
|
-
|
|
429
|
-
# @!attribute allowed_tools
|
|
430
|
-
# Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
431
|
-
# uses the MCP server's configured `allowed_tools`.
|
|
432
|
-
#
|
|
433
|
-
# @return [Array<String>, nil]
|
|
434
|
-
optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
|
|
435
|
-
|
|
436
|
-
# @!method initialize(id:, allowed_tools: nil)
|
|
437
|
-
# Some parameter documentations has been truncated, see
|
|
438
|
-
# {Telnyx::Models::AI::AssistantUpdateParams::McpServer} for more details.
|
|
439
|
-
#
|
|
440
|
-
# Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
441
|
-
# servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
442
|
-
# ID.
|
|
443
|
-
#
|
|
444
|
-
# @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
445
|
-
#
|
|
446
|
-
# @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
447
|
-
end
|
|
448
287
|
end
|
|
449
288
|
end
|
|
450
289
|
end
|