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.
Files changed (47) 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 +480 -34
  5. data/lib/telnyx/models/ai/assistant_update_params.rb +481 -27
  6. data/lib/telnyx/models/ai/assistants/update_assistant.rb +487 -27
  7. data/lib/telnyx/models/ai/inference_embedding.rb +505 -26
  8. data/lib/telnyx/models/calls/transcription_start_request.rb +171 -3
  9. data/lib/telnyx/resources/ai/assistants/versions.rb +21 -9
  10. data/lib/telnyx/resources/ai/assistants.rb +41 -19
  11. data/lib/telnyx/resources/calls/actions.rb +1 -1
  12. data/lib/telnyx/version.rb +1 -1
  13. data/lib/telnyx.rb +0 -6
  14. data/rbi/telnyx/models/ai/assistant_create_params.rbi +945 -44
  15. data/rbi/telnyx/models/ai/assistant_update_params.rbi +945 -36
  16. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +967 -36
  17. data/rbi/telnyx/models/ai/inference_embedding.rbi +972 -36
  18. data/rbi/telnyx/models/calls/transcription_start_request.rbi +490 -0
  19. data/rbi/telnyx/resources/ai/assistants/versions.rbi +66 -16
  20. data/rbi/telnyx/resources/ai/assistants.rbi +122 -33
  21. data/rbi/telnyx/resources/calls/actions.rbi +2 -0
  22. data/sig/telnyx/models/ai/assistant_create_params.rbs +377 -23
  23. data/sig/telnyx/models/ai/assistant_update_params.rbs +377 -18
  24. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +380 -18
  25. data/sig/telnyx/models/ai/inference_embedding.rbs +399 -17
  26. data/sig/telnyx/models/calls/transcription_start_request.rbs +187 -1
  27. data/sig/telnyx/resources/ai/assistants/versions.rbs +9 -3
  28. data/sig/telnyx/resources/ai/assistants.rbs +18 -7
  29. metadata +1 -19
  30. data/lib/telnyx/models/ai/external_llm.rb +0 -87
  31. data/lib/telnyx/models/ai/external_llm_req.rb +0 -87
  32. data/lib/telnyx/models/ai/fallback_config.rb +0 -37
  33. data/lib/telnyx/models/ai/fallback_config_req.rb +0 -37
  34. data/lib/telnyx/models/ai/post_conversation_settings.rb +0 -30
  35. data/lib/telnyx/models/ai/post_conversation_settings_req.rb +0 -30
  36. data/rbi/telnyx/models/ai/external_llm.rbi +0 -157
  37. data/rbi/telnyx/models/ai/external_llm_req.rbi +0 -157
  38. data/rbi/telnyx/models/ai/fallback_config.rbi +0 -64
  39. data/rbi/telnyx/models/ai/fallback_config_req.rbi +0 -64
  40. data/rbi/telnyx/models/ai/post_conversation_settings.rbi +0 -45
  41. data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +0 -45
  42. data/sig/telnyx/models/ai/external_llm.rbs +0 -75
  43. data/sig/telnyx/models/ai/external_llm_req.rbs +0 -75
  44. data/sig/telnyx/models/ai/fallback_config.rbs +0 -38
  45. data/sig/telnyx/models/ai/fallback_config_req.rbs +0 -40
  46. data/sig/telnyx/models/ai/post_conversation_settings.rbs +0 -17
  47. data/sig/telnyx/models/ai/post_conversation_settings_req.rbs +0 -17
@@ -52,7 +52,7 @@ module Telnyx
52
52
  }
53
53
 
54
54
  type transcription_engine =
55
- :Google | :Telnyx | :Deepgram | :Azure | :A | :B
55
+ :Google | :Telnyx | :Deepgram | :Azure | :xAI | :AssemblyAI | :A | :B
56
56
 
57
57
  module TranscriptionEngine
58
58
  extend Telnyx::Internal::Type::Enum
@@ -61,6 +61,8 @@ module Telnyx
61
61
  TELNYX: :Telnyx
62
62
  DEEPGRAM: :Deepgram
63
63
  AZURE: :Azure
64
+ X_AI: :xAI
65
+ ASSEMBLY_AI: :AssemblyAI
64
66
  A: :A
65
67
  B: :B
66
68
 
@@ -71,6 +73,8 @@ module Telnyx
71
73
  Telnyx::Calls::TranscriptionEngineGoogleConfig
72
74
  | Telnyx::Calls::TranscriptionEngineTelnyxConfig
73
75
  | Telnyx::Calls::TranscriptionEngineAzureConfig
76
+ | Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI
77
+ | Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI
74
78
  | Telnyx::Calls::TranscriptionEngineAConfig
75
79
  | Telnyx::Calls::TranscriptionEngineBConfig
76
80
  | Telnyx::Calls::DeepgramNova2Config
@@ -79,6 +83,188 @@ module Telnyx
79
83
  module TranscriptionEngineConfig
80
84
  extend Telnyx::Internal::Type::Union
81
85
 
86
+ type xai =
87
+ {
88
+ interim_results: bool,
89
+ language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::language,
90
+ transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_engine,
91
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_model
92
+ }
93
+
94
+ class XAI < Telnyx::Internal::Type::BaseModel
95
+ attr_reader interim_results: bool?
96
+
97
+ def interim_results=: (bool) -> bool
98
+
99
+ attr_reader language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::language?
100
+
101
+ def language=: (
102
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::language
103
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::language
104
+
105
+ attr_reader transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_engine?
106
+
107
+ def transcription_engine=: (
108
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_engine
109
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_engine
110
+
111
+ attr_reader transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_model?
112
+
113
+ def transcription_model=: (
114
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_model
115
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_model
116
+
117
+ def initialize: (
118
+ ?interim_results: bool,
119
+ ?language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::language,
120
+ ?transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_engine,
121
+ ?transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_model
122
+ ) -> void
123
+
124
+ def to_hash: -> {
125
+ interim_results: bool,
126
+ language: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::language,
127
+ transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_engine,
128
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_model
129
+ }
130
+
131
+ type language =
132
+ :ar
133
+ | :cs
134
+ | :da
135
+ | :de
136
+ | :en
137
+ | :es
138
+ | :fa
139
+ | :fil
140
+ | :fr
141
+ | :hi
142
+ | :id
143
+ | :it
144
+ | :ja
145
+ | :ko
146
+ | :mk
147
+ | :ms
148
+ | :nl
149
+ | :pl
150
+ | :pt
151
+ | :ro
152
+ | :ru
153
+ | :sv
154
+ | :th
155
+ | :tr
156
+ | :vi
157
+
158
+ module Language
159
+ extend Telnyx::Internal::Type::Enum
160
+
161
+ AR: :ar
162
+ CS: :cs
163
+ DA: :da
164
+ DE: :de
165
+ EN: :en
166
+ ES: :es
167
+ FA: :fa
168
+ FIL: :fil
169
+ FR: :fr
170
+ HI: :hi
171
+ ID: :id
172
+ IT: :it
173
+ JA: :ja
174
+ KO: :ko
175
+ MK: :mk
176
+ MS: :ms
177
+ NL: :nl
178
+ PL: :pl
179
+ PT: :pt
180
+ RO: :ro
181
+ RU: :ru
182
+ SV: :sv
183
+ TH: :th
184
+ TR: :tr
185
+ VI: :vi
186
+
187
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::language]
188
+ end
189
+
190
+ type transcription_engine = :xAI
191
+
192
+ module TranscriptionEngine
193
+ extend Telnyx::Internal::Type::Enum
194
+
195
+ X_AI: :xAI
196
+
197
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_engine]
198
+ end
199
+
200
+ type transcription_model = :"xai/grok-stt"
201
+
202
+ module TranscriptionModel
203
+ extend Telnyx::Internal::Type::Enum
204
+
205
+ XAI_GROK_STT: :"xai/grok-stt"
206
+
207
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::XAI::transcription_model]
208
+ end
209
+ end
210
+
211
+ type assembly_ai =
212
+ {
213
+ interim_results: bool,
214
+ transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_engine,
215
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_model
216
+ }
217
+
218
+ class AssemblyAI < Telnyx::Internal::Type::BaseModel
219
+ attr_reader interim_results: bool?
220
+
221
+ def interim_results=: (bool) -> bool
222
+
223
+ attr_reader transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_engine?
224
+
225
+ def transcription_engine=: (
226
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_engine
227
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_engine
228
+
229
+ attr_reader transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_model?
230
+
231
+ def transcription_model=: (
232
+ Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_model
233
+ ) -> Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_model
234
+
235
+ def initialize: (
236
+ ?interim_results: bool,
237
+ ?transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_engine,
238
+ ?transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_model
239
+ ) -> void
240
+
241
+ def to_hash: -> {
242
+ interim_results: bool,
243
+ transcription_engine: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_engine,
244
+ transcription_model: Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_model
245
+ }
246
+
247
+ type transcription_engine = :AssemblyAI
248
+
249
+ module TranscriptionEngine
250
+ extend Telnyx::Internal::Type::Enum
251
+
252
+ ASSEMBLY_AI: :AssemblyAI
253
+
254
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_engine]
255
+ end
256
+
257
+ type transcription_model = :"assemblyai/universal-streaming"
258
+
259
+ module TranscriptionModel
260
+ extend Telnyx::Internal::Type::Enum
261
+
262
+ ASSEMBLYAI_UNIVERSAL_STREAMING: :"assemblyai/universal-streaming"
263
+
264
+ def self?.values: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::AssemblyAI::transcription_model]
265
+ end
266
+ end
267
+
82
268
  def self?.variants: -> ::Array[Telnyx::Models::Calls::TranscriptionStartRequest::transcription_engine_config]
83
269
  end
84
270
  end
@@ -15,24 +15,30 @@ module Telnyx
15
15
  assistant_id: String,
16
16
  ?description: String,
17
17
  ?dynamic_variables: ::Hash[Symbol, top],
18
+ ?dynamic_variables_webhook_timeout_ms: Integer,
18
19
  ?dynamic_variables_webhook_url: String,
19
20
  ?enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
20
- ?external_llm: Telnyx::AI::ExternalLlmReq,
21
- ?fallback_config: Telnyx::AI::FallbackConfigReq,
21
+ ?external_llm: Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm,
22
+ ?fallback_config: Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig,
22
23
  ?greeting: String,
23
24
  ?insight_settings: Telnyx::AI::InsightSettings,
24
25
  ?instructions: String,
26
+ ?integrations: ::Array[Telnyx::AI::Assistants::UpdateAssistant::Integration],
27
+ ?interruption_settings: Telnyx::AI::Assistants::UpdateAssistant::InterruptionSettings,
25
28
  ?llm_api_key_ref: String,
29
+ ?mcp_servers: ::Array[Telnyx::AI::Assistants::UpdateAssistant::McpServer],
26
30
  ?messaging_settings: Telnyx::AI::MessagingSettings,
27
31
  ?model: String,
28
32
  ?name: String,
29
33
  ?observability_settings: Telnyx::AI::ObservabilityReq,
30
- ?post_conversation_settings: Telnyx::AI::PostConversationSettingsReq,
34
+ ?post_conversation_settings: Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings,
31
35
  ?privacy_settings: Telnyx::AI::PrivacySettings,
36
+ ?tags: ::Array[String],
32
37
  ?telephony_settings: Telnyx::AI::TelephonySettings,
33
38
  ?tool_ids: ::Array[String],
34
39
  ?tools: ::Array[Telnyx::Models::AI::assistant_tool],
35
40
  ?transcription: Telnyx::AI::TranscriptionSettings,
41
+ ?version_name: String,
36
42
  ?voice_settings: Telnyx::AI::VoiceSettings,
37
43
  ?widget_settings: Telnyx::AI::WidgetSettings,
38
44
  ?request_options: Telnyx::request_opts
@@ -16,21 +16,26 @@ module Telnyx
16
16
 
17
17
  def create: (
18
18
  instructions: String,
19
- model: String,
20
19
  name: String,
21
20
  ?description: String,
22
21
  ?dynamic_variables: ::Hash[Symbol, top],
22
+ ?dynamic_variables_webhook_timeout_ms: Integer,
23
23
  ?dynamic_variables_webhook_url: String,
24
24
  ?enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
25
- ?external_llm: Telnyx::AI::ExternalLlmReq,
26
- ?fallback_config: Telnyx::AI::FallbackConfigReq,
25
+ ?external_llm: Telnyx::AI::AssistantCreateParams::ExternalLlm,
26
+ ?fallback_config: Telnyx::AI::AssistantCreateParams::FallbackConfig,
27
27
  ?greeting: String,
28
28
  ?insight_settings: Telnyx::AI::InsightSettings,
29
+ ?integrations: ::Array[Telnyx::AI::AssistantCreateParams::Integration],
30
+ ?interruption_settings: Telnyx::AI::AssistantCreateParams::InterruptionSettings,
29
31
  ?llm_api_key_ref: String,
32
+ ?mcp_servers: ::Array[Telnyx::AI::AssistantCreateParams::McpServer],
30
33
  ?messaging_settings: Telnyx::AI::MessagingSettings,
34
+ ?model: String,
31
35
  ?observability_settings: Telnyx::AI::ObservabilityReq,
32
- ?post_conversation_settings: Telnyx::AI::PostConversationSettingsReq,
36
+ ?post_conversation_settings: Telnyx::AI::AssistantCreateParams::PostConversationSettings,
33
37
  ?privacy_settings: Telnyx::AI::PrivacySettings,
38
+ ?tags: ::Array[String],
34
39
  ?telephony_settings: Telnyx::AI::TelephonySettings,
35
40
  ?tool_ids: ::Array[String],
36
41
  ?tools: ::Array[Telnyx::Models::AI::assistant_tool],
@@ -53,25 +58,31 @@ module Telnyx
53
58
  String assistant_id,
54
59
  ?description: String,
55
60
  ?dynamic_variables: ::Hash[Symbol, top],
61
+ ?dynamic_variables_webhook_timeout_ms: Integer,
56
62
  ?dynamic_variables_webhook_url: String,
57
63
  ?enabled_features: ::Array[Telnyx::Models::AI::enabled_features],
58
- ?external_llm: Telnyx::AI::ExternalLlmReq,
59
- ?fallback_config: Telnyx::AI::FallbackConfigReq,
64
+ ?external_llm: Telnyx::AI::AssistantUpdateParams::ExternalLlm,
65
+ ?fallback_config: Telnyx::AI::AssistantUpdateParams::FallbackConfig,
60
66
  ?greeting: String,
61
67
  ?insight_settings: Telnyx::AI::InsightSettings,
62
68
  ?instructions: String,
69
+ ?integrations: ::Array[Telnyx::AI::AssistantUpdateParams::Integration],
70
+ ?interruption_settings: Telnyx::AI::AssistantUpdateParams::InterruptionSettings,
63
71
  ?llm_api_key_ref: String,
72
+ ?mcp_servers: ::Array[Telnyx::AI::AssistantUpdateParams::McpServer],
64
73
  ?messaging_settings: Telnyx::AI::MessagingSettings,
65
74
  ?model: String,
66
75
  ?name: String,
67
76
  ?observability_settings: Telnyx::AI::ObservabilityReq,
68
- ?post_conversation_settings: Telnyx::AI::PostConversationSettingsReq,
77
+ ?post_conversation_settings: Telnyx::AI::AssistantUpdateParams::PostConversationSettings,
69
78
  ?privacy_settings: Telnyx::AI::PrivacySettings,
70
79
  ?promote_to_main: bool,
80
+ ?tags: ::Array[String],
71
81
  ?telephony_settings: Telnyx::AI::TelephonySettings,
72
82
  ?tool_ids: ::Array[String],
73
83
  ?tools: ::Array[Telnyx::Models::AI::assistant_tool],
74
84
  ?transcription: Telnyx::AI::TranscriptionSettings,
85
+ ?version_name: String,
75
86
  ?voice_settings: Telnyx::AI::VoiceSettings,
76
87
  ?widget_settings: Telnyx::AI::WidgetSettings,
77
88
  ?request_options: Telnyx::request_opts
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.91.0
4
+ version: 5.93.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Telnyx
@@ -273,10 +273,6 @@ files:
273
273
  - lib/telnyx/models/ai/embeddings/bucket_retrieve_params.rb
274
274
  - lib/telnyx/models/ai/embeddings/bucket_retrieve_response.rb
275
275
  - lib/telnyx/models/ai/enabled_features.rb
276
- - lib/telnyx/models/ai/external_llm.rb
277
- - lib/telnyx/models/ai/external_llm_req.rb
278
- - lib/telnyx/models/ai/fallback_config.rb
279
- - lib/telnyx/models/ai/fallback_config_req.rb
280
276
  - lib/telnyx/models/ai/fine_tuning/fine_tuning_job.rb
281
277
  - lib/telnyx/models/ai/fine_tuning/job_cancel_params.rb
282
278
  - lib/telnyx/models/ai/fine_tuning/job_create_params.rb
@@ -392,8 +388,6 @@ files:
392
388
  - lib/telnyx/models/ai/openai/embedding_create_embeddings_response.rb
393
389
  - lib/telnyx/models/ai/openai/embedding_list_embedding_models_params.rb
394
390
  - lib/telnyx/models/ai/openai/embedding_list_embedding_models_response.rb
395
- - lib/telnyx/models/ai/post_conversation_settings.rb
396
- - lib/telnyx/models/ai/post_conversation_settings_req.rb
397
391
  - lib/telnyx/models/ai/privacy_settings.rb
398
392
  - lib/telnyx/models/ai/recursive_cluster.rb
399
393
  - lib/telnyx/models/ai/retrieval_tool.rb
@@ -2964,10 +2958,6 @@ files:
2964
2958
  - rbi/telnyx/models/ai/embeddings/bucket_retrieve_params.rbi
2965
2959
  - rbi/telnyx/models/ai/embeddings/bucket_retrieve_response.rbi
2966
2960
  - rbi/telnyx/models/ai/enabled_features.rbi
2967
- - rbi/telnyx/models/ai/external_llm.rbi
2968
- - rbi/telnyx/models/ai/external_llm_req.rbi
2969
- - rbi/telnyx/models/ai/fallback_config.rbi
2970
- - rbi/telnyx/models/ai/fallback_config_req.rbi
2971
2961
  - rbi/telnyx/models/ai/fine_tuning/fine_tuning_job.rbi
2972
2962
  - rbi/telnyx/models/ai/fine_tuning/job_cancel_params.rbi
2973
2963
  - rbi/telnyx/models/ai/fine_tuning/job_create_params.rbi
@@ -3083,8 +3073,6 @@ files:
3083
3073
  - rbi/telnyx/models/ai/openai/embedding_create_embeddings_response.rbi
3084
3074
  - rbi/telnyx/models/ai/openai/embedding_list_embedding_models_params.rbi
3085
3075
  - rbi/telnyx/models/ai/openai/embedding_list_embedding_models_response.rbi
3086
- - rbi/telnyx/models/ai/post_conversation_settings.rbi
3087
- - rbi/telnyx/models/ai/post_conversation_settings_req.rbi
3088
3076
  - rbi/telnyx/models/ai/privacy_settings.rbi
3089
3077
  - rbi/telnyx/models/ai/recursive_cluster.rbi
3090
3078
  - rbi/telnyx/models/ai/retrieval_tool.rbi
@@ -5646,10 +5634,6 @@ files:
5646
5634
  - sig/telnyx/models/ai/embeddings/bucket_retrieve_params.rbs
5647
5635
  - sig/telnyx/models/ai/embeddings/bucket_retrieve_response.rbs
5648
5636
  - sig/telnyx/models/ai/enabled_features.rbs
5649
- - sig/telnyx/models/ai/external_llm.rbs
5650
- - sig/telnyx/models/ai/external_llm_req.rbs
5651
- - sig/telnyx/models/ai/fallback_config.rbs
5652
- - sig/telnyx/models/ai/fallback_config_req.rbs
5653
5637
  - sig/telnyx/models/ai/fine_tuning/fine_tuning_job.rbs
5654
5638
  - sig/telnyx/models/ai/fine_tuning/job_cancel_params.rbs
5655
5639
  - sig/telnyx/models/ai/fine_tuning/job_create_params.rbs
@@ -5765,8 +5749,6 @@ files:
5765
5749
  - sig/telnyx/models/ai/openai/embedding_create_embeddings_response.rbs
5766
5750
  - sig/telnyx/models/ai/openai/embedding_list_embedding_models_params.rbs
5767
5751
  - sig/telnyx/models/ai/openai/embedding_list_embedding_models_response.rbs
5768
- - sig/telnyx/models/ai/post_conversation_settings.rbs
5769
- - sig/telnyx/models/ai/post_conversation_settings_req.rbs
5770
5752
  - sig/telnyx/models/ai/privacy_settings.rbs
5771
5753
  - sig/telnyx/models/ai/recursive_cluster.rbs
5772
5754
  - sig/telnyx/models/ai/retrieval_tool.rbs
@@ -1,87 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module AI
6
- class ExternalLlm < Telnyx::Internal::Type::BaseModel
7
- # @!attribute base_url
8
- # Base URL for the external LLM endpoint.
9
- #
10
- # @return [String]
11
- required :base_url, String
12
-
13
- # @!attribute model
14
- # Model identifier to use with the external LLM endpoint.
15
- #
16
- # @return [String]
17
- required :model, String
18
-
19
- # @!attribute authentication_method
20
- # Authentication method used when connecting to the external LLM endpoint.
21
- #
22
- # @return [Symbol, Telnyx::Models::AI::ExternalLlm::AuthenticationMethod, nil]
23
- optional :authentication_method, enum: -> { Telnyx::AI::ExternalLlm::AuthenticationMethod }
24
-
25
- # @!attribute certificate_ref
26
- # Integration secret identifier for the client certificate used with certificate
27
- # authentication.
28
- #
29
- # @return [String, nil]
30
- optional :certificate_ref, String
31
-
32
- # @!attribute forward_metadata
33
- # When enabled, Telnyx forwards the assistant's dynamic variables to the external
34
- # LLM endpoint. Defaults to false. The chat completion request includes a
35
- # top-level `extra_metadata` object when dynamic variables are available. For
36
- # example:
37
- # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
38
- #
39
- # @return [Boolean, nil]
40
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
41
-
42
- # @!attribute llm_api_key_ref
43
- # Integration secret identifier for the external LLM API key.
44
- #
45
- # @return [String, nil]
46
- optional :llm_api_key_ref, String
47
-
48
- # @!attribute token_retrieval_url
49
- # URL used to retrieve an access token when certificate authentication is enabled.
50
- #
51
- # @return [String, nil]
52
- optional :token_retrieval_url, String
53
-
54
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
55
- # Some parameter documentations has been truncated, see
56
- # {Telnyx::Models::AI::ExternalLlm} for more details.
57
- #
58
- # @param base_url [String] Base URL for the external LLM endpoint.
59
- #
60
- # @param model [String] Model identifier to use with the external LLM endpoint.
61
- #
62
- # @param authentication_method [Symbol, Telnyx::Models::AI::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
63
- #
64
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
65
- #
66
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
67
- #
68
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
69
- #
70
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
71
-
72
- # Authentication method used when connecting to the external LLM endpoint.
73
- #
74
- # @see Telnyx::Models::AI::ExternalLlm#authentication_method
75
- module AuthenticationMethod
76
- extend Telnyx::Internal::Type::Enum
77
-
78
- TOKEN = :token
79
- CERTIFICATE = :certificate
80
-
81
- # @!method self.values
82
- # @return [Array<Symbol>]
83
- end
84
- end
85
- end
86
- end
87
- end
@@ -1,87 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module AI
6
- class ExternalLlmReq < Telnyx::Internal::Type::BaseModel
7
- # @!attribute base_url
8
- # Base URL for the external LLM endpoint.
9
- #
10
- # @return [String]
11
- required :base_url, String
12
-
13
- # @!attribute model
14
- # Model identifier to use with the external LLM endpoint.
15
- #
16
- # @return [String]
17
- required :model, String
18
-
19
- # @!attribute authentication_method
20
- # Authentication method used when connecting to the external LLM endpoint.
21
- #
22
- # @return [Symbol, Telnyx::Models::AI::ExternalLlmReq::AuthenticationMethod, nil]
23
- optional :authentication_method, enum: -> { Telnyx::AI::ExternalLlmReq::AuthenticationMethod }
24
-
25
- # @!attribute certificate_ref
26
- # Integration secret identifier for the client certificate used with certificate
27
- # authentication.
28
- #
29
- # @return [String, nil]
30
- optional :certificate_ref, String
31
-
32
- # @!attribute forward_metadata
33
- # When enabled, Telnyx forwards the assistant's dynamic variables to the external
34
- # LLM endpoint. Defaults to false. The chat completion request includes a
35
- # top-level `extra_metadata` object when dynamic variables are available. For
36
- # example:
37
- # `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
38
- #
39
- # @return [Boolean, nil]
40
- optional :forward_metadata, Telnyx::Internal::Type::Boolean
41
-
42
- # @!attribute llm_api_key_ref
43
- # Integration secret identifier for the external LLM API key.
44
- #
45
- # @return [String, nil]
46
- optional :llm_api_key_ref, String
47
-
48
- # @!attribute token_retrieval_url
49
- # URL used to retrieve an access token when certificate authentication is enabled.
50
- #
51
- # @return [String, nil]
52
- optional :token_retrieval_url, String
53
-
54
- # @!method initialize(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
55
- # Some parameter documentations has been truncated, see
56
- # {Telnyx::Models::AI::ExternalLlmReq} for more details.
57
- #
58
- # @param base_url [String] Base URL for the external LLM endpoint.
59
- #
60
- # @param model [String] Model identifier to use with the external LLM endpoint.
61
- #
62
- # @param authentication_method [Symbol, Telnyx::Models::AI::ExternalLlmReq::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
63
- #
64
- # @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
65
- #
66
- # @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
67
- #
68
- # @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
69
- #
70
- # @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
71
-
72
- # Authentication method used when connecting to the external LLM endpoint.
73
- #
74
- # @see Telnyx::Models::AI::ExternalLlmReq#authentication_method
75
- module AuthenticationMethod
76
- extend Telnyx::Internal::Type::Enum
77
-
78
- TOKEN = :token
79
- CERTIFICATE = :certificate
80
-
81
- # @!method self.values
82
- # @return [Array<Symbol>]
83
- end
84
- end
85
- end
86
- end
87
- end
@@ -1,37 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module AI
6
- class FallbackConfig < Telnyx::Internal::Type::BaseModel
7
- # @!attribute external_llm
8
- #
9
- # @return [Telnyx::Models::AI::ExternalLlm, nil]
10
- optional :external_llm, -> { Telnyx::AI::ExternalLlm }
11
-
12
- # @!attribute llm_api_key_ref
13
- # Integration secret identifier for the fallback model API key.
14
- #
15
- # @return [String, nil]
16
- optional :llm_api_key_ref, String
17
-
18
- # @!attribute model
19
- # Fallback Telnyx-hosted model to use when the primary LLM provider is
20
- # unavailable.
21
- #
22
- # @return [String, nil]
23
- optional :model, String
24
-
25
- # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
26
- # Some parameter documentations has been truncated, see
27
- # {Telnyx::Models::AI::FallbackConfig} for more details.
28
- #
29
- # @param external_llm [Telnyx::Models::AI::ExternalLlm]
30
- #
31
- # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
32
- #
33
- # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
34
- end
35
- end
36
- end
37
- end
@@ -1,37 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module AI
6
- class FallbackConfigReq < Telnyx::Internal::Type::BaseModel
7
- # @!attribute external_llm
8
- #
9
- # @return [Telnyx::Models::AI::ExternalLlmReq, nil]
10
- optional :external_llm, -> { Telnyx::AI::ExternalLlmReq }
11
-
12
- # @!attribute llm_api_key_ref
13
- # Integration secret identifier for the fallback model API key.
14
- #
15
- # @return [String, nil]
16
- optional :llm_api_key_ref, String
17
-
18
- # @!attribute model
19
- # Fallback Telnyx-hosted model to use when the primary LLM provider is
20
- # unavailable.
21
- #
22
- # @return [String, nil]
23
- optional :model, String
24
-
25
- # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
26
- # Some parameter documentations has been truncated, see
27
- # {Telnyx::Models::AI::FallbackConfigReq} for more details.
28
- #
29
- # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
30
- #
31
- # @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
32
- #
33
- # @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
34
- end
35
- end
36
- end
37
- end
@@ -1,30 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Telnyx
4
- module Models
5
- module AI
6
- class PostConversationSettings < Telnyx::Internal::Type::BaseModel
7
- # @!attribute enabled
8
- # Whether post-conversation processing is enabled. When true, the assistant will
9
- # be invoked after the conversation ends to perform any final tool calls. Defaults
10
- # to false.
11
- #
12
- # @return [Boolean, nil]
13
- optional :enabled, Telnyx::Internal::Type::Boolean
14
-
15
- # @!method initialize(enabled: nil)
16
- # Some parameter documentations has been truncated, see
17
- # {Telnyx::Models::AI::PostConversationSettings} for more details.
18
- #
19
- # Configuration for post-conversation processing. When enabled, the assistant
20
- # receives one additional LLM turn after the conversation ends, allowing it to
21
- # execute tool calls such as logging to a CRM or sending a summary. The assistant
22
- # can execute multiple parallel or sequential tools during this phase.
23
- # Telephony-control tools (e.g. hangup, transfer) are unavailable
24
- # post-conversation. Beta feature.
25
- #
26
- # @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
27
- end
28
- end
29
- end
30
- end