telnyx 5.112.0 → 5.113.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 +17 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -178
- 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 -178
- 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 -179
- data/lib/telnyx/models/ai/inference_embedding.rb +9 -177
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
- data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
- data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -210
- 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_create_response_params.rb +4 -4
- data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -210
- data/lib/telnyx/models/call_conversation_ended.rb +13 -1
- 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/action_start_conversation_relay_params.rb +169 -118
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
- data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +100 -0
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +8 -167
- data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
- data/lib/telnyx/models/fax.rb +7 -5
- data/lib/telnyx/models/fax_create_params.rb +7 -5
- data/lib/telnyx/models/fax_delivered.rb +3 -2
- data/lib/telnyx/models/fax_failed.rb +3 -2
- data/lib/telnyx/models/fax_media_processed.rb +3 -2
- data/lib/telnyx/models/fax_queued.rb +3 -2
- data/lib/telnyx/models/fax_sending_started.rb +3 -2
- data/lib/telnyx/models/model_metadata.rb +212 -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/texml/accounts/call_calls_params.rb +62 -12
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +18 -4
- 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/ai/openai.rb +1 -1
- data/lib/telnyx/resources/ai.rb +3 -3
- data/lib/telnyx/resources/calls/actions.rb +15 -17
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/faxes.rb +13 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/texml.rb +4 -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 +23 -4
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -352
- 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 -352
- 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 -366
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -351
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -315
- 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_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -310
- data/rbi/telnyx/models/call_conversation_ended.rbi +10 -0
- 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/action_start_conversation_relay_params.rbi +371 -254
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
- data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +289 -0
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +20 -480
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/fax.rbi +12 -8
- data/rbi/telnyx/models/fax_create_params.rbi +12 -8
- data/rbi/telnyx/models/fax_delivered.rbi +6 -4
- data/rbi/telnyx/models/fax_failed.rbi +6 -4
- data/rbi/telnyx/models/fax_media_processed.rbi +6 -4
- data/rbi/telnyx/models/fax_queued.rbi +6 -4
- data/rbi/telnyx/models/fax_sending_started.rbi +6 -4
- data/rbi/telnyx/models/model_metadata.rbi +272 -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/texml/accounts/call_calls_params.rbi +81 -9
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +27 -3
- 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/ai/openai.rbi +1 -1
- data/rbi/telnyx/resources/ai.rbi +2 -2
- data/rbi/telnyx/resources/calls/actions.rbi +24 -24
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/faxes.rbi +18 -4
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/texml.rbi +7 -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 -149
- 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 -149
- 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 -152
- data/sig/telnyx/models/ai/inference_embedding.rbs +18 -149
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -149
- 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_create_response_params.rbs +5 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -149
- data/sig/telnyx/models/call_conversation_ended.rbs +5 -0
- 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/action_start_conversation_relay_params.rbs +141 -102
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
- data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +114 -0
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +13 -185
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/model_metadata.rbs +142 -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/texml/accounts/call_calls_params.rbs +27 -3
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +9 -1
- 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/ai/openai.rbs +1 -1
- data/sig/telnyx/resources/ai.rbs +1 -1
- data/sig/telnyx/resources/calls/actions.rbs +2 -4
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/texml.rbs +1 -0
- 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 +71 -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
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Assistants
|
|
7
|
+
class Serve < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute rollout
|
|
9
|
+
#
|
|
10
|
+
# @return [Array<Telnyx::Models::AI::Assistants::RolloutSlot>, nil]
|
|
11
|
+
optional :rollout, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::RolloutSlot] }
|
|
12
|
+
|
|
13
|
+
# @!attribute version_id
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :version_id, String
|
|
17
|
+
|
|
18
|
+
# @!method initialize(rollout: nil, version_id: nil)
|
|
19
|
+
# What a rule serves when matched.
|
|
20
|
+
#
|
|
21
|
+
# Exactly one of:
|
|
22
|
+
#
|
|
23
|
+
# - `version_id` — serve a specific version
|
|
24
|
+
# - `rollout` — weighted random across versions; weights must sum to less than
|
|
25
|
+
# 100, with the leftover routing to the main version
|
|
26
|
+
#
|
|
27
|
+
# @param rollout [Array<Telnyx::Models::AI::Assistants::RolloutSlot>]
|
|
28
|
+
# @param version_id [String]
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
@@ -82,9 +82,8 @@ module Telnyx
|
|
|
82
82
|
# `/ai/integrations/connections`. Each item references a catalog integration by
|
|
83
83
|
# `integration_id`.
|
|
84
84
|
#
|
|
85
|
-
# @return [Array<Telnyx::Models::AI::
|
|
86
|
-
optional :integrations,
|
|
87
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::UpdateAssistant::Integration] }
|
|
85
|
+
# @return [Array<Telnyx::Models::AI::AssistantIntegration>, nil]
|
|
86
|
+
optional :integrations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantIntegration] }
|
|
88
87
|
|
|
89
88
|
# @!attribute interruption_settings
|
|
90
89
|
# Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -94,8 +93,8 @@ module Telnyx
|
|
|
94
93
|
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
95
94
|
# `eager_eot_threshold`).
|
|
96
95
|
#
|
|
97
|
-
# @return [Telnyx::Models::AI::
|
|
98
|
-
optional :interruption_settings, -> { Telnyx::AI::
|
|
96
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings, nil]
|
|
97
|
+
optional :interruption_settings, -> { Telnyx::AI::InferenceEmbeddingInterruptionSettings }
|
|
99
98
|
|
|
100
99
|
# @!attribute llm_api_key_ref
|
|
101
100
|
# This is only needed when using third-party inference providers selected by
|
|
@@ -112,9 +111,8 @@ module Telnyx
|
|
|
112
111
|
# MCP servers attached to the assistant. Create MCP servers with
|
|
113
112
|
# `/ai/mcp_servers`, then reference them by `id` here.
|
|
114
113
|
#
|
|
115
|
-
# @return [Array<Telnyx::Models::AI::
|
|
116
|
-
optional :mcp_servers,
|
|
117
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Assistants::UpdateAssistant::McpServer] }
|
|
114
|
+
# @return [Array<Telnyx::Models::AI::AssistantMcpServer>, nil]
|
|
115
|
+
optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantMcpServer] }
|
|
118
116
|
|
|
119
117
|
# @!attribute messaging_settings
|
|
120
118
|
#
|
|
@@ -230,13 +228,13 @@ module Telnyx
|
|
|
230
228
|
#
|
|
231
229
|
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
232
230
|
#
|
|
233
|
-
# @param integrations [Array<Telnyx::Models::AI::
|
|
231
|
+
# @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
|
|
234
232
|
#
|
|
235
|
-
# @param interruption_settings [Telnyx::Models::AI::
|
|
233
|
+
# @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
|
|
236
234
|
#
|
|
237
235
|
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
|
|
238
236
|
#
|
|
239
|
-
# @param mcp_servers [Array<Telnyx::Models::AI::
|
|
237
|
+
# @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
|
|
240
238
|
#
|
|
241
239
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
242
240
|
#
|
|
@@ -265,174 +263,6 @@ module Telnyx
|
|
|
265
263
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
266
264
|
#
|
|
267
265
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
268
|
-
|
|
269
|
-
class Integration < Telnyx::Internal::Type::BaseModel
|
|
270
|
-
# @!attribute integration_id
|
|
271
|
-
# Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
272
|
-
# at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
273
|
-
# entries returned by `/ai/integrations/connections`). It is **not** the
|
|
274
|
-
# connection-level `id` from `/ai/integrations/connections`.
|
|
275
|
-
#
|
|
276
|
-
# @return [String]
|
|
277
|
-
required :integration_id, String
|
|
278
|
-
|
|
279
|
-
# @!attribute allowed_list
|
|
280
|
-
# Optional per-assistant allowlist of integration tool names. When omitted or
|
|
281
|
-
# empty, all tools allowed by the connected integration are available to the
|
|
282
|
-
# assistant.
|
|
283
|
-
#
|
|
284
|
-
# @return [Array<String>, nil]
|
|
285
|
-
optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
|
|
286
|
-
|
|
287
|
-
# @!method initialize(integration_id:, allowed_list: nil)
|
|
288
|
-
# Some parameter documentations has been truncated, see
|
|
289
|
-
# {Telnyx::Models::AI::Assistants::UpdateAssistant::Integration} for more details.
|
|
290
|
-
#
|
|
291
|
-
# Reference to a connected integration attached to an assistant. Discover
|
|
292
|
-
# available integrations with `/ai/integrations` and connected integrations with
|
|
293
|
-
# `/ai/integrations/connections`.
|
|
294
|
-
#
|
|
295
|
-
# @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
296
|
-
#
|
|
297
|
-
# @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
|
|
298
|
-
end
|
|
299
|
-
|
|
300
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant#interruption_settings
|
|
301
|
-
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
302
|
-
# @!attribute disable_greeting_interruption
|
|
303
|
-
# When true, disables user interruptions while the assistant greeting is playing.
|
|
304
|
-
#
|
|
305
|
-
# @return [Boolean, nil]
|
|
306
|
-
optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
|
|
307
|
-
|
|
308
|
-
# @!attribute enable
|
|
309
|
-
# Whether users can interrupt the assistant while it is speaking.
|
|
310
|
-
#
|
|
311
|
-
# @return [Boolean, nil]
|
|
312
|
-
optional :enable, Telnyx::Internal::Type::Boolean
|
|
313
|
-
|
|
314
|
-
# @!attribute start_speaking_plan
|
|
315
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
316
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
317
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
318
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
319
|
-
#
|
|
320
|
-
# @return [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan, nil]
|
|
321
|
-
optional :start_speaking_plan,
|
|
322
|
-
-> { Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan }
|
|
323
|
-
|
|
324
|
-
# @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
|
|
325
|
-
# Some parameter documentations has been truncated, see
|
|
326
|
-
# {Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings} for more
|
|
327
|
-
# details.
|
|
328
|
-
#
|
|
329
|
-
# Settings for interruptions and how the assistant decides the user has finished
|
|
330
|
-
# speaking. These timings are most relevant when using non turn-taking
|
|
331
|
-
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
332
|
-
# behavior is controlled by the transcription end-of-turn settings under
|
|
333
|
-
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
334
|
-
# `eager_eot_threshold`).
|
|
335
|
-
#
|
|
336
|
-
# @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
|
|
337
|
-
#
|
|
338
|
-
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
339
|
-
#
|
|
340
|
-
# @param start_speaking_plan [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
341
|
-
|
|
342
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings#start_speaking_plan
|
|
343
|
-
class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
|
|
344
|
-
# @!attribute transcription_endpointing_plan
|
|
345
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
346
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
347
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
348
|
-
# `eager_eot_threshold`.
|
|
349
|
-
#
|
|
350
|
-
# @return [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
|
|
351
|
-
optional :transcription_endpointing_plan,
|
|
352
|
-
-> { Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
|
|
353
|
-
|
|
354
|
-
# @!attribute wait_seconds
|
|
355
|
-
# Minimum seconds to wait before the assistant starts speaking.
|
|
356
|
-
#
|
|
357
|
-
# @return [Float, nil]
|
|
358
|
-
optional :wait_seconds, Float
|
|
359
|
-
|
|
360
|
-
# @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
|
|
361
|
-
# Some parameter documentations has been truncated, see
|
|
362
|
-
# {Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan}
|
|
363
|
-
# for more details.
|
|
364
|
-
#
|
|
365
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
366
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
367
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
368
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
369
|
-
#
|
|
370
|
-
# @param transcription_endpointing_plan [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
|
|
371
|
-
#
|
|
372
|
-
# @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
|
|
373
|
-
|
|
374
|
-
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
|
|
375
|
-
class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
|
|
376
|
-
# @!attribute on_no_punctuation_seconds
|
|
377
|
-
# Seconds to wait after the transcript ends without punctuation.
|
|
378
|
-
#
|
|
379
|
-
# @return [Float, nil]
|
|
380
|
-
optional :on_no_punctuation_seconds, Float
|
|
381
|
-
|
|
382
|
-
# @!attribute on_number_seconds
|
|
383
|
-
# Seconds to wait after the transcript ends with a number.
|
|
384
|
-
#
|
|
385
|
-
# @return [Float, nil]
|
|
386
|
-
optional :on_number_seconds, Float
|
|
387
|
-
|
|
388
|
-
# @!attribute on_punctuation_seconds
|
|
389
|
-
# Seconds to wait after the transcript ends with punctuation.
|
|
390
|
-
#
|
|
391
|
-
# @return [Float, nil]
|
|
392
|
-
optional :on_punctuation_seconds, Float
|
|
393
|
-
|
|
394
|
-
# @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
|
|
395
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
396
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
397
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
398
|
-
# `eager_eot_threshold`.
|
|
399
|
-
#
|
|
400
|
-
# @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
|
|
401
|
-
#
|
|
402
|
-
# @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
|
|
403
|
-
#
|
|
404
|
-
# @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
|
|
405
|
-
end
|
|
406
|
-
end
|
|
407
|
-
end
|
|
408
|
-
|
|
409
|
-
class McpServer < Telnyx::Internal::Type::BaseModel
|
|
410
|
-
# @!attribute id
|
|
411
|
-
# ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
412
|
-
# by the `/ai/mcp_servers` endpoints.
|
|
413
|
-
#
|
|
414
|
-
# @return [String]
|
|
415
|
-
required :id, String
|
|
416
|
-
|
|
417
|
-
# @!attribute allowed_tools
|
|
418
|
-
# Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
419
|
-
# uses the MCP server's configured `allowed_tools`.
|
|
420
|
-
#
|
|
421
|
-
# @return [Array<String>, nil]
|
|
422
|
-
optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
|
|
423
|
-
|
|
424
|
-
# @!method initialize(id:, allowed_tools: nil)
|
|
425
|
-
# Some parameter documentations has been truncated, see
|
|
426
|
-
# {Telnyx::Models::AI::Assistants::UpdateAssistant::McpServer} for more details.
|
|
427
|
-
#
|
|
428
|
-
# Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
429
|
-
# servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
430
|
-
# ID.
|
|
431
|
-
#
|
|
432
|
-
# @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
433
|
-
#
|
|
434
|
-
# @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
435
|
-
end
|
|
436
266
|
end
|
|
437
267
|
end
|
|
438
268
|
|
|
@@ -112,9 +112,8 @@ module Telnyx
|
|
|
112
112
|
# `/ai/integrations/connections`. Each item references a catalog integration by
|
|
113
113
|
# `integration_id`.
|
|
114
114
|
#
|
|
115
|
-
# @return [Array<Telnyx::Models::AI::
|
|
116
|
-
optional :integrations,
|
|
117
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::InferenceEmbedding::Integration] }
|
|
115
|
+
# @return [Array<Telnyx::Models::AI::AssistantIntegration>, nil]
|
|
116
|
+
optional :integrations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantIntegration] }
|
|
118
117
|
|
|
119
118
|
# @!attribute interruption_settings
|
|
120
119
|
# Settings for interruptions and how the assistant decides the user has finished
|
|
@@ -124,8 +123,8 @@ module Telnyx
|
|
|
124
123
|
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
125
124
|
# `eager_eot_threshold`).
|
|
126
125
|
#
|
|
127
|
-
# @return [Telnyx::Models::AI::
|
|
128
|
-
optional :interruption_settings, -> { Telnyx::AI::
|
|
126
|
+
# @return [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings, nil]
|
|
127
|
+
optional :interruption_settings, -> { Telnyx::AI::InferenceEmbeddingInterruptionSettings }
|
|
129
128
|
|
|
130
129
|
# @!attribute llm_api_key_ref
|
|
131
130
|
# This is only needed when using third-party inference providers selected by
|
|
@@ -142,8 +141,8 @@ module Telnyx
|
|
|
142
141
|
# MCP servers attached to the assistant. Create MCP servers with
|
|
143
142
|
# `/ai/mcp_servers`, then reference them by `id` here.
|
|
144
143
|
#
|
|
145
|
-
# @return [Array<Telnyx::Models::AI::
|
|
146
|
-
optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::
|
|
144
|
+
# @return [Array<Telnyx::Models::AI::AssistantMcpServer>, nil]
|
|
145
|
+
optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantMcpServer] }
|
|
147
146
|
|
|
148
147
|
# @!attribute messaging_settings
|
|
149
148
|
#
|
|
@@ -266,13 +265,13 @@ module Telnyx
|
|
|
266
265
|
#
|
|
267
266
|
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
268
267
|
#
|
|
269
|
-
# @param integrations [Array<Telnyx::Models::AI::
|
|
268
|
+
# @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
|
|
270
269
|
#
|
|
271
|
-
# @param interruption_settings [Telnyx::Models::AI::
|
|
270
|
+
# @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
|
|
272
271
|
#
|
|
273
272
|
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
|
|
274
273
|
#
|
|
275
|
-
# @param mcp_servers [Array<Telnyx::Models::AI::
|
|
274
|
+
# @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
|
|
276
275
|
#
|
|
277
276
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
278
277
|
#
|
|
@@ -301,173 +300,6 @@ module Telnyx
|
|
|
301
300
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
302
301
|
#
|
|
303
302
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
304
|
-
|
|
305
|
-
class Integration < Telnyx::Internal::Type::BaseModel
|
|
306
|
-
# @!attribute integration_id
|
|
307
|
-
# Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
308
|
-
# at `/ai/integrations` (the same value also appears as `integration_id` on
|
|
309
|
-
# entries returned by `/ai/integrations/connections`). It is **not** the
|
|
310
|
-
# connection-level `id` from `/ai/integrations/connections`.
|
|
311
|
-
#
|
|
312
|
-
# @return [String]
|
|
313
|
-
required :integration_id, String
|
|
314
|
-
|
|
315
|
-
# @!attribute allowed_list
|
|
316
|
-
# Optional per-assistant allowlist of integration tool names. When omitted or
|
|
317
|
-
# empty, all tools allowed by the connected integration are available to the
|
|
318
|
-
# assistant.
|
|
319
|
-
#
|
|
320
|
-
# @return [Array<String>, nil]
|
|
321
|
-
optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
|
|
322
|
-
|
|
323
|
-
# @!method initialize(integration_id:, allowed_list: nil)
|
|
324
|
-
# Some parameter documentations has been truncated, see
|
|
325
|
-
# {Telnyx::Models::AI::InferenceEmbedding::Integration} for more details.
|
|
326
|
-
#
|
|
327
|
-
# Reference to a connected integration attached to an assistant. Discover
|
|
328
|
-
# available integrations with `/ai/integrations` and connected integrations with
|
|
329
|
-
# `/ai/integrations/connections`.
|
|
330
|
-
#
|
|
331
|
-
# @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
|
|
332
|
-
#
|
|
333
|
-
# @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
|
|
334
|
-
end
|
|
335
|
-
|
|
336
|
-
# @see Telnyx::Models::AI::InferenceEmbedding#interruption_settings
|
|
337
|
-
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
338
|
-
# @!attribute disable_greeting_interruption
|
|
339
|
-
# When true, disables user interruptions while the assistant greeting is playing.
|
|
340
|
-
#
|
|
341
|
-
# @return [Boolean, nil]
|
|
342
|
-
optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
|
|
343
|
-
|
|
344
|
-
# @!attribute enable
|
|
345
|
-
# Whether users can interrupt the assistant while it is speaking.
|
|
346
|
-
#
|
|
347
|
-
# @return [Boolean, nil]
|
|
348
|
-
optional :enable, Telnyx::Internal::Type::Boolean
|
|
349
|
-
|
|
350
|
-
# @!attribute start_speaking_plan
|
|
351
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
352
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
353
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
354
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
355
|
-
#
|
|
356
|
-
# @return [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan, nil]
|
|
357
|
-
optional :start_speaking_plan,
|
|
358
|
-
-> { Telnyx::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan }
|
|
359
|
-
|
|
360
|
-
# @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
|
|
361
|
-
# Some parameter documentations has been truncated, see
|
|
362
|
-
# {Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings} for more details.
|
|
363
|
-
#
|
|
364
|
-
# Settings for interruptions and how the assistant decides the user has finished
|
|
365
|
-
# speaking. These timings are most relevant when using non turn-taking
|
|
366
|
-
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
367
|
-
# behavior is controlled by the transcription end-of-turn settings under
|
|
368
|
-
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
369
|
-
# `eager_eot_threshold`).
|
|
370
|
-
#
|
|
371
|
-
# @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
|
|
372
|
-
#
|
|
373
|
-
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
374
|
-
#
|
|
375
|
-
# @param start_speaking_plan [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
376
|
-
|
|
377
|
-
# @see Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings#start_speaking_plan
|
|
378
|
-
class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
|
|
379
|
-
# @!attribute transcription_endpointing_plan
|
|
380
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
381
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
382
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
383
|
-
# `eager_eot_threshold`.
|
|
384
|
-
#
|
|
385
|
-
# @return [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
|
|
386
|
-
optional :transcription_endpointing_plan,
|
|
387
|
-
-> { Telnyx::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
|
|
388
|
-
|
|
389
|
-
# @!attribute wait_seconds
|
|
390
|
-
# Minimum seconds to wait before the assistant starts speaking.
|
|
391
|
-
#
|
|
392
|
-
# @return [Float, nil]
|
|
393
|
-
optional :wait_seconds, Float
|
|
394
|
-
|
|
395
|
-
# @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
|
|
396
|
-
# Some parameter documentations has been truncated, see
|
|
397
|
-
# {Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan}
|
|
398
|
-
# for more details.
|
|
399
|
-
#
|
|
400
|
-
# Controls when the assistant starts speaking after the user stops. These
|
|
401
|
-
# thresholds primarily apply to non turn-taking transcription models. For
|
|
402
|
-
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
403
|
-
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
404
|
-
#
|
|
405
|
-
# @param transcription_endpointing_plan [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
|
|
406
|
-
#
|
|
407
|
-
# @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
|
|
408
|
-
|
|
409
|
-
# @see Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
|
|
410
|
-
class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
|
|
411
|
-
# @!attribute on_no_punctuation_seconds
|
|
412
|
-
# Seconds to wait after the transcript ends without punctuation.
|
|
413
|
-
#
|
|
414
|
-
# @return [Float, nil]
|
|
415
|
-
optional :on_no_punctuation_seconds, Float
|
|
416
|
-
|
|
417
|
-
# @!attribute on_number_seconds
|
|
418
|
-
# Seconds to wait after the transcript ends with a number.
|
|
419
|
-
#
|
|
420
|
-
# @return [Float, nil]
|
|
421
|
-
optional :on_number_seconds, Float
|
|
422
|
-
|
|
423
|
-
# @!attribute on_punctuation_seconds
|
|
424
|
-
# Seconds to wait after the transcript ends with punctuation.
|
|
425
|
-
#
|
|
426
|
-
# @return [Float, nil]
|
|
427
|
-
optional :on_punctuation_seconds, Float
|
|
428
|
-
|
|
429
|
-
# @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
|
|
430
|
-
# Endpointing thresholds used to decide when the user has finished speaking.
|
|
431
|
-
# Applies to non turn-taking transcription models. For `deepgram/flux`, use
|
|
432
|
-
# `transcription.settings.eot_threshold` / `eot_timeout_ms` /
|
|
433
|
-
# `eager_eot_threshold`.
|
|
434
|
-
#
|
|
435
|
-
# @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
|
|
436
|
-
#
|
|
437
|
-
# @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
|
|
438
|
-
#
|
|
439
|
-
# @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
|
|
440
|
-
end
|
|
441
|
-
end
|
|
442
|
-
end
|
|
443
|
-
|
|
444
|
-
class McpServer < Telnyx::Internal::Type::BaseModel
|
|
445
|
-
# @!attribute id
|
|
446
|
-
# ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
447
|
-
# by the `/ai/mcp_servers` endpoints.
|
|
448
|
-
#
|
|
449
|
-
# @return [String]
|
|
450
|
-
required :id, String
|
|
451
|
-
|
|
452
|
-
# @!attribute allowed_tools
|
|
453
|
-
# Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
454
|
-
# uses the MCP server's configured `allowed_tools`.
|
|
455
|
-
#
|
|
456
|
-
# @return [Array<String>, nil]
|
|
457
|
-
optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
|
|
458
|
-
|
|
459
|
-
# @!method initialize(id:, allowed_tools: nil)
|
|
460
|
-
# Some parameter documentations has been truncated, see
|
|
461
|
-
# {Telnyx::Models::AI::InferenceEmbedding::McpServer} for more details.
|
|
462
|
-
#
|
|
463
|
-
# Reference to an MCP server attached to an assistant. Create and manage MCP
|
|
464
|
-
# servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
|
|
465
|
-
# ID.
|
|
466
|
-
#
|
|
467
|
-
# @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
|
|
468
|
-
#
|
|
469
|
-
# @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
|
|
470
|
-
end
|
|
471
303
|
end
|
|
472
304
|
end
|
|
473
305
|
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
class InferenceEmbeddingInterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute disable_greeting_interruption
|
|
8
|
+
# When true, disables user interruptions while the assistant greeting is playing.
|
|
9
|
+
#
|
|
10
|
+
# @return [Boolean, nil]
|
|
11
|
+
optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
|
|
12
|
+
|
|
13
|
+
# @!attribute enable
|
|
14
|
+
# Whether users can interrupt the assistant while it is speaking.
|
|
15
|
+
#
|
|
16
|
+
# @return [Boolean, nil]
|
|
17
|
+
optional :enable, Telnyx::Internal::Type::Boolean
|
|
18
|
+
|
|
19
|
+
# @!attribute start_speaking_plan
|
|
20
|
+
# Controls when the assistant starts speaking after the user stops. These
|
|
21
|
+
# thresholds primarily apply to non turn-taking transcription models. For
|
|
22
|
+
# turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
|
|
23
|
+
# transcription end-of-turn settings under `transcription.settings` instead.
|
|
24
|
+
#
|
|
25
|
+
# @return [Telnyx::Models::AI::StartSpeakingPlan, nil]
|
|
26
|
+
optional :start_speaking_plan, -> { Telnyx::AI::StartSpeakingPlan }
|
|
27
|
+
|
|
28
|
+
# @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
|
|
29
|
+
# Some parameter documentations has been truncated, see
|
|
30
|
+
# {Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings} for more details.
|
|
31
|
+
#
|
|
32
|
+
# Settings for interruptions and how the assistant decides the user has finished
|
|
33
|
+
# speaking. These timings are most relevant when using non turn-taking
|
|
34
|
+
# transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
|
|
35
|
+
# behavior is controlled by the transcription end-of-turn settings under
|
|
36
|
+
# `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
|
|
37
|
+
# `eager_eot_threshold`).
|
|
38
|
+
#
|
|
39
|
+
# @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
|
|
40
|
+
#
|
|
41
|
+
# @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
|
|
42
|
+
#
|
|
43
|
+
# @param start_speaking_plan [Telnyx::Models::AI::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -20,8 +20,8 @@ module Telnyx
|
|
|
20
20
|
# @!attribute input
|
|
21
21
|
# The input items for this turn, using the OpenAI Responses API input format.
|
|
22
22
|
#
|
|
23
|
-
# @return [Object, nil]
|
|
24
|
-
optional :input, Telnyx::Internal::Type::Unknown
|
|
23
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
24
|
+
optional :input, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
25
25
|
|
|
26
26
|
# @!attribute instructions
|
|
27
27
|
# Optional system/developer instructions for the model. When used with a persisted
|
|
@@ -51,7 +51,7 @@ module Telnyx
|
|
|
51
51
|
#
|
|
52
52
|
# @param conversation [String] Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided, Te
|
|
53
53
|
#
|
|
54
|
-
# @param input [Object] The input items for this turn, using the OpenAI Responses API input format.
|
|
54
|
+
# @param input [Hash{Symbol=>Object}] The input items for this turn, using the OpenAI Responses API input format.
|
|
55
55
|
#
|
|
56
56
|
# @param instructions [String] Optional system/developer instructions for the model. When used with a persisted
|
|
57
57
|
#
|