telnyx 4.3.0 → 4.4.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/client.rb +7 -0
- data/lib/telnyx/internal/transport/pooled_net_requester.rb +30 -24
- data/lib/telnyx/internal/type/union.rb +6 -6
- data/lib/telnyx/models/access_ip_address_list_response.rb +3 -32
- data/lib/telnyx/models/access_ip_range_list_response.rb +3 -32
- data/lib/telnyx/models/advanced_order.rb +93 -0
- data/lib/telnyx/models/advanced_order_create_params.rb +2 -87
- data/lib/telnyx/models/advanced_order_update_requirement_group_params.rb +2 -88
- data/lib/telnyx/models/ai/assistants_list.rb +3 -162
- data/lib/telnyx/models/ai/{assistant_create_response.rb → inference_embedding.rb} +2 -2
- data/lib/telnyx/models/call_dial_params.rb +3 -18
- data/lib/telnyx/models/calls/action_start_streaming_params.rb +3 -18
- data/lib/telnyx/models/calls/telnyx_transcription_language.rb +116 -0
- data/lib/telnyx/models/calls/transcription_engine_b_config.rb +3 -114
- data/lib/telnyx/models/calls/transcription_start_request.rb +3 -115
- data/lib/telnyx/models/document_upload_json_params.rb +50 -0
- data/lib/telnyx/models/document_upload_json_response.rb +16 -0
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rb +39 -0
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rb +3 -32
- data/lib/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rb +3 -32
- data/lib/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rb +3 -32
- data/lib/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rb +39 -0
- data/lib/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rb +3 -32
- data/lib/telnyx/models/{verify_profile_create_template_response.rb → message_template.rb} +1 -1
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +3 -19
- data/lib/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rb +23 -0
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +3 -21
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +3 -21
- data/lib/telnyx/models/oauth_client_list_response.rb +3 -39
- data/lib/telnyx/models/oauth_grant_list_response.rb +3 -39
- data/lib/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rb +33 -0
- data/lib/telnyx/models/pagination_meta_oauth.rb +40 -0
- data/lib/telnyx/models/phone_number_blocks/job.rb +3 -70
- data/lib/telnyx/models/phone_number_blocks/job_error.rb +73 -0
- data/lib/telnyx/models/phone_numbers/phone_numbers_job.rb +3 -70
- data/lib/telnyx/models/report_list_mdrs_response.rb +3 -32
- data/lib/telnyx/models/reports/mdr_usage_report_list_response.rb +3 -32
- data/lib/telnyx/models/reports/pagination_meta_reporting.rb +35 -0
- data/lib/telnyx/models/stream_bidirectional_sampling_rate.rb +19 -0
- data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +140 -0
- data/lib/telnyx/models/verifications/by_phone_number_list_response.rb +3 -32
- data/lib/telnyx/models/verifications/verify_meta.rb +35 -0
- data/lib/telnyx/models/verify_profile_list_response.rb +3 -32
- data/lib/telnyx/models/webhook_unsafe_unwrap_params.rb +14 -0
- data/lib/telnyx/models.rb +16 -0
- data/lib/telnyx/resources/advanced_orders.rb +4 -4
- data/lib/telnyx/resources/ai/assistants/versions.rb +6 -6
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/resources/calls.rb +1 -1
- data/lib/telnyx/resources/documents.rb +33 -1
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +2 -2
- data/lib/telnyx/resources/verify_profiles.rb +4 -4
- data/lib/telnyx/resources/webhooks.rb +8 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +81 -8
- data/rbi/telnyx/client.rbi +6 -0
- data/rbi/telnyx/models/access_ip_address_list_response.rbi +4 -52
- data/rbi/telnyx/models/access_ip_range_list_response.rbi +4 -52
- data/rbi/telnyx/models/advanced_order.rbi +171 -0
- data/rbi/telnyx/models/advanced_order_create_params.rbi +5 -199
- data/rbi/telnyx/models/advanced_order_update_requirement_group_params.rbi +5 -224
- data/rbi/telnyx/models/ai/assistants_list.rbi +3 -278
- data/rbi/telnyx/models/ai/{assistant_clone_response.rbi → inference_embedding.rbi} +2 -5
- data/rbi/telnyx/models/call_dial_params.rbi +4 -58
- data/rbi/telnyx/models/calls/action_start_streaming_params.rbi +4 -58
- data/rbi/telnyx/models/calls/telnyx_transcription_language.rbi +230 -0
- data/rbi/telnyx/models/calls/transcription_engine_b_config.rbi +4 -531
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +4 -530
- data/rbi/telnyx/models/document_upload_json_params.rbi +75 -0
- data/rbi/telnyx/models/document_upload_json_response.rbi +33 -0
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rbi +74 -0
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbi +4 -67
- data/rbi/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbi +4 -67
- data/rbi/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rbi +4 -67
- data/rbi/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rbi +74 -0
- data/rbi/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rbi +4 -67
- data/rbi/telnyx/models/{verify_profile_create_template_response.rbi → message_template.rbi} +2 -5
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +3 -53
- data/rbi/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rbi +59 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +4 -54
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +4 -54
- data/rbi/telnyx/models/oauth_client_list_response.rbi +4 -77
- data/rbi/telnyx/models/oauth_grant_list_response.rbi +4 -77
- data/rbi/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rbi +51 -0
- data/rbi/telnyx/models/pagination_meta_oauth.rbi +73 -0
- data/rbi/telnyx/models/phone_number_blocks/job.rbi +4 -172
- data/rbi/telnyx/models/phone_number_blocks/job_error.rbi +140 -0
- data/rbi/telnyx/models/phone_numbers/phone_numbers_job.rbi +4 -174
- data/rbi/telnyx/models/report_list_mdrs_response.rbi +4 -67
- data/rbi/telnyx/models/reports/mdr_usage_report_list_response.rbi +4 -75
- data/rbi/telnyx/models/reports/pagination_meta_reporting.rbi +70 -0
- data/rbi/telnyx/models/stream_bidirectional_sampling_rate.rbi +33 -0
- data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +85 -0
- data/rbi/telnyx/models/verifications/by_phone_number_list_response.rbi +4 -78
- data/rbi/telnyx/models/verifications/verify_meta.rbi +67 -0
- data/rbi/telnyx/models/verify_profile_list_response.rbi +4 -71
- data/rbi/telnyx/models/webhook_unsafe_unwrap_params.rbi +27 -0
- data/rbi/telnyx/models.rbi +18 -0
- data/rbi/telnyx/resources/advanced_orders.rbi +4 -10
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -3
- data/rbi/telnyx/resources/ai/assistants.rbi +3 -3
- data/rbi/telnyx/resources/calls/actions.rbi +1 -1
- data/rbi/telnyx/resources/calls.rbi +1 -1
- data/rbi/telnyx/resources/documents.rbi +25 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +2 -2
- data/rbi/telnyx/resources/verify_profiles.rbi +2 -2
- data/rbi/telnyx/resources/webhooks.rbi +76 -0
- data/sig/telnyx/client.rbs +3 -0
- data/sig/telnyx/models/access_ip_address_list_response.rbs +4 -36
- data/sig/telnyx/models/access_ip_range_list_response.rbs +4 -36
- data/sig/telnyx/models/advanced_order.rbs +105 -0
- data/sig/telnyx/models/advanced_order_create_params.rbs +4 -100
- data/sig/telnyx/models/advanced_order_update_requirement_group_params.rbs +4 -100
- data/sig/telnyx/models/ai/assistants_list.rbs +4 -159
- data/sig/telnyx/models/ai/{assistant_clone_response.rbs → inference_embedding.rbs} +2 -2
- data/sig/telnyx/models/call_dial_params.rbs +6 -21
- data/sig/telnyx/models/calls/action_start_streaming_params.rbs +6 -21
- data/sig/telnyx/models/calls/telnyx_transcription_language.rbs +214 -0
- data/sig/telnyx/models/calls/transcription_engine_b_config.rbs +6 -215
- data/sig/telnyx/models/calls/transcription_start_request.rbs +6 -215
- data/sig/telnyx/models/document_upload_json_params.rbs +45 -0
- data/sig/telnyx/models/document_upload_json_response.rbs +15 -0
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/batch_csv_pagination_meta.rbs +49 -0
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/messaging_list_response.rbs +6 -46
- data/sig/telnyx/models/legacy/reporting/batch_detail_records/voice_list_response.rbs +6 -46
- data/sig/telnyx/models/legacy/reporting/usage_reports/messaging_list_response.rbs +6 -46
- data/sig/telnyx/models/legacy/reporting/usage_reports/standard_pagination_meta.rbs +49 -0
- data/sig/telnyx/models/legacy/reporting/usage_reports/voice_list_response.rbs +6 -46
- data/sig/telnyx/models/{verify_profile_create_template_response.rbs → message_template.rbs} +2 -2
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +4 -23
- data/sig/telnyx/models/messaging_tollfree/verification/toll_free_verification_entity_type.rbs +26 -0
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +6 -25
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +6 -25
- data/sig/telnyx/models/oauth_client_list_response.rbs +5 -50
- data/sig/telnyx/models/oauth_grant_list_response.rbs +5 -50
- data/sig/telnyx/models/pagination_meta_cloudflare_ip_list_sync.rbs +35 -0
- data/sig/telnyx/models/pagination_meta_oauth.rbs +43 -0
- data/sig/telnyx/models/phone_number_blocks/job.rbs +6 -81
- data/sig/telnyx/models/phone_number_blocks/job_error.rbs +80 -0
- data/sig/telnyx/models/phone_numbers/phone_numbers_job.rbs +6 -81
- data/sig/telnyx/models/report_list_mdrs_response.rbs +6 -46
- data/sig/telnyx/models/reports/mdr_usage_report_list_response.rbs +6 -46
- data/sig/telnyx/models/reports/pagination_meta_reporting.rbs +45 -0
- data/sig/telnyx/models/stream_bidirectional_sampling_rate.rbs +18 -0
- data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +75 -0
- data/sig/telnyx/models/verifications/by_phone_number_list_response.rbs +4 -44
- data/sig/telnyx/models/verifications/verify_meta.rbs +45 -0
- data/sig/telnyx/models/verify_profile_list_response.rbs +4 -44
- data/sig/telnyx/models/webhook_unsafe_unwrap_params.rbs +15 -0
- data/sig/telnyx/models.rbs +16 -0
- data/sig/telnyx/resources/advanced_orders.rbs +4 -4
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +3 -3
- data/sig/telnyx/resources/calls/actions.rbs +1 -1
- data/sig/telnyx/resources/calls.rbs +1 -1
- data/sig/telnyx/resources/documents.rbs +8 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +2 -2
- data/sig/telnyx/resources/verify_profiles.rbs +2 -2
- data/sig/telnyx/resources/webhooks.rbs +67 -0
- metadata +58 -28
- data/lib/telnyx/models/ai/assistant_clone_response.rb +0 -167
- data/lib/telnyx/models/ai/assistant_retrieve_response.rb +0 -167
- data/lib/telnyx/models/ai/assistants/version_promote_response.rb +0 -169
- data/lib/telnyx/models/ai/assistants/version_retrieve_response.rb +0 -169
- data/lib/telnyx/models/ai/assistants/version_update_response.rb +0 -169
- data/lib/telnyx/models/verify_profile_update_template_response.rb +0 -16
- data/rbi/telnyx/models/ai/assistant_create_response.rbi +0 -277
- data/rbi/telnyx/models/ai/assistant_retrieve_response.rbi +0 -277
- data/rbi/telnyx/models/ai/assistants/version_promote_response.rbi +0 -287
- data/rbi/telnyx/models/ai/assistants/version_retrieve_response.rbi +0 -287
- data/rbi/telnyx/models/ai/assistants/version_update_response.rbi +0 -287
- data/rbi/telnyx/models/verify_profile_update_template_response.rbi +0 -37
- data/sig/telnyx/models/ai/assistant_create_response.rbs +0 -158
- data/sig/telnyx/models/ai/assistant_retrieve_response.rbs +0 -158
- data/sig/telnyx/models/ai/assistants/version_promote_response.rbs +0 -160
- data/sig/telnyx/models/ai/assistants/version_retrieve_response.rbs +0 -160
- data/sig/telnyx/models/ai/assistants/version_update_response.rbs +0 -160
- data/sig/telnyx/models/verify_profile_update_template_response.rbs +0 -20
|
@@ -1,167 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
# @see Telnyx::Resources::AI::Assistants#clone_
|
|
7
|
-
class AssistantCloneResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute id
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute created_at
|
|
14
|
-
#
|
|
15
|
-
# @return [Time]
|
|
16
|
-
required :created_at, Time
|
|
17
|
-
|
|
18
|
-
# @!attribute instructions
|
|
19
|
-
# System instructions for the assistant. These may be templated with
|
|
20
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
21
|
-
#
|
|
22
|
-
# @return [String]
|
|
23
|
-
required :instructions, String
|
|
24
|
-
|
|
25
|
-
# @!attribute model
|
|
26
|
-
# ID of the model to use. You can use the
|
|
27
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
28
|
-
# to see all of your available models,
|
|
29
|
-
#
|
|
30
|
-
# @return [String]
|
|
31
|
-
required :model, String
|
|
32
|
-
|
|
33
|
-
# @!attribute name
|
|
34
|
-
#
|
|
35
|
-
# @return [String]
|
|
36
|
-
required :name, String
|
|
37
|
-
|
|
38
|
-
# @!attribute description
|
|
39
|
-
#
|
|
40
|
-
# @return [String, nil]
|
|
41
|
-
optional :description, String
|
|
42
|
-
|
|
43
|
-
# @!attribute dynamic_variables
|
|
44
|
-
# Map of dynamic variables and their values
|
|
45
|
-
#
|
|
46
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
47
|
-
optional :dynamic_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
48
|
-
|
|
49
|
-
# @!attribute dynamic_variables_webhook_url
|
|
50
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
51
|
-
# request at the start of the conversation. See our
|
|
52
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
53
|
-
# for more information.
|
|
54
|
-
#
|
|
55
|
-
# @return [String, nil]
|
|
56
|
-
optional :dynamic_variables_webhook_url, String
|
|
57
|
-
|
|
58
|
-
# @!attribute enabled_features
|
|
59
|
-
#
|
|
60
|
-
# @return [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>, nil]
|
|
61
|
-
optional :enabled_features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::EnabledFeatures] }
|
|
62
|
-
|
|
63
|
-
# @!attribute greeting
|
|
64
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
65
|
-
# templated with
|
|
66
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
67
|
-
#
|
|
68
|
-
# @return [String, nil]
|
|
69
|
-
optional :greeting, String
|
|
70
|
-
|
|
71
|
-
# @!attribute import_metadata
|
|
72
|
-
#
|
|
73
|
-
# @return [Telnyx::Models::AI::ImportMetadata, nil]
|
|
74
|
-
optional :import_metadata, -> { Telnyx::AI::ImportMetadata }
|
|
75
|
-
|
|
76
|
-
# @!attribute insight_settings
|
|
77
|
-
#
|
|
78
|
-
# @return [Telnyx::Models::AI::InsightSettings, nil]
|
|
79
|
-
optional :insight_settings, -> { Telnyx::AI::InsightSettings }
|
|
80
|
-
|
|
81
|
-
# @!attribute llm_api_key_ref
|
|
82
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
83
|
-
# for an integration secret
|
|
84
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
85
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
86
|
-
# work with this integration.
|
|
87
|
-
#
|
|
88
|
-
# @return [String, nil]
|
|
89
|
-
optional :llm_api_key_ref, String
|
|
90
|
-
|
|
91
|
-
# @!attribute messaging_settings
|
|
92
|
-
#
|
|
93
|
-
# @return [Telnyx::Models::AI::MessagingSettings, nil]
|
|
94
|
-
optional :messaging_settings, -> { Telnyx::AI::MessagingSettings }
|
|
95
|
-
|
|
96
|
-
# @!attribute privacy_settings
|
|
97
|
-
#
|
|
98
|
-
# @return [Telnyx::Models::AI::PrivacySettings, nil]
|
|
99
|
-
optional :privacy_settings, -> { Telnyx::AI::PrivacySettings }
|
|
100
|
-
|
|
101
|
-
# @!attribute telephony_settings
|
|
102
|
-
#
|
|
103
|
-
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
104
|
-
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
105
|
-
|
|
106
|
-
# @!attribute tools
|
|
107
|
-
# The tools that the assistant can use. These may be templated with
|
|
108
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
109
|
-
#
|
|
110
|
-
# @return [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>, nil]
|
|
111
|
-
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
112
|
-
|
|
113
|
-
# @!attribute transcription
|
|
114
|
-
#
|
|
115
|
-
# @return [Telnyx::Models::AI::TranscriptionSettings, nil]
|
|
116
|
-
optional :transcription, -> { Telnyx::AI::TranscriptionSettings }
|
|
117
|
-
|
|
118
|
-
# @!attribute voice_settings
|
|
119
|
-
#
|
|
120
|
-
# @return [Telnyx::Models::AI::VoiceSettings, nil]
|
|
121
|
-
optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
|
|
122
|
-
|
|
123
|
-
# @!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)
|
|
124
|
-
# Some parameter documentations has been truncated, see
|
|
125
|
-
# {Telnyx::Models::AI::AssistantCloneResponse} for more details.
|
|
126
|
-
#
|
|
127
|
-
# @param id [String]
|
|
128
|
-
#
|
|
129
|
-
# @param created_at [Time]
|
|
130
|
-
#
|
|
131
|
-
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
132
|
-
#
|
|
133
|
-
# @param model [String] ID of the model to use. You can use the [Get models API](https://developers.teln
|
|
134
|
-
#
|
|
135
|
-
# @param name [String]
|
|
136
|
-
#
|
|
137
|
-
# @param description [String]
|
|
138
|
-
#
|
|
139
|
-
# @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their values
|
|
140
|
-
#
|
|
141
|
-
# @param dynamic_variables_webhook_url [String] If the dynamic_variables_webhook_url is set for the assistant, we will send a re
|
|
142
|
-
#
|
|
143
|
-
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
144
|
-
#
|
|
145
|
-
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
146
|
-
#
|
|
147
|
-
# @param import_metadata [Telnyx::Models::AI::ImportMetadata]
|
|
148
|
-
#
|
|
149
|
-
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
150
|
-
#
|
|
151
|
-
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers. The `identifier`
|
|
152
|
-
#
|
|
153
|
-
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
154
|
-
#
|
|
155
|
-
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
156
|
-
#
|
|
157
|
-
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
158
|
-
#
|
|
159
|
-
# @param tools [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
160
|
-
#
|
|
161
|
-
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
162
|
-
#
|
|
163
|
-
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
164
|
-
end
|
|
165
|
-
end
|
|
166
|
-
end
|
|
167
|
-
end
|
|
@@ -1,167 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
# @see Telnyx::Resources::AI::Assistants#retrieve
|
|
7
|
-
class AssistantRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute id
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute created_at
|
|
14
|
-
#
|
|
15
|
-
# @return [Time]
|
|
16
|
-
required :created_at, Time
|
|
17
|
-
|
|
18
|
-
# @!attribute instructions
|
|
19
|
-
# System instructions for the assistant. These may be templated with
|
|
20
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
21
|
-
#
|
|
22
|
-
# @return [String]
|
|
23
|
-
required :instructions, String
|
|
24
|
-
|
|
25
|
-
# @!attribute model
|
|
26
|
-
# ID of the model to use. You can use the
|
|
27
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
28
|
-
# to see all of your available models,
|
|
29
|
-
#
|
|
30
|
-
# @return [String]
|
|
31
|
-
required :model, String
|
|
32
|
-
|
|
33
|
-
# @!attribute name
|
|
34
|
-
#
|
|
35
|
-
# @return [String]
|
|
36
|
-
required :name, String
|
|
37
|
-
|
|
38
|
-
# @!attribute description
|
|
39
|
-
#
|
|
40
|
-
# @return [String, nil]
|
|
41
|
-
optional :description, String
|
|
42
|
-
|
|
43
|
-
# @!attribute dynamic_variables
|
|
44
|
-
# Map of dynamic variables and their values
|
|
45
|
-
#
|
|
46
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
47
|
-
optional :dynamic_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
48
|
-
|
|
49
|
-
# @!attribute dynamic_variables_webhook_url
|
|
50
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
51
|
-
# request at the start of the conversation. See our
|
|
52
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
53
|
-
# for more information.
|
|
54
|
-
#
|
|
55
|
-
# @return [String, nil]
|
|
56
|
-
optional :dynamic_variables_webhook_url, String
|
|
57
|
-
|
|
58
|
-
# @!attribute enabled_features
|
|
59
|
-
#
|
|
60
|
-
# @return [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>, nil]
|
|
61
|
-
optional :enabled_features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::EnabledFeatures] }
|
|
62
|
-
|
|
63
|
-
# @!attribute greeting
|
|
64
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
65
|
-
# templated with
|
|
66
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
67
|
-
#
|
|
68
|
-
# @return [String, nil]
|
|
69
|
-
optional :greeting, String
|
|
70
|
-
|
|
71
|
-
# @!attribute import_metadata
|
|
72
|
-
#
|
|
73
|
-
# @return [Telnyx::Models::AI::ImportMetadata, nil]
|
|
74
|
-
optional :import_metadata, -> { Telnyx::AI::ImportMetadata }
|
|
75
|
-
|
|
76
|
-
# @!attribute insight_settings
|
|
77
|
-
#
|
|
78
|
-
# @return [Telnyx::Models::AI::InsightSettings, nil]
|
|
79
|
-
optional :insight_settings, -> { Telnyx::AI::InsightSettings }
|
|
80
|
-
|
|
81
|
-
# @!attribute llm_api_key_ref
|
|
82
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
83
|
-
# for an integration secret
|
|
84
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
85
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
86
|
-
# work with this integration.
|
|
87
|
-
#
|
|
88
|
-
# @return [String, nil]
|
|
89
|
-
optional :llm_api_key_ref, String
|
|
90
|
-
|
|
91
|
-
# @!attribute messaging_settings
|
|
92
|
-
#
|
|
93
|
-
# @return [Telnyx::Models::AI::MessagingSettings, nil]
|
|
94
|
-
optional :messaging_settings, -> { Telnyx::AI::MessagingSettings }
|
|
95
|
-
|
|
96
|
-
# @!attribute privacy_settings
|
|
97
|
-
#
|
|
98
|
-
# @return [Telnyx::Models::AI::PrivacySettings, nil]
|
|
99
|
-
optional :privacy_settings, -> { Telnyx::AI::PrivacySettings }
|
|
100
|
-
|
|
101
|
-
# @!attribute telephony_settings
|
|
102
|
-
#
|
|
103
|
-
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
104
|
-
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
105
|
-
|
|
106
|
-
# @!attribute tools
|
|
107
|
-
# The tools that the assistant can use. These may be templated with
|
|
108
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
109
|
-
#
|
|
110
|
-
# @return [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>, nil]
|
|
111
|
-
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
112
|
-
|
|
113
|
-
# @!attribute transcription
|
|
114
|
-
#
|
|
115
|
-
# @return [Telnyx::Models::AI::TranscriptionSettings, nil]
|
|
116
|
-
optional :transcription, -> { Telnyx::AI::TranscriptionSettings }
|
|
117
|
-
|
|
118
|
-
# @!attribute voice_settings
|
|
119
|
-
#
|
|
120
|
-
# @return [Telnyx::Models::AI::VoiceSettings, nil]
|
|
121
|
-
optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
|
|
122
|
-
|
|
123
|
-
# @!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)
|
|
124
|
-
# Some parameter documentations has been truncated, see
|
|
125
|
-
# {Telnyx::Models::AI::AssistantRetrieveResponse} for more details.
|
|
126
|
-
#
|
|
127
|
-
# @param id [String]
|
|
128
|
-
#
|
|
129
|
-
# @param created_at [Time]
|
|
130
|
-
#
|
|
131
|
-
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
132
|
-
#
|
|
133
|
-
# @param model [String] ID of the model to use. You can use the [Get models API](https://developers.teln
|
|
134
|
-
#
|
|
135
|
-
# @param name [String]
|
|
136
|
-
#
|
|
137
|
-
# @param description [String]
|
|
138
|
-
#
|
|
139
|
-
# @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their values
|
|
140
|
-
#
|
|
141
|
-
# @param dynamic_variables_webhook_url [String] If the dynamic_variables_webhook_url is set for the assistant, we will send a re
|
|
142
|
-
#
|
|
143
|
-
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
144
|
-
#
|
|
145
|
-
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
146
|
-
#
|
|
147
|
-
# @param import_metadata [Telnyx::Models::AI::ImportMetadata]
|
|
148
|
-
#
|
|
149
|
-
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
150
|
-
#
|
|
151
|
-
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers. The `identifier`
|
|
152
|
-
#
|
|
153
|
-
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
154
|
-
#
|
|
155
|
-
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
156
|
-
#
|
|
157
|
-
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
158
|
-
#
|
|
159
|
-
# @param tools [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
160
|
-
#
|
|
161
|
-
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
162
|
-
#
|
|
163
|
-
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
164
|
-
end
|
|
165
|
-
end
|
|
166
|
-
end
|
|
167
|
-
end
|
|
@@ -1,169 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
module Assistants
|
|
7
|
-
# @see Telnyx::Resources::AI::Assistants::Versions#promote
|
|
8
|
-
class VersionPromoteResponse < Telnyx::Internal::Type::BaseModel
|
|
9
|
-
# @!attribute id
|
|
10
|
-
#
|
|
11
|
-
# @return [String]
|
|
12
|
-
required :id, String
|
|
13
|
-
|
|
14
|
-
# @!attribute created_at
|
|
15
|
-
#
|
|
16
|
-
# @return [Time]
|
|
17
|
-
required :created_at, Time
|
|
18
|
-
|
|
19
|
-
# @!attribute instructions
|
|
20
|
-
# System instructions for the assistant. These may be templated with
|
|
21
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
22
|
-
#
|
|
23
|
-
# @return [String]
|
|
24
|
-
required :instructions, String
|
|
25
|
-
|
|
26
|
-
# @!attribute model
|
|
27
|
-
# ID of the model to use. You can use the
|
|
28
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
29
|
-
# to see all of your available models,
|
|
30
|
-
#
|
|
31
|
-
# @return [String]
|
|
32
|
-
required :model, String
|
|
33
|
-
|
|
34
|
-
# @!attribute name
|
|
35
|
-
#
|
|
36
|
-
# @return [String]
|
|
37
|
-
required :name, String
|
|
38
|
-
|
|
39
|
-
# @!attribute description
|
|
40
|
-
#
|
|
41
|
-
# @return [String, nil]
|
|
42
|
-
optional :description, String
|
|
43
|
-
|
|
44
|
-
# @!attribute dynamic_variables
|
|
45
|
-
# Map of dynamic variables and their values
|
|
46
|
-
#
|
|
47
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
48
|
-
optional :dynamic_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
49
|
-
|
|
50
|
-
# @!attribute dynamic_variables_webhook_url
|
|
51
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
52
|
-
# request at the start of the conversation. See our
|
|
53
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
54
|
-
# for more information.
|
|
55
|
-
#
|
|
56
|
-
# @return [String, nil]
|
|
57
|
-
optional :dynamic_variables_webhook_url, String
|
|
58
|
-
|
|
59
|
-
# @!attribute enabled_features
|
|
60
|
-
#
|
|
61
|
-
# @return [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>, nil]
|
|
62
|
-
optional :enabled_features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::EnabledFeatures] }
|
|
63
|
-
|
|
64
|
-
# @!attribute greeting
|
|
65
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
66
|
-
# templated with
|
|
67
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
68
|
-
#
|
|
69
|
-
# @return [String, nil]
|
|
70
|
-
optional :greeting, String
|
|
71
|
-
|
|
72
|
-
# @!attribute import_metadata
|
|
73
|
-
#
|
|
74
|
-
# @return [Telnyx::Models::AI::ImportMetadata, nil]
|
|
75
|
-
optional :import_metadata, -> { Telnyx::AI::ImportMetadata }
|
|
76
|
-
|
|
77
|
-
# @!attribute insight_settings
|
|
78
|
-
#
|
|
79
|
-
# @return [Telnyx::Models::AI::InsightSettings, nil]
|
|
80
|
-
optional :insight_settings, -> { Telnyx::AI::InsightSettings }
|
|
81
|
-
|
|
82
|
-
# @!attribute llm_api_key_ref
|
|
83
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
84
|
-
# for an integration secret
|
|
85
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
86
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
87
|
-
# work with this integration.
|
|
88
|
-
#
|
|
89
|
-
# @return [String, nil]
|
|
90
|
-
optional :llm_api_key_ref, String
|
|
91
|
-
|
|
92
|
-
# @!attribute messaging_settings
|
|
93
|
-
#
|
|
94
|
-
# @return [Telnyx::Models::AI::MessagingSettings, nil]
|
|
95
|
-
optional :messaging_settings, -> { Telnyx::AI::MessagingSettings }
|
|
96
|
-
|
|
97
|
-
# @!attribute privacy_settings
|
|
98
|
-
#
|
|
99
|
-
# @return [Telnyx::Models::AI::PrivacySettings, nil]
|
|
100
|
-
optional :privacy_settings, -> { Telnyx::AI::PrivacySettings }
|
|
101
|
-
|
|
102
|
-
# @!attribute telephony_settings
|
|
103
|
-
#
|
|
104
|
-
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
105
|
-
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
106
|
-
|
|
107
|
-
# @!attribute tools
|
|
108
|
-
# The tools that the assistant can use. These may be templated with
|
|
109
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
110
|
-
#
|
|
111
|
-
# @return [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>, nil]
|
|
112
|
-
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
113
|
-
|
|
114
|
-
# @!attribute transcription
|
|
115
|
-
#
|
|
116
|
-
# @return [Telnyx::Models::AI::TranscriptionSettings, nil]
|
|
117
|
-
optional :transcription, -> { Telnyx::AI::TranscriptionSettings }
|
|
118
|
-
|
|
119
|
-
# @!attribute voice_settings
|
|
120
|
-
#
|
|
121
|
-
# @return [Telnyx::Models::AI::VoiceSettings, nil]
|
|
122
|
-
optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
|
|
123
|
-
|
|
124
|
-
# @!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)
|
|
125
|
-
# Some parameter documentations has been truncated, see
|
|
126
|
-
# {Telnyx::Models::AI::Assistants::VersionPromoteResponse} for more details.
|
|
127
|
-
#
|
|
128
|
-
# @param id [String]
|
|
129
|
-
#
|
|
130
|
-
# @param created_at [Time]
|
|
131
|
-
#
|
|
132
|
-
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
133
|
-
#
|
|
134
|
-
# @param model [String] ID of the model to use. You can use the [Get models API](https://developers.teln
|
|
135
|
-
#
|
|
136
|
-
# @param name [String]
|
|
137
|
-
#
|
|
138
|
-
# @param description [String]
|
|
139
|
-
#
|
|
140
|
-
# @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their values
|
|
141
|
-
#
|
|
142
|
-
# @param dynamic_variables_webhook_url [String] If the dynamic_variables_webhook_url is set for the assistant, we will send a re
|
|
143
|
-
#
|
|
144
|
-
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
145
|
-
#
|
|
146
|
-
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
147
|
-
#
|
|
148
|
-
# @param import_metadata [Telnyx::Models::AI::ImportMetadata]
|
|
149
|
-
#
|
|
150
|
-
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
151
|
-
#
|
|
152
|
-
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers. The `identifier`
|
|
153
|
-
#
|
|
154
|
-
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
155
|
-
#
|
|
156
|
-
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
157
|
-
#
|
|
158
|
-
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
159
|
-
#
|
|
160
|
-
# @param tools [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
161
|
-
#
|
|
162
|
-
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
163
|
-
#
|
|
164
|
-
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
165
|
-
end
|
|
166
|
-
end
|
|
167
|
-
end
|
|
168
|
-
end
|
|
169
|
-
end
|
|
@@ -1,169 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
module AI
|
|
6
|
-
module Assistants
|
|
7
|
-
# @see Telnyx::Resources::AI::Assistants::Versions#retrieve
|
|
8
|
-
class VersionRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
9
|
-
# @!attribute id
|
|
10
|
-
#
|
|
11
|
-
# @return [String]
|
|
12
|
-
required :id, String
|
|
13
|
-
|
|
14
|
-
# @!attribute created_at
|
|
15
|
-
#
|
|
16
|
-
# @return [Time]
|
|
17
|
-
required :created_at, Time
|
|
18
|
-
|
|
19
|
-
# @!attribute instructions
|
|
20
|
-
# System instructions for the assistant. These may be templated with
|
|
21
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
22
|
-
#
|
|
23
|
-
# @return [String]
|
|
24
|
-
required :instructions, String
|
|
25
|
-
|
|
26
|
-
# @!attribute model
|
|
27
|
-
# ID of the model to use. You can use the
|
|
28
|
-
# [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
|
|
29
|
-
# to see all of your available models,
|
|
30
|
-
#
|
|
31
|
-
# @return [String]
|
|
32
|
-
required :model, String
|
|
33
|
-
|
|
34
|
-
# @!attribute name
|
|
35
|
-
#
|
|
36
|
-
# @return [String]
|
|
37
|
-
required :name, String
|
|
38
|
-
|
|
39
|
-
# @!attribute description
|
|
40
|
-
#
|
|
41
|
-
# @return [String, nil]
|
|
42
|
-
optional :description, String
|
|
43
|
-
|
|
44
|
-
# @!attribute dynamic_variables
|
|
45
|
-
# Map of dynamic variables and their values
|
|
46
|
-
#
|
|
47
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
48
|
-
optional :dynamic_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
49
|
-
|
|
50
|
-
# @!attribute dynamic_variables_webhook_url
|
|
51
|
-
# If the dynamic_variables_webhook_url is set for the assistant, we will send a
|
|
52
|
-
# request at the start of the conversation. See our
|
|
53
|
-
# [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
54
|
-
# for more information.
|
|
55
|
-
#
|
|
56
|
-
# @return [String, nil]
|
|
57
|
-
optional :dynamic_variables_webhook_url, String
|
|
58
|
-
|
|
59
|
-
# @!attribute enabled_features
|
|
60
|
-
#
|
|
61
|
-
# @return [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>, nil]
|
|
62
|
-
optional :enabled_features, -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::EnabledFeatures] }
|
|
63
|
-
|
|
64
|
-
# @!attribute greeting
|
|
65
|
-
# Text that the assistant will use to start the conversation. This may be
|
|
66
|
-
# templated with
|
|
67
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
68
|
-
#
|
|
69
|
-
# @return [String, nil]
|
|
70
|
-
optional :greeting, String
|
|
71
|
-
|
|
72
|
-
# @!attribute import_metadata
|
|
73
|
-
#
|
|
74
|
-
# @return [Telnyx::Models::AI::ImportMetadata, nil]
|
|
75
|
-
optional :import_metadata, -> { Telnyx::AI::ImportMetadata }
|
|
76
|
-
|
|
77
|
-
# @!attribute insight_settings
|
|
78
|
-
#
|
|
79
|
-
# @return [Telnyx::Models::AI::InsightSettings, nil]
|
|
80
|
-
optional :insight_settings, -> { Telnyx::AI::InsightSettings }
|
|
81
|
-
|
|
82
|
-
# @!attribute llm_api_key_ref
|
|
83
|
-
# This is only needed when using third-party inference providers. The `identifier`
|
|
84
|
-
# for an integration secret
|
|
85
|
-
# [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
|
|
86
|
-
# that refers to your LLM provider's API key. Warning: Free plans are unlikely to
|
|
87
|
-
# work with this integration.
|
|
88
|
-
#
|
|
89
|
-
# @return [String, nil]
|
|
90
|
-
optional :llm_api_key_ref, String
|
|
91
|
-
|
|
92
|
-
# @!attribute messaging_settings
|
|
93
|
-
#
|
|
94
|
-
# @return [Telnyx::Models::AI::MessagingSettings, nil]
|
|
95
|
-
optional :messaging_settings, -> { Telnyx::AI::MessagingSettings }
|
|
96
|
-
|
|
97
|
-
# @!attribute privacy_settings
|
|
98
|
-
#
|
|
99
|
-
# @return [Telnyx::Models::AI::PrivacySettings, nil]
|
|
100
|
-
optional :privacy_settings, -> { Telnyx::AI::PrivacySettings }
|
|
101
|
-
|
|
102
|
-
# @!attribute telephony_settings
|
|
103
|
-
#
|
|
104
|
-
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
105
|
-
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
106
|
-
|
|
107
|
-
# @!attribute tools
|
|
108
|
-
# The tools that the assistant can use. These may be templated with
|
|
109
|
-
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
110
|
-
#
|
|
111
|
-
# @return [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>, nil]
|
|
112
|
-
optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
|
|
113
|
-
|
|
114
|
-
# @!attribute transcription
|
|
115
|
-
#
|
|
116
|
-
# @return [Telnyx::Models::AI::TranscriptionSettings, nil]
|
|
117
|
-
optional :transcription, -> { Telnyx::AI::TranscriptionSettings }
|
|
118
|
-
|
|
119
|
-
# @!attribute voice_settings
|
|
120
|
-
#
|
|
121
|
-
# @return [Telnyx::Models::AI::VoiceSettings, nil]
|
|
122
|
-
optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
|
|
123
|
-
|
|
124
|
-
# @!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)
|
|
125
|
-
# Some parameter documentations has been truncated, see
|
|
126
|
-
# {Telnyx::Models::AI::Assistants::VersionRetrieveResponse} for more details.
|
|
127
|
-
#
|
|
128
|
-
# @param id [String]
|
|
129
|
-
#
|
|
130
|
-
# @param created_at [Time]
|
|
131
|
-
#
|
|
132
|
-
# @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
|
|
133
|
-
#
|
|
134
|
-
# @param model [String] ID of the model to use. You can use the [Get models API](https://developers.teln
|
|
135
|
-
#
|
|
136
|
-
# @param name [String]
|
|
137
|
-
#
|
|
138
|
-
# @param description [String]
|
|
139
|
-
#
|
|
140
|
-
# @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their values
|
|
141
|
-
#
|
|
142
|
-
# @param dynamic_variables_webhook_url [String] If the dynamic_variables_webhook_url is set for the assistant, we will send a re
|
|
143
|
-
#
|
|
144
|
-
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
|
|
145
|
-
#
|
|
146
|
-
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
147
|
-
#
|
|
148
|
-
# @param import_metadata [Telnyx::Models::AI::ImportMetadata]
|
|
149
|
-
#
|
|
150
|
-
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
151
|
-
#
|
|
152
|
-
# @param llm_api_key_ref [String] This is only needed when using third-party inference providers. The `identifier`
|
|
153
|
-
#
|
|
154
|
-
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
|
|
155
|
-
#
|
|
156
|
-
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
157
|
-
#
|
|
158
|
-
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
159
|
-
#
|
|
160
|
-
# @param tools [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::HandoffTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::SipReferTool, Telnyx::Models::AI::AssistantTool::DtmfTool>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
161
|
-
#
|
|
162
|
-
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
163
|
-
#
|
|
164
|
-
# @param voice_settings [Telnyx::Models::AI::VoiceSettings]
|
|
165
|
-
end
|
|
166
|
-
end
|
|
167
|
-
end
|
|
168
|
-
end
|
|
169
|
-
end
|