telnyx 5.0.0 → 5.2.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 +46 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +4 -0
- data/lib/telnyx/internal/type/union.rb +1 -1
- data/lib/telnyx/models/ai/assistant.rb +39 -4
- data/lib/telnyx/models/ai/assistant_create_params.rb +17 -6
- data/lib/telnyx/models/ai/assistant_imports_params.rb +10 -1
- data/lib/telnyx/models/ai/assistant_tool.rb +400 -3
- data/lib/telnyx/models/ai/assistant_update_params.rb +17 -6
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +17 -6
- data/lib/telnyx/models/ai/audio_visualizer_config.rb +43 -0
- data/lib/telnyx/models/ai/bucket_ids.rb +7 -1
- data/lib/telnyx/models/ai/chat_create_completion_params.rb +4 -4
- data/lib/telnyx/models/ai/inference_embedding.rb +17 -6
- data/lib/telnyx/models/ai/messaging_settings.rb +10 -1
- data/lib/telnyx/models/ai/retrieval_tool.rb +3 -3
- data/lib/telnyx/models/ai/telephony_settings.rb +142 -1
- data/lib/telnyx/models/ai/transfer_tool.rb +46 -3
- data/lib/telnyx/models/ai/voice_settings.rb +1 -1
- data/lib/telnyx/models/ai/webhook_tool.rb +256 -3
- data/lib/telnyx/models/ai/widget_settings.rb +138 -0
- data/lib/telnyx/models/call_control_application_list_params.rb +16 -18
- data/lib/telnyx/models/call_event_list_params.rb +16 -18
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_params.rb +289 -0
- data/lib/telnyx/models/calls/action_add_ai_assistant_messages_response.rb +18 -0
- data/lib/telnyx/models/calls/action_start_noise_suppression_params.rb +7 -4
- data/lib/telnyx/models/conference_list_params.rb +16 -18
- data/lib/telnyx/models/conference_list_participants_params.rb +16 -18
- data/lib/telnyx/models/connection_list_active_calls_params.rb +16 -18
- data/lib/telnyx/models/connection_noise_suppression_details.rb +61 -0
- data/lib/telnyx/models/credential_connection.rb +3 -61
- data/lib/telnyx/models/credential_connection_create_params.rb +3 -61
- data/lib/telnyx/models/credential_connection_update_params.rb +3 -61
- data/lib/telnyx/models/fax_create_params.rb +10 -1
- data/lib/telnyx/models/fqdn_connection.rb +3 -60
- data/lib/telnyx/models/fqdn_connection_create_params.rb +3 -60
- data/lib/telnyx/models/fqdn_connection_update_params.rb +3 -60
- data/lib/telnyx/models/ip_connection.rb +3 -60
- data/lib/telnyx/models/ip_connection_create_params.rb +3 -60
- data/lib/telnyx/models/ip_connection_update_params.rb +3 -60
- data/lib/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rb +1 -9
- data/lib/telnyx/models/messaging_profile.rb +11 -1
- data/lib/telnyx/models/messaging_profile_create_params.rb +11 -1
- data/lib/telnyx/models/messaging_profile_update_params.rb +11 -1
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +14 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +17 -1
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +17 -1
- data/lib/telnyx/models/organizations/user_get_groups_report_params.rb +32 -0
- data/lib/telnyx/models/organizations/user_get_groups_report_response.rb +110 -0
- data/lib/telnyx/models/organizations/user_group_reference.rb +28 -0
- data/lib/telnyx/models/organizations/user_list_params.rb +73 -0
- data/lib/telnyx/models/organizations/user_list_response.rb +96 -0
- data/lib/telnyx/models/organizations/user_retrieve_params.rb +29 -0
- data/lib/telnyx/models/organizations/user_retrieve_response.rb +107 -0
- data/lib/telnyx/models/organizations/users/action_remove_params.rb +18 -0
- data/lib/telnyx/models/organizations/users/action_remove_response.rb +111 -0
- data/lib/telnyx/models/private_wireless_gateway_status.rb +3 -2
- data/lib/telnyx/models/queues/call_list_params.rb +16 -18
- data/lib/telnyx/models/sim_card_list_params.rb +11 -3
- data/lib/telnyx/models/texml/accounts/queue_list_params.rb +64 -0
- data/lib/telnyx/models/texml/accounts/queue_list_response.rb +155 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models/unwrap_webhook_event.rb +1 -7
- data/lib/telnyx/models.rb +4 -6
- data/lib/telnyx/resources/ai/assistants/tools.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +18 -16
- data/lib/telnyx/resources/ai/assistants.rb +15 -9
- data/lib/telnyx/resources/ai/clusters.rb +1 -1
- data/lib/telnyx/resources/ai/embeddings.rb +1 -1
- data/lib/telnyx/resources/bundle_pricing/user_bundles.rb +1 -1
- data/lib/telnyx/resources/call_control_applications.rb +8 -4
- data/lib/telnyx/resources/call_events.rb +8 -4
- data/lib/telnyx/resources/calls/actions.rb +31 -0
- data/lib/telnyx/resources/conferences.rb +16 -8
- data/lib/telnyx/resources/connections.rb +8 -4
- data/lib/telnyx/resources/credential_connections.rb +2 -2
- data/lib/telnyx/resources/faxes.rb +3 -1
- data/lib/telnyx/resources/fqdn_connections.rb +2 -2
- data/lib/telnyx/resources/ip_connections.rb +2 -2
- data/lib/telnyx/resources/messages.rb +1 -1
- data/lib/telnyx/resources/messaging_10dlc/brand.rb +10 -14
- data/lib/telnyx/resources/messaging_profiles/autoresp_configs.rb +6 -6
- data/lib/telnyx/resources/messaging_profiles.rb +6 -2
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +6 -2
- data/lib/telnyx/resources/operator_connect/actions.rb +1 -1
- data/lib/telnyx/resources/organizations/users/actions.rb +38 -0
- data/lib/telnyx/resources/organizations/users.rb +114 -0
- data/lib/telnyx/resources/organizations.rb +18 -0
- data/lib/telnyx/resources/phone_numbers/jobs.rb +1 -1
- data/lib/telnyx/resources/queues/calls.rb +8 -4
- data/lib/telnyx/resources/sim_cards/actions.rb +6 -6
- data/lib/telnyx/resources/texml/accounts/calls/recordings.rb +1 -1
- data/lib/telnyx/resources/texml/accounts/queues.rb +41 -0
- data/lib/telnyx/resources/usage_reports.rb +2 -2
- data/lib/telnyx/resources/webhooks.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +19 -69
- data/rbi/telnyx/client.rbi +3 -0
- data/rbi/telnyx/models/ai/assistant.rbi +91 -5
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +31 -14
- data/rbi/telnyx/models/ai/assistant_imports_params.rbi +13 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +910 -2
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +31 -14
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +36 -17
- data/rbi/telnyx/models/ai/audio_visualizer_config.rbi +107 -0
- data/rbi/telnyx/models/ai/bucket_ids.rbi +6 -0
- data/rbi/telnyx/models/ai/chat_create_completion_params.rbi +6 -13
- data/rbi/telnyx/models/ai/inference_embedding.rbi +30 -13
- data/rbi/telnyx/models/ai/messaging_settings.rbi +13 -0
- data/rbi/telnyx/models/ai/retrieval_tool.rbi +4 -8
- data/rbi/telnyx/models/ai/telephony_settings.rbi +347 -3
- data/rbi/telnyx/models/ai/transfer_tool.rbi +87 -6
- data/rbi/telnyx/models/ai/voice_settings.rbi +2 -2
- data/rbi/telnyx/models/ai/webhook_tool.rbi +584 -8
- data/rbi/telnyx/models/ai/widget_settings.rbi +225 -0
- data/rbi/telnyx/models/call_control_application_list_params.rbi +23 -35
- data/rbi/telnyx/models/call_event_list_params.rbi +23 -35
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_params.rbi +583 -0
- data/rbi/telnyx/models/calls/action_add_ai_assistant_messages_response.rbi +39 -0
- data/rbi/telnyx/models/calls/action_start_noise_suppression_params.rbi +14 -6
- data/rbi/telnyx/models/conference_list_params.rbi +23 -35
- data/rbi/telnyx/models/conference_list_participants_params.rbi +23 -35
- data/rbi/telnyx/models/connection_list_active_calls_params.rbi +23 -35
- data/rbi/telnyx/models/connection_noise_suppression_details.rbi +141 -0
- data/rbi/telnyx/models/credential_connection.rbi +4 -152
- data/rbi/telnyx/models/credential_connection_create_params.rbi +4 -154
- data/rbi/telnyx/models/credential_connection_update_params.rbi +4 -154
- data/rbi/telnyx/models/fax_create_params.rbi +13 -0
- data/rbi/telnyx/models/fqdn_connection.rbi +4 -150
- data/rbi/telnyx/models/fqdn_connection_create_params.rbi +4 -152
- data/rbi/telnyx/models/fqdn_connection_update_params.rbi +4 -152
- data/rbi/telnyx/models/ip_connection.rbi +4 -148
- data/rbi/telnyx/models/ip_connection_create_params.rbi +4 -152
- data/rbi/telnyx/models/ip_connection_update_params.rbi +4 -152
- data/rbi/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbi +5 -21
- data/rbi/telnyx/models/messaging_profile.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_create_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_profile_update_params.rbi +15 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +12 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +10 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +10 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_params.rbi +93 -0
- data/rbi/telnyx/models/organizations/user_get_groups_report_response.rbi +210 -0
- data/rbi/telnyx/models/organizations/user_group_reference.rbi +39 -0
- data/rbi/telnyx/models/organizations/user_list_params.rbi +152 -0
- data/rbi/telnyx/models/organizations/user_list_response.rbi +188 -0
- data/rbi/telnyx/models/organizations/user_retrieve_params.rbi +55 -0
- data/rbi/telnyx/models/organizations/user_retrieve_response.rbi +232 -0
- data/rbi/telnyx/models/organizations/users/action_remove_params.rbi +34 -0
- data/rbi/telnyx/models/organizations/users/action_remove_response.rbi +239 -0
- data/rbi/telnyx/models/private_wireless_gateway_status.rbi +4 -2
- data/rbi/telnyx/models/queues/call_list_params.rbi +23 -35
- data/rbi/telnyx/models/sim_card_list_params.rbi +14 -3
- data/rbi/telnyx/models/texml/accounts/queue_list_params.rbi +103 -0
- data/rbi/telnyx/models/texml/accounts/queue_list_response.rbi +269 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models/unwrap_webhook_event.rbi +0 -3
- data/rbi/telnyx/models.rbi +5 -6
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +2 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +25 -19
- data/rbi/telnyx/resources/ai/assistants.rbi +30 -14
- data/rbi/telnyx/resources/ai/chat.rbi +1 -1
- data/rbi/telnyx/resources/ai/clusters.rbi +1 -1
- data/rbi/telnyx/resources/ai/embeddings.rbi +1 -1
- data/rbi/telnyx/resources/bundle_pricing/user_bundles.rbi +1 -1
- data/rbi/telnyx/resources/call_control_applications.rbi +7 -1
- data/rbi/telnyx/resources/call_events.rbi +5 -1
- data/rbi/telnyx/resources/calls/actions.rbi +37 -2
- data/rbi/telnyx/resources/conferences.rbi +10 -2
- data/rbi/telnyx/resources/connections.rbi +5 -1
- data/rbi/telnyx/resources/credential_connections.rbi +2 -2
- data/rbi/telnyx/resources/faxes.rbi +4 -0
- data/rbi/telnyx/resources/fqdn_connections.rbi +2 -2
- data/rbi/telnyx/resources/ip_connections.rbi +2 -2
- data/rbi/telnyx/resources/messages.rbi +1 -1
- data/rbi/telnyx/resources/messaging_10dlc/brand.rbi +8 -11
- data/rbi/telnyx/resources/messaging_profiles/autoresp_configs.rbi +6 -6
- data/rbi/telnyx/resources/messaging_profiles.rbi +10 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +10 -0
- data/rbi/telnyx/resources/operator_connect/actions.rbi +1 -1
- data/rbi/telnyx/resources/organizations/users/actions.rbi +32 -0
- data/rbi/telnyx/resources/organizations/users.rbi +88 -0
- data/rbi/telnyx/resources/organizations.rbi +15 -0
- data/rbi/telnyx/resources/phone_numbers/jobs.rbi +1 -1
- data/rbi/telnyx/resources/queues/calls.rbi +5 -1
- data/rbi/telnyx/resources/sim_cards/actions.rbi +6 -6
- data/rbi/telnyx/resources/sim_cards.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/calls/recordings.rbi +1 -1
- data/rbi/telnyx/resources/texml/accounts/queues.rbi +32 -0
- data/rbi/telnyx/resources/usage_reports.rbi +2 -2
- data/rbi/telnyx/resources/webhooks.rbi +0 -6
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/models/ai/assistant.rbs +44 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +10 -1
- data/sig/telnyx/models/ai/assistant_imports_params.rbs +8 -1
- data/sig/telnyx/models/ai/assistant_tool.rbs +367 -2
- data/sig/telnyx/models/ai/assistant_update_params.rbs +10 -1
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +12 -3
- data/sig/telnyx/models/ai/audio_visualizer_config.rbs +48 -0
- data/sig/telnyx/models/ai/chat_create_completion_params.rbs +4 -7
- data/sig/telnyx/models/ai/inference_embedding.rbs +12 -3
- data/sig/telnyx/models/ai/messaging_settings.rbs +7 -0
- data/sig/telnyx/models/ai/retrieval_tool.rbs +4 -4
- data/sig/telnyx/models/ai/telephony_settings.rbs +133 -4
- data/sig/telnyx/models/ai/transfer_tool.rbs +42 -4
- data/sig/telnyx/models/ai/webhook_tool.rbs +241 -4
- data/sig/telnyx/models/ai/widget_settings.rbs +127 -0
- data/sig/telnyx/models/call_control_application_list_params.rbs +17 -26
- data/sig/telnyx/models/call_event_list_params.rbs +18 -27
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_params.rbs +240 -0
- data/sig/telnyx/models/calls/action_add_ai_assistant_messages_response.rbs +20 -0
- data/sig/telnyx/models/calls/action_start_noise_suppression_params.rbs +2 -1
- data/sig/telnyx/models/conference_list_params.rbs +17 -26
- data/sig/telnyx/models/conference_list_participants_params.rbs +17 -26
- data/sig/telnyx/models/connection_list_active_calls_params.rbs +20 -27
- data/sig/telnyx/models/connection_noise_suppression_details.rbs +54 -0
- data/sig/telnyx/models/credential_connection.rbs +6 -57
- data/sig/telnyx/models/credential_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/credential_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/fax_create_params.rbs +7 -0
- data/sig/telnyx/models/fqdn_connection.rbs +6 -57
- data/sig/telnyx/models/fqdn_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/fqdn_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/ip_connection.rbs +6 -57
- data/sig/telnyx/models/ip_connection_create_params.rbs +6 -57
- data/sig/telnyx/models/ip_connection_update_params.rbs +6 -57
- data/sig/telnyx/models/messaging_10dlc/brand_retrieve_sms_otp_status_params.rbs +3 -13
- data/sig/telnyx/models/messaging_profile.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_create_params.rbs +7 -0
- data/sig/telnyx/models/messaging_profile_update_params.rbs +7 -0
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +5 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +5 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_params.rbs +43 -0
- data/sig/telnyx/models/organizations/user_get_groups_report_response.rbs +92 -0
- data/sig/telnyx/models/organizations/user_group_reference.rbs +17 -0
- data/sig/telnyx/models/organizations/user_list_params.rbs +72 -0
- data/sig/telnyx/models/organizations/user_list_response.rbs +87 -0
- data/sig/telnyx/models/organizations/user_retrieve_params.rbs +27 -0
- data/sig/telnyx/models/organizations/user_retrieve_response.rbs +106 -0
- data/sig/telnyx/models/organizations/users/action_remove_params.rbs +19 -0
- data/sig/telnyx/models/organizations/users/action_remove_response.rbs +110 -0
- data/sig/telnyx/models/queues/call_list_params.rbs +20 -27
- data/sig/telnyx/models/sim_card_list_params.rbs +7 -0
- data/sig/telnyx/models/texml/accounts/queue_list_params.rbs +60 -0
- data/sig/telnyx/models/texml/accounts/queue_list_response.rbs +152 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models/unwrap_webhook_event.rbs +0 -3
- data/sig/telnyx/models.rbs +4 -6
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +3 -0
- data/sig/telnyx/resources/call_control_applications.rbs +3 -1
- data/sig/telnyx/resources/call_events.rbs +3 -1
- data/sig/telnyx/resources/calls/actions.rbs +8 -0
- data/sig/telnyx/resources/conferences.rbs +6 -2
- data/sig/telnyx/resources/connections.rbs +3 -1
- data/sig/telnyx/resources/credential_connections.rbs +2 -2
- data/sig/telnyx/resources/faxes.rbs +1 -0
- data/sig/telnyx/resources/fqdn_connections.rbs +2 -2
- data/sig/telnyx/resources/ip_connections.rbs +2 -2
- data/sig/telnyx/resources/messaging_10dlc/brand.rbs +1 -2
- data/sig/telnyx/resources/messaging_profiles.rbs +2 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -0
- data/sig/telnyx/resources/organizations/users/actions.rbs +16 -0
- data/sig/telnyx/resources/organizations/users.rbs +31 -0
- data/sig/telnyx/resources/organizations.rbs +9 -0
- data/sig/telnyx/resources/queues/calls.rbs +3 -1
- data/sig/telnyx/resources/texml/accounts/queues.rbs +10 -0
- data/sig/telnyx/resources/webhooks.rbs +0 -6
- metadata +59 -20
- data/lib/telnyx/models/ai/inference_embedding_bucket_ids.rb +0 -31
- data/lib/telnyx/models/ai/inference_embedding_transfer_tool_params.rb +0 -93
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +0 -265
- data/lib/telnyx/models/streaming_failed_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_started_webhook_event.rb +0 -15
- data/lib/telnyx/models/streaming_stopped_webhook_event.rb +0 -15
- data/rbi/telnyx/models/ai/inference_embedding_bucket_ids.rbi +0 -54
- data/rbi/telnyx/models/ai/inference_embedding_transfer_tool_params.rbi +0 -185
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +0 -621
- data/rbi/telnyx/models/streaming_failed_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_started_webhook_event.rbi +0 -30
- data/rbi/telnyx/models/streaming_stopped_webhook_event.rbi +0 -30
- data/sig/telnyx/models/ai/inference_embedding_bucket_ids.rbs +0 -26
- data/sig/telnyx/models/ai/inference_embedding_transfer_tool_params.rbs +0 -75
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +0 -242
- data/sig/telnyx/models/streaming_failed_webhook_event.rbs +0 -15
- data/sig/telnyx/models/streaming_started_webhook_event.rbs +0 -16
- data/sig/telnyx/models/streaming_stopped_webhook_event.rbs +0 -16
|
@@ -18,7 +18,7 @@ module Telnyx
|
|
|
18
18
|
attr_accessor :instructions
|
|
19
19
|
|
|
20
20
|
# ID of the model to use. You can use the
|
|
21
|
-
# [Get models API](https://developers.telnyx.com/api/
|
|
21
|
+
# [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
|
|
22
22
|
# to see all of your available models,
|
|
23
23
|
sig { returns(String) }
|
|
24
24
|
attr_accessor :model
|
|
@@ -63,7 +63,10 @@ module Telnyx
|
|
|
63
63
|
|
|
64
64
|
# Text that the assistant will use to start the conversation. This may be
|
|
65
65
|
# templated with
|
|
66
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
66
|
+
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
|
|
67
|
+
# Use an empty string to have the assistant wait for the user to speak first. Use
|
|
68
|
+
# the special value `<assistant-speaks-first-with-model-generated-message>` to
|
|
69
|
+
# have the assistant generate the greeting based on the system instructions.
|
|
67
70
|
sig { returns(T.nilable(String)) }
|
|
68
71
|
attr_reader :greeting
|
|
69
72
|
|
|
@@ -80,7 +83,7 @@ module Telnyx
|
|
|
80
83
|
|
|
81
84
|
# This is only needed when using third-party inference providers. The `identifier`
|
|
82
85
|
# for an integration secret
|
|
83
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api
|
|
86
|
+
# [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
84
87
|
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
85
88
|
# work with this integration.
|
|
86
89
|
sig { returns(T.nilable(String)) }
|
|
@@ -120,11 +123,11 @@ module Telnyx
|
|
|
120
123
|
T.nilable(
|
|
121
124
|
T::Array[
|
|
122
125
|
T.any(
|
|
123
|
-
Telnyx::AI::
|
|
126
|
+
Telnyx::AI::AssistantTool::Webhook,
|
|
124
127
|
Telnyx::AI::RetrievalTool,
|
|
125
128
|
Telnyx::AI::AssistantTool::Handoff,
|
|
126
129
|
Telnyx::AI::HangupTool,
|
|
127
|
-
Telnyx::AI::
|
|
130
|
+
Telnyx::AI::AssistantTool::Transfer,
|
|
128
131
|
Telnyx::AI::AssistantTool::Refer,
|
|
129
132
|
Telnyx::AI::AssistantTool::SendDtmf,
|
|
130
133
|
Telnyx::AI::AssistantTool::SendMessage
|
|
@@ -140,11 +143,11 @@ module Telnyx
|
|
|
140
143
|
tools:
|
|
141
144
|
T::Array[
|
|
142
145
|
T.any(
|
|
143
|
-
Telnyx::AI::
|
|
146
|
+
Telnyx::AI::AssistantTool::Webhook::OrHash,
|
|
144
147
|
Telnyx::AI::RetrievalTool::OrHash,
|
|
145
148
|
Telnyx::AI::AssistantTool::Handoff::OrHash,
|
|
146
149
|
Telnyx::AI::HangupTool::OrHash,
|
|
147
|
-
Telnyx::AI::
|
|
150
|
+
Telnyx::AI::AssistantTool::Transfer::OrHash,
|
|
148
151
|
Telnyx::AI::AssistantTool::Refer::OrHash,
|
|
149
152
|
Telnyx::AI::AssistantTool::SendDtmf::OrHash,
|
|
150
153
|
Telnyx::AI::AssistantTool::SendMessage::OrHash
|
|
@@ -168,6 +171,13 @@ module Telnyx
|
|
|
168
171
|
sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
|
|
169
172
|
attr_writer :voice_settings
|
|
170
173
|
|
|
174
|
+
# Configuration settings for the assistant's web widget.
|
|
175
|
+
sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
|
|
176
|
+
attr_reader :widget_settings
|
|
177
|
+
|
|
178
|
+
sig { params(widget_settings: Telnyx::AI::WidgetSettings::OrHash).void }
|
|
179
|
+
attr_writer :widget_settings
|
|
180
|
+
|
|
171
181
|
sig do
|
|
172
182
|
params(
|
|
173
183
|
instructions: String,
|
|
@@ -186,11 +196,11 @@ module Telnyx
|
|
|
186
196
|
tools:
|
|
187
197
|
T::Array[
|
|
188
198
|
T.any(
|
|
189
|
-
Telnyx::AI::
|
|
199
|
+
Telnyx::AI::AssistantTool::Webhook::OrHash,
|
|
190
200
|
Telnyx::AI::RetrievalTool::OrHash,
|
|
191
201
|
Telnyx::AI::AssistantTool::Handoff::OrHash,
|
|
192
202
|
Telnyx::AI::HangupTool::OrHash,
|
|
193
|
-
Telnyx::AI::
|
|
203
|
+
Telnyx::AI::AssistantTool::Transfer::OrHash,
|
|
194
204
|
Telnyx::AI::AssistantTool::Refer::OrHash,
|
|
195
205
|
Telnyx::AI::AssistantTool::SendDtmf::OrHash,
|
|
196
206
|
Telnyx::AI::AssistantTool::SendMessage::OrHash
|
|
@@ -198,6 +208,7 @@ module Telnyx
|
|
|
198
208
|
],
|
|
199
209
|
transcription: Telnyx::AI::TranscriptionSettings::OrHash,
|
|
200
210
|
voice_settings: Telnyx::AI::VoiceSettings::OrHash,
|
|
211
|
+
widget_settings: Telnyx::AI::WidgetSettings::OrHash,
|
|
201
212
|
request_options: Telnyx::RequestOptions::OrHash
|
|
202
213
|
).returns(T.attached_class)
|
|
203
214
|
end
|
|
@@ -206,7 +217,7 @@ module Telnyx
|
|
|
206
217
|
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
207
218
|
instructions:,
|
|
208
219
|
# ID of the model to use. You can use the
|
|
209
|
-
# [Get models API](https://developers.telnyx.com/api/
|
|
220
|
+
# [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
|
|
210
221
|
# to see all of your available models,
|
|
211
222
|
model:,
|
|
212
223
|
name:,
|
|
@@ -221,12 +232,15 @@ module Telnyx
|
|
|
221
232
|
enabled_features: nil,
|
|
222
233
|
# Text that the assistant will use to start the conversation. This may be
|
|
223
234
|
# templated with
|
|
224
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
235
|
+
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
|
|
236
|
+
# Use an empty string to have the assistant wait for the user to speak first. Use
|
|
237
|
+
# the special value `<assistant-speaks-first-with-model-generated-message>` to
|
|
238
|
+
# have the assistant generate the greeting based on the system instructions.
|
|
225
239
|
greeting: nil,
|
|
226
240
|
insight_settings: nil,
|
|
227
241
|
# This is only needed when using third-party inference providers. The `identifier`
|
|
228
242
|
# for an integration secret
|
|
229
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api
|
|
243
|
+
# [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
230
244
|
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
231
245
|
# work with this integration.
|
|
232
246
|
llm_api_key_ref: nil,
|
|
@@ -238,6 +252,8 @@ module Telnyx
|
|
|
238
252
|
tools: nil,
|
|
239
253
|
transcription: nil,
|
|
240
254
|
voice_settings: nil,
|
|
255
|
+
# Configuration settings for the assistant's web widget.
|
|
256
|
+
widget_settings: nil,
|
|
241
257
|
request_options: {}
|
|
242
258
|
)
|
|
243
259
|
end
|
|
@@ -261,11 +277,11 @@ module Telnyx
|
|
|
261
277
|
tools:
|
|
262
278
|
T::Array[
|
|
263
279
|
T.any(
|
|
264
|
-
Telnyx::AI::
|
|
280
|
+
Telnyx::AI::AssistantTool::Webhook,
|
|
265
281
|
Telnyx::AI::RetrievalTool,
|
|
266
282
|
Telnyx::AI::AssistantTool::Handoff,
|
|
267
283
|
Telnyx::AI::HangupTool,
|
|
268
|
-
Telnyx::AI::
|
|
284
|
+
Telnyx::AI::AssistantTool::Transfer,
|
|
269
285
|
Telnyx::AI::AssistantTool::Refer,
|
|
270
286
|
Telnyx::AI::AssistantTool::SendDtmf,
|
|
271
287
|
Telnyx::AI::AssistantTool::SendMessage
|
|
@@ -273,6 +289,7 @@ module Telnyx
|
|
|
273
289
|
],
|
|
274
290
|
transcription: Telnyx::AI::TranscriptionSettings,
|
|
275
291
|
voice_settings: Telnyx::AI::VoiceSettings,
|
|
292
|
+
widget_settings: Telnyx::AI::WidgetSettings,
|
|
276
293
|
request_options: Telnyx::RequestOptions
|
|
277
294
|
}
|
|
278
295
|
)
|
|
@@ -22,10 +22,19 @@ module Telnyx
|
|
|
22
22
|
sig { returns(Telnyx::AI::AssistantImportsParams::Provider::OrSymbol) }
|
|
23
23
|
attr_accessor :provider
|
|
24
24
|
|
|
25
|
+
# Optional list of assistant IDs to import from the external provider. If not
|
|
26
|
+
# provided, all assistants will be imported.
|
|
27
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
28
|
+
attr_reader :import_ids
|
|
29
|
+
|
|
30
|
+
sig { params(import_ids: T::Array[String]).void }
|
|
31
|
+
attr_writer :import_ids
|
|
32
|
+
|
|
25
33
|
sig do
|
|
26
34
|
params(
|
|
27
35
|
api_key_ref: String,
|
|
28
36
|
provider: Telnyx::AI::AssistantImportsParams::Provider::OrSymbol,
|
|
37
|
+
import_ids: T::Array[String],
|
|
29
38
|
request_options: Telnyx::RequestOptions::OrHash
|
|
30
39
|
).returns(T.attached_class)
|
|
31
40
|
end
|
|
@@ -36,6 +45,9 @@ module Telnyx
|
|
|
36
45
|
api_key_ref:,
|
|
37
46
|
# The external provider to import assistants from.
|
|
38
47
|
provider:,
|
|
48
|
+
# Optional list of assistant IDs to import from the external provider. If not
|
|
49
|
+
# provided, all assistants will be imported.
|
|
50
|
+
import_ids: nil,
|
|
39
51
|
request_options: {}
|
|
40
52
|
)
|
|
41
53
|
end
|
|
@@ -45,6 +57,7 @@ module Telnyx
|
|
|
45
57
|
{
|
|
46
58
|
api_key_ref: String,
|
|
47
59
|
provider: Telnyx::AI::AssistantImportsParams::Provider::OrSymbol,
|
|
60
|
+
import_ids: T::Array[String],
|
|
48
61
|
request_options: Telnyx::RequestOptions
|
|
49
62
|
}
|
|
50
63
|
)
|