telnyx 5.91.0 → 5.93.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 +480 -34
- data/lib/telnyx/models/ai/assistant_update_params.rb +481 -27
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +487 -27
- data/lib/telnyx/models/ai/inference_embedding.rb +505 -26
- data/lib/telnyx/models/calls/transcription_start_request.rb +171 -3
- data/lib/telnyx/resources/ai/assistants/versions.rb +21 -9
- data/lib/telnyx/resources/ai/assistants.rb +41 -19
- data/lib/telnyx/resources/calls/actions.rb +1 -1
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +0 -6
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +945 -44
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +945 -36
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +967 -36
- data/rbi/telnyx/models/ai/inference_embedding.rbi +972 -36
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +490 -0
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +66 -16
- data/rbi/telnyx/resources/ai/assistants.rbi +122 -33
- data/rbi/telnyx/resources/calls/actions.rbi +2 -0
- data/sig/telnyx/models/ai/assistant_create_params.rbs +377 -23
- data/sig/telnyx/models/ai/assistant_update_params.rbs +377 -18
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +380 -18
- data/sig/telnyx/models/ai/inference_embedding.rbs +399 -17
- data/sig/telnyx/models/calls/transcription_start_request.rbs +187 -1
- data/sig/telnyx/resources/ai/assistants/versions.rbs +9 -3
- data/sig/telnyx/resources/ai/assistants.rbs +18 -7
- metadata +1 -19
- data/lib/telnyx/models/ai/external_llm.rb +0 -87
- data/lib/telnyx/models/ai/external_llm_req.rb +0 -87
- data/lib/telnyx/models/ai/fallback_config.rb +0 -37
- data/lib/telnyx/models/ai/fallback_config_req.rb +0 -37
- data/lib/telnyx/models/ai/post_conversation_settings.rb +0 -30
- data/lib/telnyx/models/ai/post_conversation_settings_req.rb +0 -30
- data/rbi/telnyx/models/ai/external_llm.rbi +0 -157
- data/rbi/telnyx/models/ai/external_llm_req.rbi +0 -157
- data/rbi/telnyx/models/ai/fallback_config.rbi +0 -64
- data/rbi/telnyx/models/ai/fallback_config_req.rbi +0 -64
- data/rbi/telnyx/models/ai/post_conversation_settings.rbi +0 -45
- data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +0 -45
- data/sig/telnyx/models/ai/external_llm.rbs +0 -75
- data/sig/telnyx/models/ai/external_llm_req.rbs +0 -75
- data/sig/telnyx/models/ai/fallback_config.rbs +0 -38
- data/sig/telnyx/models/ai/fallback_config_req.rbs +0 -40
- data/sig/telnyx/models/ai/post_conversation_settings.rbs +0 -17
- data/sig/telnyx/models/ai/post_conversation_settings_req.rbs +0 -17
|
@@ -27,7 +27,7 @@ module Telnyx
|
|
|
27
27
|
|
|
28
28
|
# @!attribute transcription_engine_config
|
|
29
29
|
#
|
|
30
|
-
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
30
|
+
# @return [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config, nil]
|
|
31
31
|
optional :transcription_engine_config,
|
|
32
32
|
union: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig }
|
|
33
33
|
|
|
@@ -49,7 +49,7 @@ module Telnyx
|
|
|
49
49
|
#
|
|
50
50
|
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
51
51
|
#
|
|
52
|
-
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
52
|
+
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
53
53
|
#
|
|
54
54
|
# @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
|
|
55
55
|
|
|
@@ -64,6 +64,8 @@ module Telnyx
|
|
|
64
64
|
TELNYX = :Telnyx
|
|
65
65
|
DEEPGRAM = :Deepgram
|
|
66
66
|
AZURE = :Azure
|
|
67
|
+
X_AI = :xAI
|
|
68
|
+
ASSEMBLY_AI = :AssemblyAI
|
|
67
69
|
A = :A
|
|
68
70
|
B = :B
|
|
69
71
|
|
|
@@ -83,6 +85,11 @@ module Telnyx
|
|
|
83
85
|
|
|
84
86
|
variant :Azure, -> { Telnyx::Calls::TranscriptionEngineAzureConfig }
|
|
85
87
|
|
|
88
|
+
variant :xAI, -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI }
|
|
89
|
+
|
|
90
|
+
variant :AssemblyAI,
|
|
91
|
+
-> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI }
|
|
92
|
+
|
|
86
93
|
variant :A, -> { Telnyx::Calls::TranscriptionEngineAConfig }
|
|
87
94
|
|
|
88
95
|
variant :B, -> { Telnyx::Calls::TranscriptionEngineBConfig }
|
|
@@ -91,8 +98,169 @@ module Telnyx
|
|
|
91
98
|
|
|
92
99
|
variant :"deepgram/nova-3", -> { Telnyx::Calls::DeepgramNova3Config }
|
|
93
100
|
|
|
101
|
+
class XAI < Telnyx::Internal::Type::BaseModel
|
|
102
|
+
# @!attribute interim_results
|
|
103
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
104
|
+
# be sent.
|
|
105
|
+
#
|
|
106
|
+
# @return [Boolean, nil]
|
|
107
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
108
|
+
|
|
109
|
+
# @!attribute language
|
|
110
|
+
# Language to use for speech recognition
|
|
111
|
+
#
|
|
112
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::Language, nil]
|
|
113
|
+
optional :language,
|
|
114
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::Language }
|
|
115
|
+
|
|
116
|
+
# @!attribute transcription_engine
|
|
117
|
+
# Engine identifier for xAI transcription service
|
|
118
|
+
#
|
|
119
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionEngine, nil]
|
|
120
|
+
optional :transcription_engine,
|
|
121
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionEngine }
|
|
122
|
+
|
|
123
|
+
# @!attribute transcription_model
|
|
124
|
+
# The model to use for transcription.
|
|
125
|
+
#
|
|
126
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionModel, nil]
|
|
127
|
+
optional :transcription_model,
|
|
128
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionModel }
|
|
129
|
+
|
|
130
|
+
# @!method initialize(interim_results: nil, language: nil, transcription_engine: nil, transcription_model: nil)
|
|
131
|
+
# Some parameter documentations has been truncated, see
|
|
132
|
+
# {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI}
|
|
133
|
+
# for more details.
|
|
134
|
+
#
|
|
135
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
136
|
+
#
|
|
137
|
+
# @param language [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::Language] Language to use for speech recognition
|
|
138
|
+
#
|
|
139
|
+
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionEngine] Engine identifier for xAI transcription service
|
|
140
|
+
#
|
|
141
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::TranscriptionModel] The model to use for transcription.
|
|
142
|
+
|
|
143
|
+
# Language to use for speech recognition
|
|
144
|
+
#
|
|
145
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI#language
|
|
146
|
+
module Language
|
|
147
|
+
extend Telnyx::Internal::Type::Enum
|
|
148
|
+
|
|
149
|
+
AR = :ar
|
|
150
|
+
CS = :cs
|
|
151
|
+
DA = :da
|
|
152
|
+
DE = :de
|
|
153
|
+
EN = :en
|
|
154
|
+
ES = :es
|
|
155
|
+
FA = :fa
|
|
156
|
+
FIL = :fil
|
|
157
|
+
FR = :fr
|
|
158
|
+
HI = :hi
|
|
159
|
+
ID = :id
|
|
160
|
+
IT = :it
|
|
161
|
+
JA = :ja
|
|
162
|
+
KO = :ko
|
|
163
|
+
MK = :mk
|
|
164
|
+
MS = :ms
|
|
165
|
+
NL = :nl
|
|
166
|
+
PL = :pl
|
|
167
|
+
PT = :pt
|
|
168
|
+
RO = :ro
|
|
169
|
+
RU = :ru
|
|
170
|
+
SV = :sv
|
|
171
|
+
TH = :th
|
|
172
|
+
TR = :tr
|
|
173
|
+
VI = :vi
|
|
174
|
+
|
|
175
|
+
# @!method self.values
|
|
176
|
+
# @return [Array<Symbol>]
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
# Engine identifier for xAI transcription service
|
|
180
|
+
#
|
|
181
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI#transcription_engine
|
|
182
|
+
module TranscriptionEngine
|
|
183
|
+
extend Telnyx::Internal::Type::Enum
|
|
184
|
+
|
|
185
|
+
X_AI = :xAI
|
|
186
|
+
|
|
187
|
+
# @!method self.values
|
|
188
|
+
# @return [Array<Symbol>]
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# The model to use for transcription.
|
|
192
|
+
#
|
|
193
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI#transcription_model
|
|
194
|
+
module TranscriptionModel
|
|
195
|
+
extend Telnyx::Internal::Type::Enum
|
|
196
|
+
|
|
197
|
+
XAI_GROK_STT = :"xai/grok-stt"
|
|
198
|
+
|
|
199
|
+
# @!method self.values
|
|
200
|
+
# @return [Array<Symbol>]
|
|
201
|
+
end
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
class AssemblyAI < Telnyx::Internal::Type::BaseModel
|
|
205
|
+
# @!attribute interim_results
|
|
206
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
207
|
+
# be sent.
|
|
208
|
+
#
|
|
209
|
+
# @return [Boolean, nil]
|
|
210
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
211
|
+
|
|
212
|
+
# @!attribute transcription_engine
|
|
213
|
+
# Engine identifier for AssemblyAI transcription service
|
|
214
|
+
#
|
|
215
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionEngine, nil]
|
|
216
|
+
optional :transcription_engine,
|
|
217
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionEngine }
|
|
218
|
+
|
|
219
|
+
# @!attribute transcription_model
|
|
220
|
+
# The model to use for transcription.
|
|
221
|
+
#
|
|
222
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionModel, nil]
|
|
223
|
+
optional :transcription_model,
|
|
224
|
+
enum: -> { Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionModel }
|
|
225
|
+
|
|
226
|
+
# @!method initialize(interim_results: nil, transcription_engine: nil, transcription_model: nil)
|
|
227
|
+
# Some parameter documentations has been truncated, see
|
|
228
|
+
# {Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI}
|
|
229
|
+
# for more details.
|
|
230
|
+
#
|
|
231
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
232
|
+
#
|
|
233
|
+
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionEngine] Engine identifier for AssemblyAI transcription service
|
|
234
|
+
#
|
|
235
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::TranscriptionModel] The model to use for transcription.
|
|
236
|
+
|
|
237
|
+
# Engine identifier for AssemblyAI transcription service
|
|
238
|
+
#
|
|
239
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI#transcription_engine
|
|
240
|
+
module TranscriptionEngine
|
|
241
|
+
extend Telnyx::Internal::Type::Enum
|
|
242
|
+
|
|
243
|
+
ASSEMBLY_AI = :AssemblyAI
|
|
244
|
+
|
|
245
|
+
# @!method self.values
|
|
246
|
+
# @return [Array<Symbol>]
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
# The model to use for transcription.
|
|
250
|
+
#
|
|
251
|
+
# @see Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI#transcription_model
|
|
252
|
+
module TranscriptionModel
|
|
253
|
+
extend Telnyx::Internal::Type::Enum
|
|
254
|
+
|
|
255
|
+
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
256
|
+
|
|
257
|
+
# @!method self.values
|
|
258
|
+
# @return [Array<Symbol>]
|
|
259
|
+
end
|
|
260
|
+
end
|
|
261
|
+
|
|
94
262
|
# @!method self.variants
|
|
95
|
-
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
263
|
+
# @return [Array(Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config)]
|
|
96
264
|
end
|
|
97
265
|
end
|
|
98
266
|
end
|
|
@@ -43,7 +43,7 @@ module Telnyx
|
|
|
43
43
|
# Updates the configuration of a specific assistant version. Can not update main
|
|
44
44
|
# version
|
|
45
45
|
#
|
|
46
|
-
# @overload update(version_id, 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, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
46
|
+
# @overload update(version_id, 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, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
|
|
47
47
|
#
|
|
48
48
|
# @param version_id [String] Path param
|
|
49
49
|
#
|
|
@@ -53,13 +53,15 @@ module Telnyx
|
|
|
53
53
|
#
|
|
54
54
|
# @param dynamic_variables [Hash{Symbol=>Object}] Body param: Map of dynamic variables and their default values
|
|
55
55
|
#
|
|
56
|
-
# @param
|
|
56
|
+
# @param dynamic_variables_webhook_timeout_ms [Integer] Body param: Timeout in milliseconds for the dynamic variables webhook. Must be b
|
|
57
|
+
#
|
|
58
|
+
# @param dynamic_variables_webhook_url [String] Body param: If `dynamic_variables_webhook_url` is set, Telnyx sends a POST reque
|
|
57
59
|
#
|
|
58
60
|
# @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>] Body param
|
|
59
61
|
#
|
|
60
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
62
|
+
# @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm] Body param
|
|
61
63
|
#
|
|
62
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
64
|
+
# @param fallback_config [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig] Body param
|
|
63
65
|
#
|
|
64
66
|
# @param greeting [String] Body param: Text that the assistant will use to start the conversation. This may
|
|
65
67
|
#
|
|
@@ -67,28 +69,38 @@ module Telnyx
|
|
|
67
69
|
#
|
|
68
70
|
# @param instructions [String] Body param: System instructions for the assistant. These may be templated with [
|
|
69
71
|
#
|
|
70
|
-
# @param
|
|
72
|
+
# @param integrations [Array<Telnyx::Models::AI::Assistants::UpdateAssistant::Integration>] Body param: Connected integrations attached to the assistant. The catalog of ava
|
|
73
|
+
#
|
|
74
|
+
# @param interruption_settings [Telnyx::Models::AI::Assistants::UpdateAssistant::InterruptionSettings] Body param: Settings for interruptions and how the assistant decides the user ha
|
|
75
|
+
#
|
|
76
|
+
# @param llm_api_key_ref [String] Body param: This is only needed when using third-party inference providers selec
|
|
77
|
+
#
|
|
78
|
+
# @param mcp_servers [Array<Telnyx::Models::AI::Assistants::UpdateAssistant::McpServer>] Body param: MCP servers attached to the assistant. Create MCP servers with `/ai/
|
|
71
79
|
#
|
|
72
80
|
# @param messaging_settings [Telnyx::Models::AI::MessagingSettings] Body param
|
|
73
81
|
#
|
|
74
|
-
# @param model [String] Body param: ID of the model to use. You can use
|
|
82
|
+
# @param model [String] Body param: ID of the model to use when `external_llm` is not set. You can use t
|
|
75
83
|
#
|
|
76
84
|
# @param name [String] Body param
|
|
77
85
|
#
|
|
78
86
|
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq] Body param
|
|
79
87
|
#
|
|
80
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
88
|
+
# @param post_conversation_settings [Telnyx::Models::AI::Assistants::UpdateAssistant::PostConversationSettings] Body param: Configuration for post-conversation processing. When enabled, the as
|
|
81
89
|
#
|
|
82
90
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings] Body param
|
|
83
91
|
#
|
|
92
|
+
# @param tags [Array<String>] Body param: Tags associated with the assistant. Tags can also be managed with th
|
|
93
|
+
#
|
|
84
94
|
# @param telephony_settings [Telnyx::Models::AI::TelephonySettings] Body param
|
|
85
95
|
#
|
|
86
|
-
# @param tool_ids [Array<String>] Body param
|
|
96
|
+
# @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
|
|
87
97
|
#
|
|
88
|
-
# @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>] Body param:
|
|
98
|
+
# @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>] Body param: Deprecated for new integrations. Inline tool definitions available t
|
|
89
99
|
#
|
|
90
100
|
# @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
|
|
91
101
|
#
|
|
102
|
+
# @param version_name [String] Body param: Human-readable name for the assistant version.
|
|
103
|
+
#
|
|
92
104
|
# @param voice_settings [Telnyx::Models::AI::VoiceSettings] Body param
|
|
93
105
|
#
|
|
94
106
|
# @param widget_settings [Telnyx::Models::AI::WidgetSettings] Body param: Configuration settings for the assistant's web widget.
|
|
@@ -34,45 +34,55 @@ module Telnyx
|
|
|
34
34
|
#
|
|
35
35
|
# Create a new AI Assistant.
|
|
36
36
|
#
|
|
37
|
-
# @overload create(instructions:,
|
|
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
|
|
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
|
#
|
|
53
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
53
|
+
# @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
|
|
54
54
|
#
|
|
55
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
55
|
+
# @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
|
|
56
56
|
#
|
|
57
57
|
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
58
58
|
#
|
|
59
59
|
# @param insight_settings [Telnyx::Models::AI::InsightSettings]
|
|
60
60
|
#
|
|
61
|
-
# @param
|
|
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
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
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>]
|
|
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,13 +145,15 @@ module Telnyx
|
|
|
135
145
|
#
|
|
136
146
|
# @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their default values
|
|
137
147
|
#
|
|
138
|
-
# @param
|
|
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
|
#
|
|
142
|
-
# @param external_llm [Telnyx::Models::AI::
|
|
154
|
+
# @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm]
|
|
143
155
|
#
|
|
144
|
-
# @param fallback_config [Telnyx::Models::AI::
|
|
156
|
+
# @param fallback_config [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig]
|
|
145
157
|
#
|
|
146
158
|
# @param greeting [String] Text that the assistant will use to start the conversation. This may be template
|
|
147
159
|
#
|
|
@@ -149,30 +161,40 @@ 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
|
|
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
|
|
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
|
#
|
|
160
178
|
# @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
|
|
161
179
|
#
|
|
162
|
-
# @param post_conversation_settings [Telnyx::Models::AI::
|
|
180
|
+
# @param post_conversation_settings [Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
|
|
163
181
|
#
|
|
164
182
|
# @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
|
|
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>]
|
|
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.
|
|
@@ -1256,7 +1256,7 @@ module Telnyx
|
|
|
1256
1256
|
#
|
|
1257
1257
|
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
|
|
1258
1258
|
#
|
|
1259
|
-
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
1259
|
+
# @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
|
|
1260
1260
|
#
|
|
1261
1261
|
# @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
|
|
1262
1262
|
#
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -256,10 +256,6 @@ require_relative "telnyx/models/ai/embedding_similarity_search_params"
|
|
|
256
256
|
require_relative "telnyx/models/ai/embedding_similarity_search_response"
|
|
257
257
|
require_relative "telnyx/models/ai/embedding_url_params"
|
|
258
258
|
require_relative "telnyx/models/ai/enabled_features"
|
|
259
|
-
require_relative "telnyx/models/ai/external_llm"
|
|
260
|
-
require_relative "telnyx/models/ai/external_llm_req"
|
|
261
|
-
require_relative "telnyx/models/ai/fallback_config"
|
|
262
|
-
require_relative "telnyx/models/ai/fallback_config_req"
|
|
263
259
|
require_relative "telnyx/models/ai/fine_tuning/fine_tuning_job"
|
|
264
260
|
require_relative "telnyx/models/ai/fine_tuning/job_cancel_params"
|
|
265
261
|
require_relative "telnyx/models/ai/fine_tuning/job_create_params"
|
|
@@ -375,8 +371,6 @@ require_relative "telnyx/models/ai/openai/embedding_create_embeddings_params"
|
|
|
375
371
|
require_relative "telnyx/models/ai/openai/embedding_create_embeddings_response"
|
|
376
372
|
require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_params"
|
|
377
373
|
require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_response"
|
|
378
|
-
require_relative "telnyx/models/ai/post_conversation_settings"
|
|
379
|
-
require_relative "telnyx/models/ai/post_conversation_settings_req"
|
|
380
374
|
require_relative "telnyx/models/ai/privacy_settings"
|
|
381
375
|
require_relative "telnyx/models/ai/recursive_cluster"
|
|
382
376
|
require_relative "telnyx/models/ai/retrieval_tool"
|