telnyx 5.92.0 → 5.94.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.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +265 -37
  5. data/lib/telnyx/models/ai/assistant_tool.rb +108 -21
  6. data/lib/telnyx/models/ai/assistant_update_params.rb +266 -30
  7. data/lib/telnyx/models/ai/assistants/update_assistant.rb +267 -30
  8. data/lib/telnyx/models/ai/inference_embedding.rb +287 -29
  9. data/lib/telnyx/models/ai/transfer_tool.rb +48 -22
  10. data/lib/telnyx/resources/ai/assistants/versions.rb +18 -6
  11. data/lib/telnyx/resources/ai/assistants.rb +35 -13
  12. data/lib/telnyx/version.rb +1 -1
  13. data/rbi/telnyx/models/ai/assistant_create_params.rbi +510 -52
  14. data/rbi/telnyx/models/ai/assistant_tool.rbi +171 -32
  15. data/rbi/telnyx/models/ai/assistant_update_params.rbi +510 -44
  16. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +526 -44
  17. data/rbi/telnyx/models/ai/inference_embedding.rbi +540 -44
  18. data/rbi/telnyx/models/ai/transfer_tool.rbi +64 -30
  19. data/rbi/telnyx/resources/ai/assistants/versions.rbi +61 -13
  20. data/rbi/telnyx/resources/ai/assistants.rbi +112 -27
  21. data/sig/telnyx/models/ai/assistant_create_params.rbs +172 -5
  22. data/sig/telnyx/models/ai/assistant_tool.rbs +53 -12
  23. data/sig/telnyx/models/ai/assistant_update_params.rbs +172 -0
  24. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +175 -0
  25. data/sig/telnyx/models/ai/inference_embedding.rbs +193 -0
  26. data/sig/telnyx/models/ai/transfer_tool.rbs +22 -12
  27. data/sig/telnyx/resources/ai/assistants/versions.rbs +6 -0
  28. data/sig/telnyx/resources/ai/assistants.rbs +12 -1
  29. metadata +2 -2
@@ -34,19 +34,19 @@ module Telnyx
34
34
  #
35
35
  # Create a new AI Assistant.
36
36
  #
37
- # @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
37
+ # @overload create(instructions:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
38
38
  #
39
39
  # @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
40
40
  #
41
- # @param model [String] ID of the model to use. You can use the [Get models API](https://developers.teln
42
- #
43
41
  # @param name [String]
44
42
  #
45
43
  # @param description [String]
46
44
  #
47
45
  # @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their default values
48
46
  #
49
- # @param dynamic_variables_webhook_url [String] If the dynamic_variables_webhook_url is set for the assistant, we will send a re
47
+ # @param dynamic_variables_webhook_timeout_ms [Integer] Timeout in milliseconds for the dynamic variables webhook. Must be between 1 and
48
+ #
49
+ # @param dynamic_variables_webhook_url [String] If `dynamic_variables_webhook_url` is set, Telnyx sends a POST request to this U
50
50
  #
51
51
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
52
52
  #
@@ -58,21 +58,31 @@ module Telnyx
58
58
  #
59
59
  # @param insight_settings [Telnyx::Models::AI::InsightSettings]
60
60
  #
61
- # @param llm_api_key_ref [String] This is only needed when using third-party inference providers. The `identifier`
61
+ # @param integrations [Array<Telnyx::Models::AI::AssistantCreateParams::Integration>] Connected integrations attached to the assistant. The catalog of available integ
62
+ #
63
+ # @param interruption_settings [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
64
+ #
65
+ # @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
66
+ #
67
+ # @param mcp_servers [Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
62
68
  #
63
69
  # @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
64
70
  #
71
+ # @param model [String] ID of the model to use when `external_llm` is not set. You can use the [Get mode
72
+ #
65
73
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
66
74
  #
67
75
  # @param post_conversation_settings [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
68
76
  #
69
77
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
70
78
  #
79
+ # @param tags [Array<String>] Tags associated with the assistant. Tags can also be managed with the assistant
80
+ #
71
81
  # @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
72
82
  #
73
- # @param tool_ids [Array<String>]
83
+ # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
74
84
  #
75
- # @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
85
+ # @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>] Deprecated for new integrations. Inline tool definitions available to the assist
76
86
  #
77
87
  # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
78
88
  #
@@ -127,7 +137,7 @@ module Telnyx
127
137
  #
128
138
  # Update an AI Assistant's attributes.
129
139
  #
130
- # @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: 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: {})
140
+ # @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
131
141
  #
132
142
  # @param assistant_id [String]
133
143
  #
@@ -135,7 +145,9 @@ module Telnyx
135
145
  #
136
146
  # @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their default values
137
147
  #
138
- # @param dynamic_variables_webhook_url [String] If the dynamic_variables_webhook_url is set for the assistant, we will send a re
148
+ # @param dynamic_variables_webhook_timeout_ms [Integer] Timeout in milliseconds for the dynamic variables webhook. Must be between 1 and
149
+ #
150
+ # @param dynamic_variables_webhook_url [String] If `dynamic_variables_webhook_url` is set, Telnyx sends a POST request to this U
139
151
  #
140
152
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
141
153
  #
@@ -149,11 +161,17 @@ module Telnyx
149
161
  #
150
162
  # @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
151
163
  #
152
- # @param llm_api_key_ref [String] This is only needed when using third-party inference providers. The `identifier`
164
+ # @param integrations [Array<Telnyx::Models::AI::AssistantUpdateParams::Integration>] Connected integrations attached to the assistant. The catalog of available integ
165
+ #
166
+ # @param interruption_settings [Telnyx::Models::AI::AssistantUpdateParams::InterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
167
+ #
168
+ # @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
169
+ #
170
+ # @param mcp_servers [Array<Telnyx::Models::AI::AssistantUpdateParams::McpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
153
171
  #
154
172
  # @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
155
173
  #
156
- # @param model [String] ID of the model to use. You can use the [Get models API](https://developers.teln
174
+ # @param model [String] ID of the model to use when `external_llm` is not set. You can use the [Get mode
157
175
  #
158
176
  # @param name [String]
159
177
  #
@@ -165,14 +183,18 @@ module Telnyx
165
183
  #
166
184
  # @param promote_to_main [Boolean] Indicates whether the assistant should be promoted to the main version. Defaults
167
185
  #
186
+ # @param tags [Array<String>] Tags associated with the assistant. Tags can also be managed with the assistant
187
+ #
168
188
  # @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
169
189
  #
170
- # @param tool_ids [Array<String>]
190
+ # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
171
191
  #
172
- # @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
192
+ # @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>] Deprecated for new integrations. Inline tool definitions available to the assist
173
193
  #
174
194
  # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
175
195
  #
196
+ # @param version_name [String] Human-readable name for the assistant version.
197
+ #
176
198
  # @param voice_settings [Telnyx::Models::AI::VoiceSettings]
177
199
  #
178
200
  # @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.92.0"
4
+ VERSION = "5.94.0"
5
5
  end