telnyx 5.63.0 → 5.65.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 +16 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +8 -1
- data/lib/telnyx/models/ai/assistant_update_params.rb +8 -1
- data/lib/telnyx/models/ai/assistants/tool_add_params.rb +30 -0
- data/lib/telnyx/models/ai/assistants/tool_add_response.rb +12 -0
- data/lib/telnyx/models/ai/assistants/tool_remove_params.rb +30 -0
- data/lib/telnyx/models/ai/assistants/tool_remove_response.rb +12 -0
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +8 -1
- data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb +36 -1
- data/lib/telnyx/models/ai/tool_create_params.rb +64 -0
- data/lib/telnyx/models/ai/tool_create_response.rb +48 -0
- data/lib/telnyx/models/ai/tool_delete_params.rb +22 -0
- data/lib/telnyx/models/ai/tool_delete_response.rb +10 -0
- data/lib/telnyx/models/ai/tool_list_params.rb +40 -0
- data/lib/telnyx/models/ai/tool_list_response.rb +48 -0
- data/lib/telnyx/models/ai/tool_retrieve_params.rb +22 -0
- data/lib/telnyx/models/ai/tool_retrieve_response.rb +48 -0
- data/lib/telnyx/models/ai/tool_update_params.rb +70 -0
- data/lib/telnyx/models/ai/tool_update_response.rb +48 -0
- data/lib/telnyx/resources/ai/assistants/tools.rb +50 -0
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
- data/lib/telnyx/resources/ai/assistants.rb +6 -2
- data/lib/telnyx/resources/ai/tools.rb +143 -0
- data/lib/telnyx/resources/ai.rb +5 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +15 -0
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +9 -0
- data/rbi/telnyx/models/ai/assistants/tool_add_params.rbi +50 -0
- data/rbi/telnyx/models/ai/assistants/tool_add_response.rbi +11 -0
- data/rbi/telnyx/models/ai/assistants/tool_remove_params.rbi +50 -0
- data/rbi/telnyx/models/ai/assistants/tool_remove_response.rbi +12 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +9 -0
- data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi +71 -0
- data/rbi/telnyx/models/ai/tool_create_params.rbi +103 -0
- data/rbi/telnyx/models/ai/tool_create_response.rbi +79 -0
- data/rbi/telnyx/models/ai/tool_delete_params.rbi +37 -0
- data/rbi/telnyx/models/ai/tool_delete_response.rbi +9 -0
- data/rbi/telnyx/models/ai/tool_list_params.rbi +73 -0
- data/rbi/telnyx/models/ai/tool_list_response.rbi +79 -0
- data/rbi/telnyx/models/ai/tool_retrieve_params.rbi +37 -0
- data/rbi/telnyx/models/ai/tool_retrieve_response.rbi +79 -0
- data/rbi/telnyx/models/ai/tool_update_params.rbi +115 -0
- data/rbi/telnyx/models/ai/tool_update_response.rbi +79 -0
- data/rbi/telnyx/resources/ai/assistants/tools.rbi +22 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -0
- data/rbi/telnyx/resources/ai/assistants.rbi +4 -0
- data/rbi/telnyx/resources/ai/tools.rbi +114 -0
- data/rbi/telnyx/resources/ai.rbi +4 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +7 -0
- data/sig/telnyx/models/ai/assistant_update_params.rbs +7 -0
- data/sig/telnyx/models/ai/assistants/tool_add_params.rbs +32 -0
- data/sig/telnyx/models/ai/assistants/tool_add_response.rbs +9 -0
- data/sig/telnyx/models/ai/assistants/tool_remove_params.rbs +32 -0
- data/sig/telnyx/models/ai/assistants/tool_remove_response.rbs +9 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +7 -0
- data/sig/telnyx/models/ai/inference_embedding_webhook_tool_params.rbs +21 -0
- data/sig/telnyx/models/ai/tool_create_params.rbs +75 -0
- data/sig/telnyx/models/ai/tool_create_response.rbs +53 -0
- data/sig/telnyx/models/ai/tool_delete_params.rbs +25 -0
- data/sig/telnyx/models/ai/tool_delete_response.rbs +7 -0
- data/sig/telnyx/models/ai/tool_list_params.rbs +51 -0
- data/sig/telnyx/models/ai/tool_list_response.rbs +53 -0
- data/sig/telnyx/models/ai/tool_retrieve_params.rbs +25 -0
- data/sig/telnyx/models/ai/tool_retrieve_response.rbs +53 -0
- data/sig/telnyx/models/ai/tool_update_params.rbs +84 -0
- data/sig/telnyx/models/ai/tool_update_response.rbs +53 -0
- data/sig/telnyx/resources/ai/assistants/tools.rbs +12 -0
- data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
- data/sig/telnyx/resources/ai/assistants.rbs +2 -0
- data/sig/telnyx/resources/ai/tools.rbs +52 -0
- data/sig/telnyx/resources/ai.rbs +2 -0
- metadata +46 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4482cc328c3e6d2041574cddfda44fc2ec08a9a1b1134b90c1ad7075100934c8
|
|
4
|
+
data.tar.gz: 01b1df067f588988896ded2b7d9f25bcdf88969ff2adbf2bd4351e0eb6fe0d4b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2d8c0b98d86b972aa768cc77e9389fddde7b25f9ffe9c505f269287964ffed4a7c224ab20c45bf37a2dc931f6cd779effcda4882a00860bba5b133a6435be564
|
|
7
|
+
data.tar.gz: 3b7d417c854a13940fef44962375c1e8e3609046ed1cad17007c97ea803e02055c25820af21683543011e7195dc572e393ca0cf76fa2ada5a8a295a742afffa3
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.65.0 (2026-03-24)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.64.0...v5.65.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.64.0...v5.65.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* New tools api ([0d4a318](https://github.com/team-telnyx/telnyx-ruby/commit/0d4a318b82132d25a28f85620da0bb05599c3ea2))
|
|
10
|
+
|
|
11
|
+
## 5.64.0 (2026-03-24)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v5.63.0...v5.64.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.63.0...v5.64.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* TELAPPS-5685: Add store_fields_as_variables to WebhookToolParams ([603352b](https://github.com/team-telnyx/telnyx-ruby/commit/603352b0959551b578a0092f2b060ff008a17c47))
|
|
18
|
+
|
|
3
19
|
## 5.63.0 (2026-03-24)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v5.62.0...v5.63.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.62.0...v5.63.0)
|
data/README.md
CHANGED
|
@@ -94,6 +94,11 @@ module Telnyx
|
|
|
94
94
|
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
95
95
|
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
96
96
|
|
|
97
|
+
# @!attribute tool_ids
|
|
98
|
+
#
|
|
99
|
+
# @return [Array<String>, nil]
|
|
100
|
+
optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
101
|
+
|
|
97
102
|
# @!attribute tools
|
|
98
103
|
# The tools that the assistant can use. These may be templated with
|
|
99
104
|
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
@@ -117,7 +122,7 @@ module Telnyx
|
|
|
117
122
|
# @return [Telnyx::Models::AI::WidgetSettings, nil]
|
|
118
123
|
optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
|
|
119
124
|
|
|
120
|
-
# @!method initialize(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: 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, request_options: {})
|
|
125
|
+
# @!method initialize(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
121
126
|
# Some parameter documentations has been truncated, see
|
|
122
127
|
# {Telnyx::Models::AI::AssistantCreateParams} for more details.
|
|
123
128
|
#
|
|
@@ -147,6 +152,8 @@ module Telnyx
|
|
|
147
152
|
#
|
|
148
153
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
149
154
|
#
|
|
155
|
+
# @param tool_ids [Array<String>]
|
|
156
|
+
#
|
|
150
157
|
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
151
158
|
#
|
|
152
159
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
@@ -106,6 +106,11 @@ module Telnyx
|
|
|
106
106
|
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
107
107
|
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
108
108
|
|
|
109
|
+
# @!attribute tool_ids
|
|
110
|
+
#
|
|
111
|
+
# @return [Array<String>, nil]
|
|
112
|
+
optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
113
|
+
|
|
109
114
|
# @!attribute tools
|
|
110
115
|
# The tools that the assistant can use. These may be templated with
|
|
111
116
|
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
@@ -129,7 +134,7 @@ module Telnyx
|
|
|
129
134
|
# @return [Telnyx::Models::AI::WidgetSettings, nil]
|
|
130
135
|
optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
|
|
131
136
|
|
|
132
|
-
# @!method initialize(assistant_id:, 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, promote_to_main: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
137
|
+
# @!method initialize(assistant_id:, 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, promote_to_main: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
133
138
|
# Some parameter documentations has been truncated, see
|
|
134
139
|
# {Telnyx::Models::AI::AssistantUpdateParams} for more details.
|
|
135
140
|
#
|
|
@@ -163,6 +168,8 @@ module Telnyx
|
|
|
163
168
|
#
|
|
164
169
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
165
170
|
#
|
|
171
|
+
# @param tool_ids [Array<String>]
|
|
172
|
+
#
|
|
166
173
|
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
167
174
|
#
|
|
168
175
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Assistants
|
|
7
|
+
# @see Telnyx::Resources::AI::Assistants::Tools#add
|
|
8
|
+
class ToolAddParams < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute assistant_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :assistant_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute tool_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :tool_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(assistant_id:, tool_id:, request_options: {})
|
|
23
|
+
# @param assistant_id [String]
|
|
24
|
+
# @param tool_id [String]
|
|
25
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
module Assistants
|
|
7
|
+
# @see Telnyx::Resources::AI::Assistants::Tools#remove
|
|
8
|
+
class ToolRemoveParams < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute assistant_id
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :assistant_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute tool_id
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :tool_id, String
|
|
21
|
+
|
|
22
|
+
# @!method initialize(assistant_id:, tool_id:, request_options: {})
|
|
23
|
+
# @param assistant_id [String]
|
|
24
|
+
# @param tool_id [String]
|
|
25
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -91,6 +91,11 @@ module Telnyx
|
|
|
91
91
|
# @return [Telnyx::Models::AI::TelephonySettings, nil]
|
|
92
92
|
optional :telephony_settings, -> { Telnyx::AI::TelephonySettings }
|
|
93
93
|
|
|
94
|
+
# @!attribute tool_ids
|
|
95
|
+
#
|
|
96
|
+
# @return [Array<String>, nil]
|
|
97
|
+
optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
|
|
98
|
+
|
|
94
99
|
# @!attribute tools
|
|
95
100
|
# The tools that the assistant can use. These may be templated with
|
|
96
101
|
# [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
@@ -114,7 +119,7 @@ module Telnyx
|
|
|
114
119
|
# @return [Telnyx::Models::AI::WidgetSettings, nil]
|
|
115
120
|
optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
|
|
116
121
|
|
|
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)
|
|
122
|
+
# @!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, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil)
|
|
118
123
|
# Some parameter documentations has been truncated, see
|
|
119
124
|
# {Telnyx::Models::AI::Assistants::UpdateAssistant} for more details.
|
|
120
125
|
#
|
|
@@ -144,6 +149,8 @@ module Telnyx
|
|
|
144
149
|
#
|
|
145
150
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
|
|
146
151
|
#
|
|
152
|
+
# @param tool_ids [Array<String>]
|
|
153
|
+
#
|
|
147
154
|
# @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>] The tools that the assistant can use. These may be templated with [dynamic varia
|
|
148
155
|
#
|
|
149
156
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings]
|
|
@@ -103,6 +103,15 @@ module Telnyx
|
|
|
103
103
|
optional :query_parameters,
|
|
104
104
|
-> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters }
|
|
105
105
|
|
|
106
|
+
# @!attribute store_fields_as_variables
|
|
107
|
+
# A list of mappings that extract values from the webhook response and store them
|
|
108
|
+
# as dynamic variables. Each mapping specifies a dynamic variable name and a
|
|
109
|
+
# dot-notation path to the value in the response body.
|
|
110
|
+
#
|
|
111
|
+
# @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable>, nil]
|
|
112
|
+
optional :store_fields_as_variables,
|
|
113
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable] }
|
|
114
|
+
|
|
106
115
|
# @!attribute timeout_ms
|
|
107
116
|
# The maximum number of milliseconds to wait for the webhook to respond. Only
|
|
108
117
|
# applicable when async is false.
|
|
@@ -110,7 +119,7 @@ module Telnyx
|
|
|
110
119
|
# @return [Integer, nil]
|
|
111
120
|
optional :timeout_ms, Integer
|
|
112
121
|
|
|
113
|
-
# @!method initialize(description:, name:, url:, async: nil, body_parameters: nil, headers: nil, http_method: nil, path_parameters: nil, query_parameters: nil, timeout_ms: nil)
|
|
122
|
+
# @!method initialize(description:, name:, url:, async: nil, body_parameters: nil, headers: nil, http_method: nil, path_parameters: nil, query_parameters: nil, store_fields_as_variables: nil, timeout_ms: nil)
|
|
114
123
|
# Some parameter documentations has been truncated, see
|
|
115
124
|
# {Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook} for more
|
|
116
125
|
# details.
|
|
@@ -133,6 +142,8 @@ module Telnyx
|
|
|
133
142
|
#
|
|
134
143
|
# @param query_parameters [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters] The query parameters the webhook tool accepts, described as a JSON Schema object
|
|
135
144
|
#
|
|
145
|
+
# @param store_fields_as_variables [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable>] A list of mappings that extract values from the webhook response and store them
|
|
146
|
+
#
|
|
136
147
|
# @param timeout_ms [Integer] The maximum number of milliseconds to wait for the webhook to respond. Only appl
|
|
137
148
|
|
|
138
149
|
# @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook#body_parameters
|
|
@@ -308,6 +319,30 @@ module Telnyx
|
|
|
308
319
|
# @return [Array<Symbol>]
|
|
309
320
|
end
|
|
310
321
|
end
|
|
322
|
+
|
|
323
|
+
class StoreFieldsAsVariable < Telnyx::Internal::Type::BaseModel
|
|
324
|
+
# @!attribute name
|
|
325
|
+
# The name of the dynamic variable to store the extracted value in.
|
|
326
|
+
#
|
|
327
|
+
# @return [String]
|
|
328
|
+
required :name, String
|
|
329
|
+
|
|
330
|
+
# @!attribute value_path
|
|
331
|
+
# A dot-notation path to the value in the webhook response body (e.g.
|
|
332
|
+
# 'customer.name' or 'id').
|
|
333
|
+
#
|
|
334
|
+
# @return [String]
|
|
335
|
+
required :value_path, String
|
|
336
|
+
|
|
337
|
+
# @!method initialize(name:, value_path:)
|
|
338
|
+
# Some parameter documentations has been truncated, see
|
|
339
|
+
# {Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable}
|
|
340
|
+
# for more details.
|
|
341
|
+
#
|
|
342
|
+
# @param name [String] The name of the dynamic variable to store the extracted value in.
|
|
343
|
+
#
|
|
344
|
+
# @param value_path [String] A dot-notation path to the value in the webhook response body (e.g. 'customer.na
|
|
345
|
+
end
|
|
311
346
|
end
|
|
312
347
|
end
|
|
313
348
|
end
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#create
|
|
7
|
+
class ToolCreateParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute display_name
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :display_name, String
|
|
15
|
+
|
|
16
|
+
# @!attribute type
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :type, String
|
|
20
|
+
|
|
21
|
+
# @!attribute function
|
|
22
|
+
#
|
|
23
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
24
|
+
optional :function, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
25
|
+
|
|
26
|
+
# @!attribute handoff
|
|
27
|
+
#
|
|
28
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
29
|
+
optional :handoff, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
30
|
+
|
|
31
|
+
# @!attribute invite
|
|
32
|
+
#
|
|
33
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
34
|
+
optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
35
|
+
|
|
36
|
+
# @!attribute retrieval
|
|
37
|
+
#
|
|
38
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
39
|
+
optional :retrieval, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
40
|
+
|
|
41
|
+
# @!attribute timeout_ms
|
|
42
|
+
#
|
|
43
|
+
# @return [Integer, nil]
|
|
44
|
+
optional :timeout_ms, Integer
|
|
45
|
+
|
|
46
|
+
# @!attribute webhook
|
|
47
|
+
#
|
|
48
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
49
|
+
optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
50
|
+
|
|
51
|
+
# @!method initialize(display_name:, type:, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
|
|
52
|
+
# @param display_name [String]
|
|
53
|
+
# @param type [String]
|
|
54
|
+
# @param function [Hash{Symbol=>Object}]
|
|
55
|
+
# @param handoff [Hash{Symbol=>Object}]
|
|
56
|
+
# @param invite [Hash{Symbol=>Object}]
|
|
57
|
+
# @param retrieval [Hash{Symbol=>Object}]
|
|
58
|
+
# @param timeout_ms [Integer]
|
|
59
|
+
# @param webhook [Hash{Symbol=>Object}]
|
|
60
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#create
|
|
7
|
+
class ToolCreateResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute tool_definition
|
|
14
|
+
#
|
|
15
|
+
# @return [Hash{Symbol=>Object}]
|
|
16
|
+
required :tool_definition, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
17
|
+
|
|
18
|
+
# @!attribute type
|
|
19
|
+
#
|
|
20
|
+
# @return [String]
|
|
21
|
+
required :type, String
|
|
22
|
+
|
|
23
|
+
# @!attribute created_at
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :created_at, String
|
|
27
|
+
|
|
28
|
+
# @!attribute display_name
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :display_name, String
|
|
32
|
+
|
|
33
|
+
# @!attribute timeout_ms
|
|
34
|
+
#
|
|
35
|
+
# @return [Integer, nil]
|
|
36
|
+
optional :timeout_ms, Integer
|
|
37
|
+
|
|
38
|
+
# @!method initialize(id:, tool_definition:, type:, created_at: nil, display_name: nil, timeout_ms: nil)
|
|
39
|
+
# @param id [String]
|
|
40
|
+
# @param tool_definition [Hash{Symbol=>Object}]
|
|
41
|
+
# @param type [String]
|
|
42
|
+
# @param created_at [String]
|
|
43
|
+
# @param display_name [String]
|
|
44
|
+
# @param timeout_ms [Integer]
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#delete
|
|
7
|
+
class ToolDeleteParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute tool_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :tool_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(tool_id:, request_options: {})
|
|
17
|
+
# @param tool_id [String]
|
|
18
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#list
|
|
7
|
+
class ToolListParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute filter_name
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :filter_name, String
|
|
15
|
+
|
|
16
|
+
# @!attribute filter_type
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :filter_type, String
|
|
20
|
+
|
|
21
|
+
# @!attribute page_number
|
|
22
|
+
#
|
|
23
|
+
# @return [Integer, nil]
|
|
24
|
+
optional :page_number, Integer
|
|
25
|
+
|
|
26
|
+
# @!attribute page_size
|
|
27
|
+
#
|
|
28
|
+
# @return [Integer, nil]
|
|
29
|
+
optional :page_size, Integer
|
|
30
|
+
|
|
31
|
+
# @!method initialize(filter_name: nil, filter_type: nil, page_number: nil, page_size: nil, request_options: {})
|
|
32
|
+
# @param filter_name [String]
|
|
33
|
+
# @param filter_type [String]
|
|
34
|
+
# @param page_number [Integer]
|
|
35
|
+
# @param page_size [Integer]
|
|
36
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#list
|
|
7
|
+
class ToolListResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute tool_definition
|
|
14
|
+
#
|
|
15
|
+
# @return [Hash{Symbol=>Object}]
|
|
16
|
+
required :tool_definition, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
17
|
+
|
|
18
|
+
# @!attribute type
|
|
19
|
+
#
|
|
20
|
+
# @return [String]
|
|
21
|
+
required :type, String
|
|
22
|
+
|
|
23
|
+
# @!attribute created_at
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :created_at, String
|
|
27
|
+
|
|
28
|
+
# @!attribute display_name
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :display_name, String
|
|
32
|
+
|
|
33
|
+
# @!attribute timeout_ms
|
|
34
|
+
#
|
|
35
|
+
# @return [Integer, nil]
|
|
36
|
+
optional :timeout_ms, Integer
|
|
37
|
+
|
|
38
|
+
# @!method initialize(id:, tool_definition:, type:, created_at: nil, display_name: nil, timeout_ms: nil)
|
|
39
|
+
# @param id [String]
|
|
40
|
+
# @param tool_definition [Hash{Symbol=>Object}]
|
|
41
|
+
# @param type [String]
|
|
42
|
+
# @param created_at [String]
|
|
43
|
+
# @param display_name [String]
|
|
44
|
+
# @param timeout_ms [Integer]
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#retrieve
|
|
7
|
+
class ToolRetrieveParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute tool_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :tool_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(tool_id:, request_options: {})
|
|
17
|
+
# @param tool_id [String]
|
|
18
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#retrieve
|
|
7
|
+
class ToolRetrieveResponse < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute tool_definition
|
|
14
|
+
#
|
|
15
|
+
# @return [Hash{Symbol=>Object}]
|
|
16
|
+
required :tool_definition, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
17
|
+
|
|
18
|
+
# @!attribute type
|
|
19
|
+
#
|
|
20
|
+
# @return [String]
|
|
21
|
+
required :type, String
|
|
22
|
+
|
|
23
|
+
# @!attribute created_at
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :created_at, String
|
|
27
|
+
|
|
28
|
+
# @!attribute display_name
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :display_name, String
|
|
32
|
+
|
|
33
|
+
# @!attribute timeout_ms
|
|
34
|
+
#
|
|
35
|
+
# @return [Integer, nil]
|
|
36
|
+
optional :timeout_ms, Integer
|
|
37
|
+
|
|
38
|
+
# @!method initialize(id:, tool_definition:, type:, created_at: nil, display_name: nil, timeout_ms: nil)
|
|
39
|
+
# @param id [String]
|
|
40
|
+
# @param tool_definition [Hash{Symbol=>Object}]
|
|
41
|
+
# @param type [String]
|
|
42
|
+
# @param created_at [String]
|
|
43
|
+
# @param display_name [String]
|
|
44
|
+
# @param timeout_ms [Integer]
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module AI
|
|
6
|
+
# @see Telnyx::Resources::AI::Tools#update
|
|
7
|
+
class ToolUpdateParams < Telnyx::Internal::Type::BaseModel
|
|
8
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute tool_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :tool_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute display_name
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :display_name, String
|
|
20
|
+
|
|
21
|
+
# @!attribute function
|
|
22
|
+
#
|
|
23
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
24
|
+
optional :function, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
25
|
+
|
|
26
|
+
# @!attribute handoff
|
|
27
|
+
#
|
|
28
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
29
|
+
optional :handoff, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
30
|
+
|
|
31
|
+
# @!attribute invite
|
|
32
|
+
#
|
|
33
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
34
|
+
optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
35
|
+
|
|
36
|
+
# @!attribute retrieval
|
|
37
|
+
#
|
|
38
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
39
|
+
optional :retrieval, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
40
|
+
|
|
41
|
+
# @!attribute timeout_ms
|
|
42
|
+
#
|
|
43
|
+
# @return [Integer, nil]
|
|
44
|
+
optional :timeout_ms, Integer
|
|
45
|
+
|
|
46
|
+
# @!attribute type
|
|
47
|
+
#
|
|
48
|
+
# @return [String, nil]
|
|
49
|
+
optional :type, String
|
|
50
|
+
|
|
51
|
+
# @!attribute webhook
|
|
52
|
+
#
|
|
53
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
54
|
+
optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
|
|
55
|
+
|
|
56
|
+
# @!method initialize(tool_id:, display_name: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
|
|
57
|
+
# @param tool_id [String]
|
|
58
|
+
# @param display_name [String]
|
|
59
|
+
# @param function [Hash{Symbol=>Object}]
|
|
60
|
+
# @param handoff [Hash{Symbol=>Object}]
|
|
61
|
+
# @param invite [Hash{Symbol=>Object}]
|
|
62
|
+
# @param retrieval [Hash{Symbol=>Object}]
|
|
63
|
+
# @param timeout_ms [Integer]
|
|
64
|
+
# @param type [String]
|
|
65
|
+
# @param webhook [Hash{Symbol=>Object}]
|
|
66
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
end
|