telnyx 5.87.0 → 5.89.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 (28) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +209 -1
  5. data/lib/telnyx/models/ai/assistant_update_params.rb +209 -1
  6. data/lib/telnyx/models/ai/assistants/update_assistant.rb +212 -1
  7. data/lib/telnyx/models/ai/inference_embedding.rb +211 -1
  8. data/lib/telnyx/models/ai/transcription_settings.rb +7 -4
  9. data/lib/telnyx/models/call_assistant_request.rb +209 -6
  10. data/lib/telnyx/resources/ai/assistants/versions.rb +5 -1
  11. data/lib/telnyx/resources/ai/assistants.rb +10 -2
  12. data/lib/telnyx/version.rb +1 -1
  13. data/rbi/telnyx/models/ai/assistant_create_params.rbi +419 -0
  14. data/rbi/telnyx/models/ai/assistant_update_params.rbi +419 -0
  15. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +425 -0
  16. data/rbi/telnyx/models/ai/inference_embedding.rbi +415 -0
  17. data/rbi/telnyx/models/ai/transcription_settings.rbi +11 -5
  18. data/rbi/telnyx/models/call_assistant_request.rbi +416 -8
  19. data/rbi/telnyx/resources/ai/assistants/versions.rbi +8 -0
  20. data/rbi/telnyx/resources/ai/assistants.rbi +12 -0
  21. data/sig/telnyx/models/ai/assistant_create_params.rbs +193 -0
  22. data/sig/telnyx/models/ai/assistant_update_params.rbs +193 -0
  23. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +193 -0
  24. data/sig/telnyx/models/ai/inference_embedding.rbs +193 -0
  25. data/sig/telnyx/models/call_assistant_request.rbs +197 -10
  26. data/sig/telnyx/resources/ai/assistants/versions.rbs +2 -0
  27. data/sig/telnyx/resources/ai/assistants.rbs +4 -0
  28. metadata +1 -1
@@ -12,6 +12,8 @@ module Telnyx
12
12
  dynamic_variables: ::Hash[Symbol, top],
13
13
  dynamic_variables_webhook_url: String,
14
14
  enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
15
+ external_llm: Telnyx::AI::InferenceEmbedding::ExternalLlm,
16
+ fallback_config: Telnyx::AI::InferenceEmbedding::FallbackConfig,
15
17
  greeting: String,
16
18
  import_metadata: Telnyx::AI::ImportMetadata,
17
19
  insight_settings: Telnyx::AI::InsightSettings,
@@ -56,6 +58,18 @@ module Telnyx
56
58
  ::Array[Telnyx::Models::AI::enabled_features]
57
59
  ) -> ::Array[Telnyx::Models::AI::enabled_features]
58
60
 
61
+ attr_reader external_llm: Telnyx::AI::InferenceEmbedding::ExternalLlm?
62
+
63
+ def external_llm=: (
64
+ Telnyx::AI::InferenceEmbedding::ExternalLlm
65
+ ) -> Telnyx::AI::InferenceEmbedding::ExternalLlm
66
+
67
+ attr_reader fallback_config: Telnyx::AI::InferenceEmbedding::FallbackConfig?
68
+
69
+ def fallback_config=: (
70
+ Telnyx::AI::InferenceEmbedding::FallbackConfig
71
+ ) -> Telnyx::AI::InferenceEmbedding::FallbackConfig
72
+
59
73
  attr_reader greeting: String?
60
74
 
61
75
  def greeting=: (String) -> String
@@ -140,6 +154,8 @@ module Telnyx
140
154
  ?dynamic_variables: ::Hash[Symbol, top],
141
155
  ?dynamic_variables_webhook_url: String,
142
156
  ?enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
157
+ ?external_llm: Telnyx::AI::InferenceEmbedding::ExternalLlm,
158
+ ?fallback_config: Telnyx::AI::InferenceEmbedding::FallbackConfig,
143
159
  ?greeting: String,
144
160
  ?import_metadata: Telnyx::AI::ImportMetadata,
145
161
  ?insight_settings: Telnyx::AI::InsightSettings,
@@ -165,6 +181,8 @@ module Telnyx
165
181
  dynamic_variables: ::Hash[Symbol, top],
166
182
  dynamic_variables_webhook_url: String,
167
183
  enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
184
+ external_llm: Telnyx::AI::InferenceEmbedding::ExternalLlm,
185
+ fallback_config: Telnyx::AI::InferenceEmbedding::FallbackConfig,
168
186
  greeting: String,
169
187
  import_metadata: Telnyx::AI::ImportMetadata,
170
188
  insight_settings: Telnyx::AI::InsightSettings,
@@ -180,6 +198,181 @@ module Telnyx
180
198
  widget_settings: Telnyx::AI::WidgetSettings
181
199
  }
182
200
 
201
+ type external_llm =
202
+ {
203
+ base_url: String,
204
+ model: String,
205
+ authentication_method: Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::authentication_method,
206
+ certificate_ref: String,
207
+ forward_metadata: bool,
208
+ llm_api_key_ref: String,
209
+ token_retrieval_url: String
210
+ }
211
+
212
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
213
+ attr_accessor base_url: String
214
+
215
+ attr_accessor model: String
216
+
217
+ attr_reader authentication_method: Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::authentication_method?
218
+
219
+ def authentication_method=: (
220
+ Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::authentication_method
221
+ ) -> Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::authentication_method
222
+
223
+ attr_reader certificate_ref: String?
224
+
225
+ def certificate_ref=: (String) -> String
226
+
227
+ attr_reader forward_metadata: bool?
228
+
229
+ def forward_metadata=: (bool) -> bool
230
+
231
+ attr_reader llm_api_key_ref: String?
232
+
233
+ def llm_api_key_ref=: (String) -> String
234
+
235
+ attr_reader token_retrieval_url: String?
236
+
237
+ def token_retrieval_url=: (String) -> String
238
+
239
+ def initialize: (
240
+ base_url: String,
241
+ model: String,
242
+ ?authentication_method: Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::authentication_method,
243
+ ?certificate_ref: String,
244
+ ?forward_metadata: bool,
245
+ ?llm_api_key_ref: String,
246
+ ?token_retrieval_url: String
247
+ ) -> void
248
+
249
+ def to_hash: -> {
250
+ base_url: String,
251
+ model: String,
252
+ authentication_method: Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::authentication_method,
253
+ certificate_ref: String,
254
+ forward_metadata: bool,
255
+ llm_api_key_ref: String,
256
+ token_retrieval_url: String
257
+ }
258
+
259
+ type authentication_method = :token | :certificate
260
+
261
+ module AuthenticationMethod
262
+ extend Telnyx::Internal::Type::Enum
263
+
264
+ TOKEN: :token
265
+ CERTIFICATE: :certificate
266
+
267
+ def self?.values: -> ::Array[Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::authentication_method]
268
+ end
269
+ end
270
+
271
+ type fallback_config =
272
+ {
273
+ external_llm: Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm,
274
+ llm_api_key_ref: String,
275
+ model: String
276
+ }
277
+
278
+ class FallbackConfig < Telnyx::Internal::Type::BaseModel
279
+ attr_reader external_llm: Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm?
280
+
281
+ def external_llm=: (
282
+ Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm
283
+ ) -> Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm
284
+
285
+ attr_reader llm_api_key_ref: String?
286
+
287
+ def llm_api_key_ref=: (String) -> String
288
+
289
+ attr_reader model: String?
290
+
291
+ def model=: (String) -> String
292
+
293
+ def initialize: (
294
+ ?external_llm: Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm,
295
+ ?llm_api_key_ref: String,
296
+ ?model: String
297
+ ) -> void
298
+
299
+ def to_hash: -> {
300
+ external_llm: Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm,
301
+ llm_api_key_ref: String,
302
+ model: String
303
+ }
304
+
305
+ type external_llm =
306
+ {
307
+ base_url: String,
308
+ model: String,
309
+ authentication_method: Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::authentication_method,
310
+ certificate_ref: String,
311
+ forward_metadata: bool,
312
+ llm_api_key_ref: String,
313
+ token_retrieval_url: String
314
+ }
315
+
316
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
317
+ attr_accessor base_url: String
318
+
319
+ attr_accessor model: String
320
+
321
+ attr_reader authentication_method: Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::authentication_method?
322
+
323
+ def authentication_method=: (
324
+ Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::authentication_method
325
+ ) -> Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::authentication_method
326
+
327
+ attr_reader certificate_ref: String?
328
+
329
+ def certificate_ref=: (String) -> String
330
+
331
+ attr_reader forward_metadata: bool?
332
+
333
+ def forward_metadata=: (bool) -> bool
334
+
335
+ attr_reader llm_api_key_ref: String?
336
+
337
+ def llm_api_key_ref=: (String) -> String
338
+
339
+ attr_reader token_retrieval_url: String?
340
+
341
+ def token_retrieval_url=: (String) -> String
342
+
343
+ def initialize: (
344
+ base_url: String,
345
+ model: String,
346
+ ?authentication_method: Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::authentication_method,
347
+ ?certificate_ref: String,
348
+ ?forward_metadata: bool,
349
+ ?llm_api_key_ref: String,
350
+ ?token_retrieval_url: String
351
+ ) -> void
352
+
353
+ def to_hash: -> {
354
+ base_url: String,
355
+ model: String,
356
+ authentication_method: Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::authentication_method,
357
+ certificate_ref: String,
358
+ forward_metadata: bool,
359
+ llm_api_key_ref: String,
360
+ token_retrieval_url: String
361
+ }
362
+
363
+ type authentication_method = :token | :certificate
364
+
365
+ module AuthenticationMethod
366
+ extend Telnyx::Internal::Type::Enum
367
+
368
+ TOKEN: :token
369
+ CERTIFICATE: :certificate
370
+
371
+ def self?.values: -> ::Array[Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::authentication_method]
372
+ end
373
+ end
374
+ end
375
+
183
376
  type post_conversation_settings = { enabled: bool }
184
377
 
185
378
  class PostConversationSettings < Telnyx::Internal::Type::BaseModel
@@ -4,8 +4,8 @@ module Telnyx
4
4
  {
5
5
  id: String,
6
6
  dynamic_variables: ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable],
7
- external_llm: ::Hash[Symbol, top],
8
- fallback_config: ::Hash[Symbol, top],
7
+ external_llm: Telnyx::CallAssistantRequest::ExternalLlm,
8
+ fallback_config: Telnyx::CallAssistantRequest::FallbackConfig,
9
9
  greeting: String,
10
10
  instructions: String,
11
11
  llm_api_key_ref: String,
@@ -26,13 +26,17 @@ module Telnyx
26
26
  ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable]
27
27
  ) -> ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable]
28
28
 
29
- attr_reader external_llm: ::Hash[Symbol, top]?
29
+ attr_reader external_llm: Telnyx::CallAssistantRequest::ExternalLlm?
30
30
 
31
- def external_llm=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
31
+ def external_llm=: (
32
+ Telnyx::CallAssistantRequest::ExternalLlm
33
+ ) -> Telnyx::CallAssistantRequest::ExternalLlm
32
34
 
33
- attr_reader fallback_config: ::Hash[Symbol, top]?
35
+ attr_reader fallback_config: Telnyx::CallAssistantRequest::FallbackConfig?
34
36
 
35
- def fallback_config=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
37
+ def fallback_config=: (
38
+ Telnyx::CallAssistantRequest::FallbackConfig
39
+ ) -> Telnyx::CallAssistantRequest::FallbackConfig
36
40
 
37
41
  attr_reader greeting: String?
38
42
 
@@ -77,8 +81,8 @@ module Telnyx
77
81
  def initialize: (
78
82
  id: String,
79
83
  ?dynamic_variables: ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable],
80
- ?external_llm: ::Hash[Symbol, top],
81
- ?fallback_config: ::Hash[Symbol, top],
84
+ ?external_llm: Telnyx::CallAssistantRequest::ExternalLlm,
85
+ ?fallback_config: Telnyx::CallAssistantRequest::FallbackConfig,
82
86
  ?greeting: String,
83
87
  ?instructions: String,
84
88
  ?llm_api_key_ref: String,
@@ -93,8 +97,8 @@ module Telnyx
93
97
  def to_hash: -> {
94
98
  id: String,
95
99
  dynamic_variables: ::Hash[Symbol, Telnyx::Models::CallAssistantRequest::dynamic_variable],
96
- external_llm: ::Hash[Symbol, top],
97
- fallback_config: ::Hash[Symbol, top],
100
+ external_llm: Telnyx::CallAssistantRequest::ExternalLlm,
101
+ fallback_config: Telnyx::CallAssistantRequest::FallbackConfig,
98
102
  greeting: String,
99
103
  instructions: String,
100
104
  llm_api_key_ref: String,
@@ -114,6 +118,189 @@ module Telnyx
114
118
  def self?.variants: -> ::Array[Telnyx::Models::CallAssistantRequest::dynamic_variable]
115
119
  end
116
120
 
121
+ type external_llm =
122
+ {
123
+ authentication_method: Telnyx::Models::CallAssistantRequest::ExternalLlm::authentication_method,
124
+ base_url: String,
125
+ certificate_ref: String,
126
+ forward_metadata: bool,
127
+ llm_api_key_ref: String,
128
+ model: String,
129
+ token_retrieval_url: String
130
+ }
131
+
132
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
133
+ attr_reader authentication_method: Telnyx::Models::CallAssistantRequest::ExternalLlm::authentication_method?
134
+
135
+ def authentication_method=: (
136
+ Telnyx::Models::CallAssistantRequest::ExternalLlm::authentication_method
137
+ ) -> Telnyx::Models::CallAssistantRequest::ExternalLlm::authentication_method
138
+
139
+ attr_reader base_url: String?
140
+
141
+ def base_url=: (String) -> String
142
+
143
+ attr_reader certificate_ref: String?
144
+
145
+ def certificate_ref=: (String) -> String
146
+
147
+ attr_reader forward_metadata: bool?
148
+
149
+ def forward_metadata=: (bool) -> bool
150
+
151
+ attr_reader llm_api_key_ref: String?
152
+
153
+ def llm_api_key_ref=: (String) -> String
154
+
155
+ attr_reader model: String?
156
+
157
+ def model=: (String) -> String
158
+
159
+ attr_reader token_retrieval_url: String?
160
+
161
+ def token_retrieval_url=: (String) -> String
162
+
163
+ def initialize: (
164
+ ?authentication_method: Telnyx::Models::CallAssistantRequest::ExternalLlm::authentication_method,
165
+ ?base_url: String,
166
+ ?certificate_ref: String,
167
+ ?forward_metadata: bool,
168
+ ?llm_api_key_ref: String,
169
+ ?model: String,
170
+ ?token_retrieval_url: String
171
+ ) -> void
172
+
173
+ def to_hash: -> {
174
+ authentication_method: Telnyx::Models::CallAssistantRequest::ExternalLlm::authentication_method,
175
+ base_url: String,
176
+ certificate_ref: String,
177
+ forward_metadata: bool,
178
+ llm_api_key_ref: String,
179
+ model: String,
180
+ token_retrieval_url: String
181
+ }
182
+
183
+ type authentication_method = :token | :certificate
184
+
185
+ module AuthenticationMethod
186
+ extend Telnyx::Internal::Type::Enum
187
+
188
+ TOKEN: :token
189
+ CERTIFICATE: :certificate
190
+
191
+ def self?.values: -> ::Array[Telnyx::Models::CallAssistantRequest::ExternalLlm::authentication_method]
192
+ end
193
+ end
194
+
195
+ type fallback_config =
196
+ {
197
+ external_llm: Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm,
198
+ llm_api_key_ref: String,
199
+ model: String
200
+ }
201
+
202
+ class FallbackConfig < Telnyx::Internal::Type::BaseModel
203
+ attr_reader external_llm: Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm?
204
+
205
+ def external_llm=: (
206
+ Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm
207
+ ) -> Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm
208
+
209
+ attr_reader llm_api_key_ref: String?
210
+
211
+ def llm_api_key_ref=: (String) -> String
212
+
213
+ attr_reader model: String?
214
+
215
+ def model=: (String) -> String
216
+
217
+ def initialize: (
218
+ ?external_llm: Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm,
219
+ ?llm_api_key_ref: String,
220
+ ?model: String
221
+ ) -> void
222
+
223
+ def to_hash: -> {
224
+ external_llm: Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm,
225
+ llm_api_key_ref: String,
226
+ model: String
227
+ }
228
+
229
+ type external_llm =
230
+ {
231
+ authentication_method: Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::authentication_method,
232
+ base_url: String,
233
+ certificate_ref: String,
234
+ forward_metadata: bool,
235
+ llm_api_key_ref: String,
236
+ model: String,
237
+ token_retrieval_url: String
238
+ }
239
+
240
+ class ExternalLlm < Telnyx::Internal::Type::BaseModel
241
+ attr_reader authentication_method: Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::authentication_method?
242
+
243
+ def authentication_method=: (
244
+ Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::authentication_method
245
+ ) -> Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::authentication_method
246
+
247
+ attr_reader base_url: String?
248
+
249
+ def base_url=: (String) -> String
250
+
251
+ attr_reader certificate_ref: String?
252
+
253
+ def certificate_ref=: (String) -> String
254
+
255
+ attr_reader forward_metadata: bool?
256
+
257
+ def forward_metadata=: (bool) -> bool
258
+
259
+ attr_reader llm_api_key_ref: String?
260
+
261
+ def llm_api_key_ref=: (String) -> String
262
+
263
+ attr_reader model: String?
264
+
265
+ def model=: (String) -> String
266
+
267
+ attr_reader token_retrieval_url: String?
268
+
269
+ def token_retrieval_url=: (String) -> String
270
+
271
+ def initialize: (
272
+ ?authentication_method: Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::authentication_method,
273
+ ?base_url: String,
274
+ ?certificate_ref: String,
275
+ ?forward_metadata: bool,
276
+ ?llm_api_key_ref: String,
277
+ ?model: String,
278
+ ?token_retrieval_url: String
279
+ ) -> void
280
+
281
+ def to_hash: -> {
282
+ authentication_method: Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::authentication_method,
283
+ base_url: String,
284
+ certificate_ref: String,
285
+ forward_metadata: bool,
286
+ llm_api_key_ref: String,
287
+ model: String,
288
+ token_retrieval_url: String
289
+ }
290
+
291
+ type authentication_method = :token | :certificate
292
+
293
+ module AuthenticationMethod
294
+ extend Telnyx::Internal::Type::Enum
295
+
296
+ TOKEN: :token
297
+ CERTIFICATE: :certificate
298
+
299
+ def self?.values: -> ::Array[Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::authentication_method]
300
+ end
301
+ end
302
+ end
303
+
117
304
  type tool =
118
305
  Telnyx::BookAppointmentTool
119
306
  | Telnyx::CheckAvailabilityTool
@@ -17,6 +17,8 @@ module Telnyx
17
17
  ?dynamic_variables: ::Hash[Symbol, top],
18
18
  ?dynamic_variables_webhook_url: String,
19
19
  ?enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
20
+ ?external_llm: Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm,
21
+ ?fallback_config: Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig,
20
22
  ?greeting: String,
21
23
  ?insight_settings: Telnyx::AI::InsightSettings,
22
24
  ?instructions: String,
@@ -22,6 +22,8 @@ module Telnyx
22
22
  ?dynamic_variables: ::Hash[Symbol, top],
23
23
  ?dynamic_variables_webhook_url: String,
24
24
  ?enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
25
+ ?external_llm: Telnyx::AI::AssistantCreateParams::ExternalLlm,
26
+ ?fallback_config: Telnyx::AI::AssistantCreateParams::FallbackConfig,
25
27
  ?greeting: String,
26
28
  ?insight_settings: Telnyx::AI::InsightSettings,
27
29
  ?llm_api_key_ref: String,
@@ -53,6 +55,8 @@ module Telnyx
53
55
  ?dynamic_variables: ::Hash[Symbol, top],
54
56
  ?dynamic_variables_webhook_url: String,
55
57
  ?enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
58
+ ?external_llm: Telnyx::AI::AssistantUpdateParams::ExternalLlm,
59
+ ?fallback_config: Telnyx::AI::AssistantUpdateParams::FallbackConfig,
56
60
  ?greeting: String,
57
61
  ?insight_settings: Telnyx::AI::InsightSettings,
58
62
  ?instructions: String,
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: telnyx
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.87.0
4
+ version: 5.89.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Telnyx