telnyx 5.0.0 → 5.1.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 +38 -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 +187 -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 +187 -6
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +189 -6
- 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 +187 -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/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/fax_create_params.rb +10 -1
- 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 +132 -0
- data/lib/telnyx/models/organizations/user_list_params.rb +73 -0
- data/lib/telnyx/models/organizations/user_list_response.rb +118 -0
- data/lib/telnyx/models/organizations/user_retrieve_params.rb +29 -0
- data/lib/telnyx/models/organizations/user_retrieve_response.rb +129 -0
- data/lib/telnyx/models/organizations/users/action_remove_params.rb +18 -0
- data/lib/telnyx/models/organizations/users/action_remove_response.rb +133 -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 +2 -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/faxes.rb +3 -1
- 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 +15 -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 +449 -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 +449 -14
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +454 -17
- 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 +447 -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/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/fax_create_params.rbi +13 -0
- 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 +253 -0
- data/rbi/telnyx/models/organizations/user_list_params.rbi +152 -0
- data/rbi/telnyx/models/organizations/user_list_response.rbi +231 -0
- data/rbi/telnyx/models/organizations/user_retrieve_params.rbi +55 -0
- data/rbi/telnyx/models/organizations/user_retrieve_response.rbi +275 -0
- data/rbi/telnyx/models/organizations/users/action_remove_params.rbi +34 -0
- data/rbi/telnyx/models/organizations/users/action_remove_response.rbi +282 -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 +2 -6
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +2 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +26 -19
- data/rbi/telnyx/resources/ai/assistants.rbi +32 -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/faxes.rbi +4 -0
- 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 +176 -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 +176 -1
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +178 -3
- data/sig/telnyx/models/ai/chat_create_completion_params.rbs +4 -7
- data/sig/telnyx/models/ai/inference_embedding.rbs +178 -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/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/fax_create_params.rbs +7 -0
- 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 +104 -0
- data/sig/telnyx/models/organizations/user_list_params.rbs +72 -0
- data/sig/telnyx/models/organizations/user_list_response.rbs +99 -0
- data/sig/telnyx/models/organizations/user_retrieve_params.rbs +27 -0
- data/sig/telnyx/models/organizations/user_retrieve_response.rbs +118 -0
- data/sig/telnyx/models/organizations/users/action_remove_params.rbs +19 -0
- data/sig/telnyx/models/organizations/users/action_remove_response.rbs +122 -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 +2 -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/faxes.rbs +1 -0
- 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 +47 -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
|
@@ -33,7 +33,10 @@ module Telnyx
|
|
|
33
33
|
# @!attribute greeting
|
|
34
34
|
# Text that the assistant will use to start the conversation. This may be
|
|
35
35
|
# templated with
|
|
36
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
36
|
+
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
|
|
37
|
+
# Use an empty string to have the assistant wait for the user to speak first. Use
|
|
38
|
+
# the special value `<assistant-speaks-first-with-model-generated-message>` to
|
|
39
|
+
# have the assistant generate the greeting based on the system instructions.
|
|
37
40
|
#
|
|
38
41
|
# @return [String, nil]
|
|
39
42
|
optional :greeting, String
|
|
@@ -53,7 +56,7 @@ module Telnyx
|
|
|
53
56
|
# @!attribute llm_api_key_ref
|
|
54
57
|
# This is only needed when using third-party inference providers. The `identifier`
|
|
55
58
|
# for an integration secret
|
|
56
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api
|
|
59
|
+
# [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
57
60
|
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
58
61
|
# work with this integration.
|
|
59
62
|
#
|
|
@@ -67,7 +70,7 @@ module Telnyx
|
|
|
67
70
|
|
|
68
71
|
# @!attribute model
|
|
69
72
|
# ID of the model to use. You can use the
|
|
70
|
-
# [Get models API](https://developers.telnyx.com/api/
|
|
73
|
+
# [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
|
|
71
74
|
# to see all of your available models,
|
|
72
75
|
#
|
|
73
76
|
# @return [String, nil]
|
|
@@ -92,7 +95,7 @@ module Telnyx
|
|
|
92
95
|
# The tools that the assistant can use. These may be templated with
|
|
93
96
|
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
94
97
|
#
|
|
95
|
-
# @return [Array<Telnyx::Models::AI::
|
|
98
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>, nil]
|
|
96
99
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
97
100
|
|
|
98
101
|
# @!attribute transcription
|
|
@@ -105,7 +108,13 @@ module Telnyx
|
|
|
105
108
|
# @return [Telnyx::Models::AI::VoiceSettings, nil]
|
|
106
109
|
optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
|
|
107
110
|
|
|
108
|
-
# @!
|
|
111
|
+
# @!attribute widget_settings
|
|
112
|
+
# Configuration settings for the assistant's web widget.
|
|
113
|
+
#
|
|
114
|
+
# @return [Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings, nil]
|
|
115
|
+
optional :widget_settings, -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings }
|
|
116
|
+
|
|
117
|
+
# @!method initialize(description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
|
|
109
118
|
# Some parameter documentations has been truncated, see
|
|
110
119
|
# {Telnyx::Models::AI::Assistants::UpdateAssistant} for more details.
|
|
111
120
|
#
|
|
@@ -135,11 +144,185 @@ module Telnyx
|
|
|
135
144
|
#
|
|
136
145
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
137
146
|
#
|
|
138
|
-
# @param tools [Array<Telnyx::Models::AI::
|
|
147
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
139
148
|
#
|
|
140
149
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
141
150
|
#
|
|
142
151
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
152
|
+
#
|
|
153
|
+
# @param widget_settings [Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
154
|
+
|
|
155
|
+
# @see Telnyx::Models::AI::Assistants::UpdateAssistant#widget_settings
|
|
156
|
+
class WidgetSettings < Telnyx::Internal::Type::BaseModel
|
|
157
|
+
# @!attribute agent_thinking_text
|
|
158
|
+
# Text displayed while the agent is processing.
|
|
159
|
+
#
|
|
160
|
+
# @return [String, nil]
|
|
161
|
+
optional :agent_thinking_text, String
|
|
162
|
+
|
|
163
|
+
# @!attribute audio_visualizer_config
|
|
164
|
+
#
|
|
165
|
+
# @return [Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig, nil]
|
|
166
|
+
optional :audio_visualizer_config,
|
|
167
|
+
-> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig }
|
|
168
|
+
|
|
169
|
+
# @!attribute default_state
|
|
170
|
+
# The default state of the widget.
|
|
171
|
+
#
|
|
172
|
+
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::DefaultState, nil]
|
|
173
|
+
optional :default_state,
|
|
174
|
+
enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::DefaultState }
|
|
175
|
+
|
|
176
|
+
# @!attribute give_feedback_url
|
|
177
|
+
# URL for users to give feedback.
|
|
178
|
+
#
|
|
179
|
+
# @return [String, nil]
|
|
180
|
+
optional :give_feedback_url, String, nil?: true
|
|
181
|
+
|
|
182
|
+
# @!attribute logo_icon_url
|
|
183
|
+
# URL to a custom logo icon for the widget.
|
|
184
|
+
#
|
|
185
|
+
# @return [String, nil]
|
|
186
|
+
optional :logo_icon_url, String, nil?: true
|
|
187
|
+
|
|
188
|
+
# @!attribute position
|
|
189
|
+
# The positioning style for the widget.
|
|
190
|
+
#
|
|
191
|
+
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Position, nil]
|
|
192
|
+
optional :position, enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::Position }
|
|
193
|
+
|
|
194
|
+
# @!attribute report_issue_url
|
|
195
|
+
# URL for users to report issues.
|
|
196
|
+
#
|
|
197
|
+
# @return [String, nil]
|
|
198
|
+
optional :report_issue_url, String, nil?: true
|
|
199
|
+
|
|
200
|
+
# @!attribute speak_to_interrupt_text
|
|
201
|
+
# Text prompting users to speak to interrupt.
|
|
202
|
+
#
|
|
203
|
+
# @return [String, nil]
|
|
204
|
+
optional :speak_to_interrupt_text, String
|
|
205
|
+
|
|
206
|
+
# @!attribute start_call_text
|
|
207
|
+
# Custom text displayed on the start call button.
|
|
208
|
+
#
|
|
209
|
+
# @return [String, nil]
|
|
210
|
+
optional :start_call_text, String
|
|
211
|
+
|
|
212
|
+
# @!attribute theme
|
|
213
|
+
# The visual theme for the widget.
|
|
214
|
+
#
|
|
215
|
+
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Theme, nil]
|
|
216
|
+
optional :theme, enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::Theme }
|
|
217
|
+
|
|
218
|
+
# @!attribute view_history_url
|
|
219
|
+
# URL to view conversation history.
|
|
220
|
+
#
|
|
221
|
+
# @return [String, nil]
|
|
222
|
+
optional :view_history_url, String, nil?: true
|
|
223
|
+
|
|
224
|
+
# @!method initialize(agent_thinking_text: nil, audio_visualizer_config: nil, default_state: nil, give_feedback_url: nil, logo_icon_url: nil, position: nil, report_issue_url: nil, speak_to_interrupt_text: nil, start_call_text: nil, theme: nil, view_history_url: nil)
|
|
225
|
+
# Configuration settings for the assistant's web widget.
|
|
226
|
+
#
|
|
227
|
+
# @param agent_thinking_text [String] Text displayed while the agent is processing.
|
|
228
|
+
#
|
|
229
|
+
# @param audio_visualizer_config [Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig]
|
|
230
|
+
#
|
|
231
|
+
# @param default_state [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::DefaultState] The default state of the widget.
|
|
232
|
+
#
|
|
233
|
+
# @param give_feedback_url [String, nil] URL for users to give feedback.
|
|
234
|
+
#
|
|
235
|
+
# @param logo_icon_url [String, nil] URL to a custom logo icon for the widget.
|
|
236
|
+
#
|
|
237
|
+
# @param position [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Position] The positioning style for the widget.
|
|
238
|
+
#
|
|
239
|
+
# @param report_issue_url [String, nil] URL for users to report issues.
|
|
240
|
+
#
|
|
241
|
+
# @param speak_to_interrupt_text [String] Text prompting users to speak to interrupt.
|
|
242
|
+
#
|
|
243
|
+
# @param start_call_text [String] Custom text displayed on the start call button.
|
|
244
|
+
#
|
|
245
|
+
# @param theme [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::Theme] The visual theme for the widget.
|
|
246
|
+
#
|
|
247
|
+
# @param view_history_url [String, nil] URL to view conversation history.
|
|
248
|
+
|
|
249
|
+
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#audio_visualizer_config
|
|
250
|
+
class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
|
|
251
|
+
# @!attribute color
|
|
252
|
+
# The color theme for the audio visualizer.
|
|
253
|
+
#
|
|
254
|
+
# @return [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig::Color, nil]
|
|
255
|
+
optional :color,
|
|
256
|
+
enum: -> { Telnyx::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig::Color }
|
|
257
|
+
|
|
258
|
+
# @!attribute preset
|
|
259
|
+
# The preset style for the audio visualizer.
|
|
260
|
+
#
|
|
261
|
+
# @return [String, nil]
|
|
262
|
+
optional :preset, String
|
|
263
|
+
|
|
264
|
+
# @!method initialize(color: nil, preset: nil)
|
|
265
|
+
# @param color [Symbol, Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig::Color] The color theme for the audio visualizer.
|
|
266
|
+
#
|
|
267
|
+
# @param preset [String] The preset style for the audio visualizer.
|
|
268
|
+
|
|
269
|
+
# The color theme for the audio visualizer.
|
|
270
|
+
#
|
|
271
|
+
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings::AudioVisualizerConfig#color
|
|
272
|
+
module Color
|
|
273
|
+
extend Telnyx::Internal::Type::Enum
|
|
274
|
+
|
|
275
|
+
VERDANT = :verdant
|
|
276
|
+
TWILIGHT = :twilight
|
|
277
|
+
BLOOM = :bloom
|
|
278
|
+
MYSTIC = :mystic
|
|
279
|
+
FLARE = :flare
|
|
280
|
+
GLACIER = :glacier
|
|
281
|
+
|
|
282
|
+
# @!method self.values
|
|
283
|
+
# @return [Array<Symbol>]
|
|
284
|
+
end
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
# The default state of the widget.
|
|
288
|
+
#
|
|
289
|
+
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#default_state
|
|
290
|
+
module DefaultState
|
|
291
|
+
extend Telnyx::Internal::Type::Enum
|
|
292
|
+
|
|
293
|
+
EXPANDED = :expanded
|
|
294
|
+
COLLAPSED = :collapsed
|
|
295
|
+
|
|
296
|
+
# @!method self.values
|
|
297
|
+
# @return [Array<Symbol>]
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# The positioning style for the widget.
|
|
301
|
+
#
|
|
302
|
+
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#position
|
|
303
|
+
module Position
|
|
304
|
+
extend Telnyx::Internal::Type::Enum
|
|
305
|
+
|
|
306
|
+
FIXED = :fixed
|
|
307
|
+
STATIC = :static
|
|
308
|
+
|
|
309
|
+
# @!method self.values
|
|
310
|
+
# @return [Array<Symbol>]
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# The visual theme for the widget.
|
|
314
|
+
#
|
|
315
|
+
# @see Telnyx::Models::AI::Assistants::UpdateAssistant::WidgetSettings#theme
|
|
316
|
+
module Theme
|
|
317
|
+
extend Telnyx::Internal::Type::Enum
|
|
318
|
+
|
|
319
|
+
LIGHT = :light
|
|
320
|
+
DARK = :dark
|
|
321
|
+
|
|
322
|
+
# @!method self.values
|
|
323
|
+
# @return [Array<Symbol>]
|
|
324
|
+
end
|
|
325
|
+
end
|
|
143
326
|
end
|
|
144
327
|
end
|
|
145
328
|
|
|
@@ -5,6 +5,9 @@ module Telnyx
|
|
|
5
5
|
module AI
|
|
6
6
|
class BucketIDs < Telnyx::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute bucket_ids
|
|
8
|
+
# List of
|
|
9
|
+
# [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
|
|
10
|
+
# to use for retrieval-augmented generation.
|
|
8
11
|
#
|
|
9
12
|
# @return [Array<String>]
|
|
10
13
|
required :bucket_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
@@ -16,7 +19,10 @@ module Telnyx
|
|
|
16
19
|
optional :max_num_results, Integer
|
|
17
20
|
|
|
18
21
|
# @!method initialize(bucket_ids:, max_num_results: nil)
|
|
19
|
-
#
|
|
22
|
+
# Some parameter documentations has been truncated, see
|
|
23
|
+
# {Telnyx::Models::AI::BucketIDs} for more details.
|
|
24
|
+
#
|
|
25
|
+
# @param bucket_ids [Array<String>] List of [embedded storage buckets](https://developers.telnyx.com/api-reference/e
|
|
20
26
|
#
|
|
21
27
|
# @param max_num_results [Integer] The maximum number of results to retrieve as context for the language model.
|
|
22
28
|
end
|
|
@@ -140,7 +140,7 @@ module Telnyx
|
|
|
140
140
|
# The `function` tool type follows the same schema as the
|
|
141
141
|
# [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat).
|
|
142
142
|
# The `retrieval` tool type is unique to Telnyx. You may pass a list of
|
|
143
|
-
# [embedded storage buckets](https://developers.telnyx.com/api/
|
|
143
|
+
# [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
|
|
144
144
|
# for retrieval-augmented generation.
|
|
145
145
|
#
|
|
146
146
|
# @return [Array<Telnyx::Models::AI::ChatCreateCompletionParams::Tool::Function, Telnyx::Models::AI::ChatCreateCompletionParams::Tool::Retrieval>, nil]
|
|
@@ -389,8 +389,8 @@ module Telnyx
|
|
|
389
389
|
class Retrieval < Telnyx::Internal::Type::BaseModel
|
|
390
390
|
# @!attribute retrieval
|
|
391
391
|
#
|
|
392
|
-
# @return [Telnyx::Models::AI::
|
|
393
|
-
required :retrieval, -> { Telnyx::AI::
|
|
392
|
+
# @return [Telnyx::Models::AI::BucketIDs]
|
|
393
|
+
required :retrieval, -> { Telnyx::AI::BucketIDs }
|
|
394
394
|
|
|
395
395
|
# @!attribute type
|
|
396
396
|
#
|
|
@@ -398,7 +398,7 @@ module Telnyx
|
|
|
398
398
|
required :type, const: :retrieval
|
|
399
399
|
|
|
400
400
|
# @!method initialize(retrieval:, type: :retrieval)
|
|
401
|
-
# @param retrieval [Telnyx::Models::AI::
|
|
401
|
+
# @param retrieval [Telnyx::Models::AI::BucketIDs]
|
|
402
402
|
# @param type [Symbol, :retrieval]
|
|
403
403
|
end
|
|
404
404
|
|
|
@@ -24,7 +24,7 @@ module Telnyx
|
|
|
24
24
|
|
|
25
25
|
# @!attribute model
|
|
26
26
|
# ID of the model to use. You can use the
|
|
27
|
-
# [Get models API](https://developers.telnyx.com/api/
|
|
27
|
+
# [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
|
|
28
28
|
# to see all of your available models,
|
|
29
29
|
#
|
|
30
30
|
# @return [String]
|
|
@@ -63,7 +63,10 @@ module Telnyx
|
|
|
63
63
|
# @!attribute greeting
|
|
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
|
#
|
|
68
71
|
# @return [String, nil]
|
|
69
72
|
optional :greeting, String
|
|
@@ -81,7 +84,7 @@ module Telnyx
|
|
|
81
84
|
# @!attribute llm_api_key_ref
|
|
82
85
|
# This is only needed when using third-party inference providers. The `identifier`
|
|
83
86
|
# for an integration secret
|
|
84
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api
|
|
87
|
+
# [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
85
88
|
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
86
89
|
# work with this integration.
|
|
87
90
|
#
|
|
@@ -107,7 +110,7 @@ module Telnyx
|
|
|
107
110
|
# The tools that the assistant can use. These may be templated with
|
|
108
111
|
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
109
112
|
#
|
|
110
|
-
# @return [Array<Telnyx::Models::AI::
|
|
113
|
+
# @return [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>, nil]
|
|
111
114
|
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
112
115
|
|
|
113
116
|
# @!attribute transcription
|
|
@@ -120,7 +123,13 @@ module Telnyx
|
|
|
120
123
|
# @return [Telnyx::Models::AI::VoiceSettings, nil]
|
|
121
124
|
optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
|
|
122
125
|
|
|
123
|
-
# @!
|
|
126
|
+
# @!attribute widget_settings
|
|
127
|
+
# Configuration settings for the assistant's web widget.
|
|
128
|
+
#
|
|
129
|
+
# @return [Telnyx::Models::AI::InferenceEmbedding::WidgetSettings, nil]
|
|
130
|
+
optional :widget_settings, -> { Telnyx::AI::InferenceEmbedding::WidgetSettings }
|
|
131
|
+
|
|
132
|
+
# @!method initialize(id:, created_at:, instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, import_metadata: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
|
|
124
133
|
# Some parameter documentations has been truncated, see
|
|
125
134
|
# {Telnyx::Models::AI::InferenceEmbedding} for more details.
|
|
126
135
|
#
|
|
@@ -156,11 +165,183 @@ module Telnyx
|
|
|
156
165
|
#
|
|
157
166
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
158
167
|
#
|
|
159
|
-
# @param tools [Array<Telnyx::Models::AI::
|
|
168
|
+
# @param tools [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
160
169
|
#
|
|
161
170
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
162
171
|
#
|
|
163
172
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
173
|
+
#
|
|
174
|
+
# @param widget_settings [Telnyx::Models::AI::InferenceEmbedding::WidgetSettings] Configuration settings for the assistant's web widget.
|
|
175
|
+
|
|
176
|
+
# @see Telnyx::Models::AI::InferenceEmbedding#widget_settings
|
|
177
|
+
class WidgetSettings < Telnyx::Internal::Type::BaseModel
|
|
178
|
+
# @!attribute agent_thinking_text
|
|
179
|
+
# Text displayed while the agent is processing.
|
|
180
|
+
#
|
|
181
|
+
# @return [String, nil]
|
|
182
|
+
optional :agent_thinking_text, String
|
|
183
|
+
|
|
184
|
+
# @!attribute audio_visualizer_config
|
|
185
|
+
#
|
|
186
|
+
# @return [Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::AudioVisualizerConfig, nil]
|
|
187
|
+
optional :audio_visualizer_config,
|
|
188
|
+
-> { Telnyx::AI::InferenceEmbedding::WidgetSettings::AudioVisualizerConfig }
|
|
189
|
+
|
|
190
|
+
# @!attribute default_state
|
|
191
|
+
# The default state of the widget.
|
|
192
|
+
#
|
|
193
|
+
# @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::DefaultState, nil]
|
|
194
|
+
optional :default_state, enum: -> { Telnyx::AI::InferenceEmbedding::WidgetSettings::DefaultState }
|
|
195
|
+
|
|
196
|
+
# @!attribute give_feedback_url
|
|
197
|
+
# URL for users to give feedback.
|
|
198
|
+
#
|
|
199
|
+
# @return [String, nil]
|
|
200
|
+
optional :give_feedback_url, String, nil?: true
|
|
201
|
+
|
|
202
|
+
# @!attribute logo_icon_url
|
|
203
|
+
# URL to a custom logo icon for the widget.
|
|
204
|
+
#
|
|
205
|
+
# @return [String, nil]
|
|
206
|
+
optional :logo_icon_url, String, nil?: true
|
|
207
|
+
|
|
208
|
+
# @!attribute position
|
|
209
|
+
# The positioning style for the widget.
|
|
210
|
+
#
|
|
211
|
+
# @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::Position, nil]
|
|
212
|
+
optional :position, enum: -> { Telnyx::AI::InferenceEmbedding::WidgetSettings::Position }
|
|
213
|
+
|
|
214
|
+
# @!attribute report_issue_url
|
|
215
|
+
# URL for users to report issues.
|
|
216
|
+
#
|
|
217
|
+
# @return [String, nil]
|
|
218
|
+
optional :report_issue_url, String, nil?: true
|
|
219
|
+
|
|
220
|
+
# @!attribute speak_to_interrupt_text
|
|
221
|
+
# Text prompting users to speak to interrupt.
|
|
222
|
+
#
|
|
223
|
+
# @return [String, nil]
|
|
224
|
+
optional :speak_to_interrupt_text, String
|
|
225
|
+
|
|
226
|
+
# @!attribute start_call_text
|
|
227
|
+
# Custom text displayed on the start call button.
|
|
228
|
+
#
|
|
229
|
+
# @return [String, nil]
|
|
230
|
+
optional :start_call_text, String
|
|
231
|
+
|
|
232
|
+
# @!attribute theme
|
|
233
|
+
# The visual theme for the widget.
|
|
234
|
+
#
|
|
235
|
+
# @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::Theme, nil]
|
|
236
|
+
optional :theme, enum: -> { Telnyx::AI::InferenceEmbedding::WidgetSettings::Theme }
|
|
237
|
+
|
|
238
|
+
# @!attribute view_history_url
|
|
239
|
+
# URL to view conversation history.
|
|
240
|
+
#
|
|
241
|
+
# @return [String, nil]
|
|
242
|
+
optional :view_history_url, String, nil?: true
|
|
243
|
+
|
|
244
|
+
# @!method initialize(agent_thinking_text: nil, audio_visualizer_config: nil, default_state: nil, give_feedback_url: nil, logo_icon_url: nil, position: nil, report_issue_url: nil, speak_to_interrupt_text: nil, start_call_text: nil, theme: nil, view_history_url: nil)
|
|
245
|
+
# Configuration settings for the assistant's web widget.
|
|
246
|
+
#
|
|
247
|
+
# @param agent_thinking_text [String] Text displayed while the agent is processing.
|
|
248
|
+
#
|
|
249
|
+
# @param audio_visualizer_config [Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::AudioVisualizerConfig]
|
|
250
|
+
#
|
|
251
|
+
# @param default_state [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::DefaultState] The default state of the widget.
|
|
252
|
+
#
|
|
253
|
+
# @param give_feedback_url [String, nil] URL for users to give feedback.
|
|
254
|
+
#
|
|
255
|
+
# @param logo_icon_url [String, nil] URL to a custom logo icon for the widget.
|
|
256
|
+
#
|
|
257
|
+
# @param position [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::Position] The positioning style for the widget.
|
|
258
|
+
#
|
|
259
|
+
# @param report_issue_url [String, nil] URL for users to report issues.
|
|
260
|
+
#
|
|
261
|
+
# @param speak_to_interrupt_text [String] Text prompting users to speak to interrupt.
|
|
262
|
+
#
|
|
263
|
+
# @param start_call_text [String] Custom text displayed on the start call button.
|
|
264
|
+
#
|
|
265
|
+
# @param theme [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::Theme] The visual theme for the widget.
|
|
266
|
+
#
|
|
267
|
+
# @param view_history_url [String, nil] URL to view conversation history.
|
|
268
|
+
|
|
269
|
+
# @see Telnyx::Models::AI::InferenceEmbedding::WidgetSettings#audio_visualizer_config
|
|
270
|
+
class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
|
|
271
|
+
# @!attribute color
|
|
272
|
+
# The color theme for the audio visualizer.
|
|
273
|
+
#
|
|
274
|
+
# @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::AudioVisualizerConfig::Color, nil]
|
|
275
|
+
optional :color, enum: -> { Telnyx::AI::InferenceEmbedding::WidgetSettings::AudioVisualizerConfig::Color }
|
|
276
|
+
|
|
277
|
+
# @!attribute preset
|
|
278
|
+
# The preset style for the audio visualizer.
|
|
279
|
+
#
|
|
280
|
+
# @return [String, nil]
|
|
281
|
+
optional :preset, String
|
|
282
|
+
|
|
283
|
+
# @!method initialize(color: nil, preset: nil)
|
|
284
|
+
# @param color [Symbol, Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::AudioVisualizerConfig::Color] The color theme for the audio visualizer.
|
|
285
|
+
#
|
|
286
|
+
# @param preset [String] The preset style for the audio visualizer.
|
|
287
|
+
|
|
288
|
+
# The color theme for the audio visualizer.
|
|
289
|
+
#
|
|
290
|
+
# @see Telnyx::Models::AI::InferenceEmbedding::WidgetSettings::AudioVisualizerConfig#color
|
|
291
|
+
module Color
|
|
292
|
+
extend Telnyx::Internal::Type::Enum
|
|
293
|
+
|
|
294
|
+
VERDANT = :verdant
|
|
295
|
+
TWILIGHT = :twilight
|
|
296
|
+
BLOOM = :bloom
|
|
297
|
+
MYSTIC = :mystic
|
|
298
|
+
FLARE = :flare
|
|
299
|
+
GLACIER = :glacier
|
|
300
|
+
|
|
301
|
+
# @!method self.values
|
|
302
|
+
# @return [Array<Symbol>]
|
|
303
|
+
end
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
# The default state of the widget.
|
|
307
|
+
#
|
|
308
|
+
# @see Telnyx::Models::AI::InferenceEmbedding::WidgetSettings#default_state
|
|
309
|
+
module DefaultState
|
|
310
|
+
extend Telnyx::Internal::Type::Enum
|
|
311
|
+
|
|
312
|
+
EXPANDED = :expanded
|
|
313
|
+
COLLAPSED = :collapsed
|
|
314
|
+
|
|
315
|
+
# @!method self.values
|
|
316
|
+
# @return [Array<Symbol>]
|
|
317
|
+
end
|
|
318
|
+
|
|
319
|
+
# The positioning style for the widget.
|
|
320
|
+
#
|
|
321
|
+
# @see Telnyx::Models::AI::InferenceEmbedding::WidgetSettings#position
|
|
322
|
+
module Position
|
|
323
|
+
extend Telnyx::Internal::Type::Enum
|
|
324
|
+
|
|
325
|
+
FIXED = :fixed
|
|
326
|
+
STATIC = :static
|
|
327
|
+
|
|
328
|
+
# @!method self.values
|
|
329
|
+
# @return [Array<Symbol>]
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
# The visual theme for the widget.
|
|
333
|
+
#
|
|
334
|
+
# @see Telnyx::Models::AI::InferenceEmbedding::WidgetSettings#theme
|
|
335
|
+
module Theme
|
|
336
|
+
extend Telnyx::Internal::Type::Enum
|
|
337
|
+
|
|
338
|
+
LIGHT = :light
|
|
339
|
+
DARK = :dark
|
|
340
|
+
|
|
341
|
+
# @!method self.values
|
|
342
|
+
# @return [Array<Symbol>]
|
|
343
|
+
end
|
|
344
|
+
end
|
|
164
345
|
end
|
|
165
346
|
end
|
|
166
347
|
end
|
|
@@ -4,6 +4,13 @@ module Telnyx
|
|
|
4
4
|
module Models
|
|
5
5
|
module AI
|
|
6
6
|
class MessagingSettings < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute conversation_inactivity_minutes
|
|
8
|
+
# If more than this many minutes have passed since the last message, the assistant
|
|
9
|
+
# will start a new conversation instead of continuing the existing one.
|
|
10
|
+
#
|
|
11
|
+
# @return [Integer, nil]
|
|
12
|
+
optional :conversation_inactivity_minutes, Integer
|
|
13
|
+
|
|
7
14
|
# @!attribute default_messaging_profile_id
|
|
8
15
|
# Default Messaging Profile used for messaging exchanges with your assistant. This
|
|
9
16
|
# will be created automatically on assistant creation.
|
|
@@ -18,10 +25,12 @@ module Telnyx
|
|
|
18
25
|
# @return [String, nil]
|
|
19
26
|
optional :delivery_status_webhook_url, String
|
|
20
27
|
|
|
21
|
-
# @!method initialize(default_messaging_profile_id: nil, delivery_status_webhook_url: nil)
|
|
28
|
+
# @!method initialize(conversation_inactivity_minutes: nil, default_messaging_profile_id: nil, delivery_status_webhook_url: nil)
|
|
22
29
|
# Some parameter documentations has been truncated, see
|
|
23
30
|
# {Telnyx::Models::AI::MessagingSettings} for more details.
|
|
24
31
|
#
|
|
32
|
+
# @param conversation_inactivity_minutes [Integer] If more than this many minutes have passed since the last message, the assistant
|
|
33
|
+
#
|
|
25
34
|
# @param default_messaging_profile_id [String] Default Messaging Profile used for messaging exchanges with your assistant. This
|
|
26
35
|
#
|
|
27
36
|
# @param delivery_status_webhook_url [String] The URL where webhooks related to delivery statused for assistant messages will
|
|
@@ -6,8 +6,8 @@ module Telnyx
|
|
|
6
6
|
class RetrievalTool < Telnyx::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute retrieval
|
|
8
8
|
#
|
|
9
|
-
# @return [Telnyx::Models::AI::
|
|
10
|
-
required :retrieval, -> { Telnyx::AI::
|
|
9
|
+
# @return [Telnyx::Models::AI::BucketIDs]
|
|
10
|
+
required :retrieval, -> { Telnyx::AI::BucketIDs }
|
|
11
11
|
|
|
12
12
|
# @!attribute type
|
|
13
13
|
#
|
|
@@ -15,7 +15,7 @@ module Telnyx
|
|
|
15
15
|
required :type, enum: -> { Telnyx::AI::RetrievalTool::Type }
|
|
16
16
|
|
|
17
17
|
# @!method initialize(retrieval:, type:)
|
|
18
|
-
# @param retrieval [Telnyx::Models::AI::
|
|
18
|
+
# @param retrieval [Telnyx::Models::AI::BucketIDs]
|
|
19
19
|
# @param type [Symbol, Telnyx::Models::AI::RetrievalTool::Type]
|
|
20
20
|
|
|
21
21
|
# @see Telnyx::Models::AI::RetrievalTool#type
|