vellum_ai 0.14.88 → 1.0.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/lib/requests.rb +27 -8
- data/lib/vellum_ai/ad_hoc/client.rb +18 -8
- data/lib/vellum_ai/container_images/client.rb +46 -6
- data/lib/vellum_ai/deployments/client.rb +82 -2
- data/lib/vellum_ai/document_indexes/client.rb +88 -8
- data/lib/vellum_ai/documents/client.rb +50 -14
- data/lib/vellum_ai/folder_entities/client.rb +20 -0
- data/lib/vellum_ai/metric_definitions/client.rb +22 -2
- data/lib/vellum_ai/ml_models/client.rb +10 -0
- data/lib/vellum_ai/organizations/client.rb +10 -0
- data/lib/vellum_ai/prompts/client.rb +22 -2
- data/lib/vellum_ai/release_reviews/client.rb +10 -0
- data/lib/vellum_ai/sandboxes/client.rb +32 -10
- data/lib/vellum_ai/test_suite_runs/client.rb +30 -0
- data/lib/vellum_ai/test_suites/client.rb +32 -2
- data/lib/vellum_ai/workflow_deployments/client.rb +80 -0
- data/lib/vellum_ai/workflow_sandboxes/client.rb +20 -0
- data/lib/vellum_ai/workflows/client.rb +20 -14
- data/lib/vellum_ai/workspace_secrets/client.rb +20 -0
- data/lib/vellum_ai/workspaces/client.rb +10 -0
- data/lib/vellum_ai.rb +109 -24
- metadata +2 -2
@@ -53,6 +53,11 @@ module Vellum
|
|
53
53
|
unless request_options&.api_key.nil?
|
54
54
|
req.headers["X-API-KEY"] = request_options.api_key
|
55
55
|
end
|
56
|
+
unless request_options&.api_version.nil?
|
57
|
+
req.headers["X-API-Version"] = request_options.api_version
|
58
|
+
else
|
59
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
60
|
+
end
|
56
61
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
57
62
|
req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "search": search, "status": status }.compact
|
58
63
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -83,9 +88,9 @@ end
|
|
83
88
|
# api_key: "YOUR_API_KEY"
|
84
89
|
# )
|
85
90
|
# api.document_indexes.create(
|
86
|
-
# label: "
|
87
|
-
# name: "
|
88
|
-
# indexing_config: { vectorizer: {
|
91
|
+
# label: "x",
|
92
|
+
# name: "x",
|
93
|
+
# indexing_config: { vectorizer: { config: { }, model_name: "text-embedding-3-small" } }
|
89
94
|
# )
|
90
95
|
def create(label:, name:, status: nil, indexing_config:, copy_documents_from_index_id: nil, request_options: nil)
|
91
96
|
response = @request_client.conn.post do | req |
|
@@ -95,6 +100,11 @@ end
|
|
95
100
|
unless request_options&.api_key.nil?
|
96
101
|
req.headers["X-API-KEY"] = request_options.api_key
|
97
102
|
end
|
103
|
+
unless request_options&.api_version.nil?
|
104
|
+
req.headers["X-API-Version"] = request_options.api_version
|
105
|
+
else
|
106
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
107
|
+
end
|
98
108
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
99
109
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
100
110
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -124,6 +134,11 @@ end
|
|
124
134
|
unless request_options&.api_key.nil?
|
125
135
|
req.headers["X-API-KEY"] = request_options.api_key
|
126
136
|
end
|
137
|
+
unless request_options&.api_version.nil?
|
138
|
+
req.headers["X-API-Version"] = request_options.api_version
|
139
|
+
else
|
140
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
141
|
+
end
|
127
142
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
128
143
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
129
144
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -150,7 +165,7 @@ end
|
|
150
165
|
# environment: Vellum::Environment::PRODUCTION,
|
151
166
|
# api_key: "YOUR_API_KEY"
|
152
167
|
# )
|
153
|
-
# api.document_indexes.update(id: "id", label: "
|
168
|
+
# api.document_indexes.update(id: "id", label: "x")
|
154
169
|
def update(id:, label:, status: nil, request_options: nil)
|
155
170
|
response = @request_client.conn.put do | req |
|
156
171
|
unless request_options&.timeout_in_seconds.nil?
|
@@ -159,6 +174,11 @@ end
|
|
159
174
|
unless request_options&.api_key.nil?
|
160
175
|
req.headers["X-API-KEY"] = request_options.api_key
|
161
176
|
end
|
177
|
+
unless request_options&.api_version.nil?
|
178
|
+
req.headers["X-API-Version"] = request_options.api_version
|
179
|
+
else
|
180
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
181
|
+
end
|
162
182
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
163
183
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
164
184
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -188,6 +208,11 @@ end
|
|
188
208
|
unless request_options&.api_key.nil?
|
189
209
|
req.headers["X-API-KEY"] = request_options.api_key
|
190
210
|
end
|
211
|
+
unless request_options&.api_version.nil?
|
212
|
+
req.headers["X-API-Version"] = request_options.api_version
|
213
|
+
else
|
214
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
215
|
+
end
|
191
216
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
192
217
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
193
218
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -222,6 +247,11 @@ end
|
|
222
247
|
unless request_options&.api_key.nil?
|
223
248
|
req.headers["X-API-KEY"] = request_options.api_key
|
224
249
|
end
|
250
|
+
unless request_options&.api_version.nil?
|
251
|
+
req.headers["X-API-Version"] = request_options.api_version
|
252
|
+
else
|
253
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
254
|
+
end
|
225
255
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
226
256
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
227
257
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -254,6 +284,11 @@ end
|
|
254
284
|
unless request_options&.api_key.nil?
|
255
285
|
req.headers["X-API-KEY"] = request_options.api_key
|
256
286
|
end
|
287
|
+
unless request_options&.api_version.nil?
|
288
|
+
req.headers["X-API-Version"] = request_options.api_version
|
289
|
+
else
|
290
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
291
|
+
end
|
257
292
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
258
293
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
259
294
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -287,6 +322,11 @@ end
|
|
287
322
|
unless request_options&.api_key.nil?
|
288
323
|
req.headers["X-API-KEY"] = request_options.api_key
|
289
324
|
end
|
325
|
+
unless request_options&.api_version.nil?
|
326
|
+
req.headers["X-API-Version"] = request_options.api_version
|
327
|
+
else
|
328
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
329
|
+
end
|
290
330
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
291
331
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
292
332
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -336,6 +376,11 @@ end
|
|
336
376
|
unless request_options&.api_key.nil?
|
337
377
|
req.headers["X-API-KEY"] = request_options.api_key
|
338
378
|
end
|
379
|
+
unless request_options&.api_version.nil?
|
380
|
+
req.headers["X-API-Version"] = request_options.api_version
|
381
|
+
else
|
382
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
383
|
+
end
|
339
384
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
340
385
|
req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "search": search, "status": status }.compact
|
341
386
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -367,9 +412,9 @@ end
|
|
367
412
|
# api_key: "YOUR_API_KEY"
|
368
413
|
# )
|
369
414
|
# api.document_indexes.create(
|
370
|
-
# label: "
|
371
|
-
# name: "
|
372
|
-
# indexing_config: { vectorizer: {
|
415
|
+
# label: "x",
|
416
|
+
# name: "x",
|
417
|
+
# indexing_config: { vectorizer: { config: { }, model_name: "text-embedding-3-small" } }
|
373
418
|
# )
|
374
419
|
def create(label:, name:, status: nil, indexing_config:, copy_documents_from_index_id: nil, request_options: nil)
|
375
420
|
Async do
|
@@ -380,6 +425,11 @@ end
|
|
380
425
|
unless request_options&.api_key.nil?
|
381
426
|
req.headers["X-API-KEY"] = request_options.api_key
|
382
427
|
end
|
428
|
+
unless request_options&.api_version.nil?
|
429
|
+
req.headers["X-API-Version"] = request_options.api_version
|
430
|
+
else
|
431
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
432
|
+
end
|
383
433
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
384
434
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
385
435
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -411,6 +461,11 @@ end
|
|
411
461
|
unless request_options&.api_key.nil?
|
412
462
|
req.headers["X-API-KEY"] = request_options.api_key
|
413
463
|
end
|
464
|
+
unless request_options&.api_version.nil?
|
465
|
+
req.headers["X-API-Version"] = request_options.api_version
|
466
|
+
else
|
467
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
468
|
+
end
|
414
469
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
415
470
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
416
471
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -438,7 +493,7 @@ end
|
|
438
493
|
# environment: Vellum::Environment::PRODUCTION,
|
439
494
|
# api_key: "YOUR_API_KEY"
|
440
495
|
# )
|
441
|
-
# api.document_indexes.update(id: "id", label: "
|
496
|
+
# api.document_indexes.update(id: "id", label: "x")
|
442
497
|
def update(id:, label:, status: nil, request_options: nil)
|
443
498
|
Async do
|
444
499
|
response = @request_client.conn.put do | req |
|
@@ -448,6 +503,11 @@ end
|
|
448
503
|
unless request_options&.api_key.nil?
|
449
504
|
req.headers["X-API-KEY"] = request_options.api_key
|
450
505
|
end
|
506
|
+
unless request_options&.api_version.nil?
|
507
|
+
req.headers["X-API-Version"] = request_options.api_version
|
508
|
+
else
|
509
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
510
|
+
end
|
451
511
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
452
512
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
453
513
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -479,6 +539,11 @@ end
|
|
479
539
|
unless request_options&.api_key.nil?
|
480
540
|
req.headers["X-API-KEY"] = request_options.api_key
|
481
541
|
end
|
542
|
+
unless request_options&.api_version.nil?
|
543
|
+
req.headers["X-API-Version"] = request_options.api_version
|
544
|
+
else
|
545
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
546
|
+
end
|
482
547
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
483
548
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
484
549
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -515,6 +580,11 @@ end
|
|
515
580
|
unless request_options&.api_key.nil?
|
516
581
|
req.headers["X-API-KEY"] = request_options.api_key
|
517
582
|
end
|
583
|
+
unless request_options&.api_version.nil?
|
584
|
+
req.headers["X-API-Version"] = request_options.api_version
|
585
|
+
else
|
586
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
587
|
+
end
|
518
588
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
519
589
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
520
590
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -549,6 +619,11 @@ end
|
|
549
619
|
unless request_options&.api_key.nil?
|
550
620
|
req.headers["X-API-KEY"] = request_options.api_key
|
551
621
|
end
|
622
|
+
unless request_options&.api_version.nil?
|
623
|
+
req.headers["X-API-Version"] = request_options.api_version
|
624
|
+
else
|
625
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
626
|
+
end
|
552
627
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
553
628
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
554
629
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -584,6 +659,11 @@ end
|
|
584
659
|
unless request_options&.api_key.nil?
|
585
660
|
req.headers["X-API-KEY"] = request_options.api_key
|
586
661
|
end
|
662
|
+
unless request_options&.api_version.nil?
|
663
|
+
req.headers["X-API-Version"] = request_options.api_version
|
664
|
+
else
|
665
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
666
|
+
end
|
587
667
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
588
668
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
589
669
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -49,6 +49,11 @@ module Vellum
|
|
49
49
|
unless request_options&.api_key.nil?
|
50
50
|
req.headers["X-API-KEY"] = request_options.api_key
|
51
51
|
end
|
52
|
+
unless request_options&.api_version.nil?
|
53
|
+
req.headers["X-API-Version"] = request_options.api_version
|
54
|
+
else
|
55
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
56
|
+
end
|
52
57
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
53
58
|
req.params = { **(request_options&.additional_query_parameters || {}), "document_index_id": document_index_id, "limit": limit, "offset": offset, "ordering": ordering, "search": search }.compact
|
54
59
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -79,6 +84,11 @@ end
|
|
79
84
|
unless request_options&.api_key.nil?
|
80
85
|
req.headers["X-API-KEY"] = request_options.api_key
|
81
86
|
end
|
87
|
+
unless request_options&.api_version.nil?
|
88
|
+
req.headers["X-API-Version"] = request_options.api_version
|
89
|
+
else
|
90
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
91
|
+
end
|
82
92
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
83
93
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
84
94
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -111,6 +121,11 @@ end
|
|
111
121
|
unless request_options&.api_key.nil?
|
112
122
|
req.headers["X-API-KEY"] = request_options.api_key
|
113
123
|
end
|
124
|
+
unless request_options&.api_version.nil?
|
125
|
+
req.headers["X-API-Version"] = request_options.api_version
|
126
|
+
else
|
127
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
128
|
+
end
|
114
129
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
115
130
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
116
131
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -150,6 +165,11 @@ end
|
|
150
165
|
unless request_options&.api_key.nil?
|
151
166
|
req.headers["X-API-KEY"] = request_options.api_key
|
152
167
|
end
|
168
|
+
unless request_options&.api_version.nil?
|
169
|
+
req.headers["X-API-Version"] = request_options.api_version
|
170
|
+
else
|
171
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
172
|
+
end
|
153
173
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
154
174
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
155
175
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -175,13 +195,6 @@ end
|
|
175
195
|
# that you'd like to filter upon later.
|
176
196
|
# @param request_options [Vellum::RequestOptions]
|
177
197
|
# @return [Vellum::UploadDocumentResponse]
|
178
|
-
# @example
|
179
|
-
# api = Vellum::Client.new(
|
180
|
-
# base_url: "https://api.example.com",
|
181
|
-
# environment: Vellum::Environment::PRODUCTION,
|
182
|
-
# api_key: "YOUR_API_KEY"
|
183
|
-
# )
|
184
|
-
# api.documents.upload(contents: my_file.txt)
|
185
198
|
def upload(add_to_index_names: nil, external_id: nil, label:, contents:, keywords: nil, metadata: nil, request_options: nil)
|
186
199
|
response = @request_client.conn.post do | req |
|
187
200
|
unless request_options&.timeout_in_seconds.nil?
|
@@ -190,6 +203,11 @@ end
|
|
190
203
|
unless request_options&.api_key.nil?
|
191
204
|
req.headers["X-API-KEY"] = request_options.api_key
|
192
205
|
end
|
206
|
+
unless request_options&.api_version.nil?
|
207
|
+
req.headers["X-API-Version"] = request_options.api_version
|
208
|
+
else
|
209
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
210
|
+
end
|
193
211
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
194
212
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
195
213
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -237,6 +255,11 @@ end
|
|
237
255
|
unless request_options&.api_key.nil?
|
238
256
|
req.headers["X-API-KEY"] = request_options.api_key
|
239
257
|
end
|
258
|
+
unless request_options&.api_version.nil?
|
259
|
+
req.headers["X-API-Version"] = request_options.api_version
|
260
|
+
else
|
261
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
262
|
+
end
|
240
263
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
241
264
|
req.params = { **(request_options&.additional_query_parameters || {}), "document_index_id": document_index_id, "limit": limit, "offset": offset, "ordering": ordering, "search": search }.compact
|
242
265
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -269,6 +292,11 @@ end
|
|
269
292
|
unless request_options&.api_key.nil?
|
270
293
|
req.headers["X-API-KEY"] = request_options.api_key
|
271
294
|
end
|
295
|
+
unless request_options&.api_version.nil?
|
296
|
+
req.headers["X-API-Version"] = request_options.api_version
|
297
|
+
else
|
298
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
299
|
+
end
|
272
300
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
273
301
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
274
302
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -303,6 +331,11 @@ end
|
|
303
331
|
unless request_options&.api_key.nil?
|
304
332
|
req.headers["X-API-KEY"] = request_options.api_key
|
305
333
|
end
|
334
|
+
unless request_options&.api_version.nil?
|
335
|
+
req.headers["X-API-Version"] = request_options.api_version
|
336
|
+
else
|
337
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
338
|
+
end
|
306
339
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
307
340
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
308
341
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -344,6 +377,11 @@ end
|
|
344
377
|
unless request_options&.api_key.nil?
|
345
378
|
req.headers["X-API-KEY"] = request_options.api_key
|
346
379
|
end
|
380
|
+
unless request_options&.api_version.nil?
|
381
|
+
req.headers["X-API-Version"] = request_options.api_version
|
382
|
+
else
|
383
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
384
|
+
end
|
347
385
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
348
386
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
349
387
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -370,13 +408,6 @@ end
|
|
370
408
|
# that you'd like to filter upon later.
|
371
409
|
# @param request_options [Vellum::RequestOptions]
|
372
410
|
# @return [Vellum::UploadDocumentResponse]
|
373
|
-
# @example
|
374
|
-
# api = Vellum::Client.new(
|
375
|
-
# base_url: "https://api.example.com",
|
376
|
-
# environment: Vellum::Environment::PRODUCTION,
|
377
|
-
# api_key: "YOUR_API_KEY"
|
378
|
-
# )
|
379
|
-
# api.documents.upload(contents: my_file.txt)
|
380
411
|
def upload(add_to_index_names: nil, external_id: nil, label:, contents:, keywords: nil, metadata: nil, request_options: nil)
|
381
412
|
Async do
|
382
413
|
response = @request_client.conn.post do | req |
|
@@ -386,6 +417,11 @@ end
|
|
386
417
|
unless request_options&.api_key.nil?
|
387
418
|
req.headers["X-API-KEY"] = request_options.api_key
|
388
419
|
end
|
420
|
+
unless request_options&.api_version.nil?
|
421
|
+
req.headers["X-API-Version"] = request_options.api_version
|
422
|
+
else
|
423
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
424
|
+
end
|
389
425
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
390
426
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
391
427
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -52,6 +52,11 @@ module Vellum
|
|
52
52
|
unless request_options&.api_key.nil?
|
53
53
|
req.headers["X-API-KEY"] = request_options.api_key
|
54
54
|
end
|
55
|
+
unless request_options&.api_version.nil?
|
56
|
+
req.headers["X-API-Version"] = request_options.api_version
|
57
|
+
else
|
58
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
59
|
+
end
|
55
60
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
56
61
|
req.params = { **(request_options&.additional_query_parameters || {}), "entity_status": entity_status, "limit": limit, "offset": offset, "ordering": ordering, "parent_folder_id": parent_folder_id }.compact
|
57
62
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -90,6 +95,11 @@ end
|
|
90
95
|
unless request_options&.api_key.nil?
|
91
96
|
req.headers["X-API-KEY"] = request_options.api_key
|
92
97
|
end
|
98
|
+
unless request_options&.api_version.nil?
|
99
|
+
req.headers["X-API-Version"] = request_options.api_version
|
100
|
+
else
|
101
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
102
|
+
end
|
93
103
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
94
104
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
95
105
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -145,6 +155,11 @@ end
|
|
145
155
|
unless request_options&.api_key.nil?
|
146
156
|
req.headers["X-API-KEY"] = request_options.api_key
|
147
157
|
end
|
158
|
+
unless request_options&.api_version.nil?
|
159
|
+
req.headers["X-API-Version"] = request_options.api_version
|
160
|
+
else
|
161
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
162
|
+
end
|
148
163
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
149
164
|
req.params = { **(request_options&.additional_query_parameters || {}), "entity_status": entity_status, "limit": limit, "offset": offset, "ordering": ordering, "parent_folder_id": parent_folder_id }.compact
|
150
165
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -185,6 +200,11 @@ end
|
|
185
200
|
unless request_options&.api_key.nil?
|
186
201
|
req.headers["X-API-KEY"] = request_options.api_key
|
187
202
|
end
|
203
|
+
unless request_options&.api_version.nil?
|
204
|
+
req.headers["X-API-Version"] = request_options.api_version
|
205
|
+
else
|
206
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
207
|
+
end
|
188
208
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
189
209
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
190
210
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -29,7 +29,7 @@ module Vellum
|
|
29
29
|
# environment: Vellum::Environment::PRODUCTION,
|
30
30
|
# api_key: "YOUR_API_KEY"
|
31
31
|
# )
|
32
|
-
# api.metric_definitions.execute_metric_definition(id: "id", inputs: [{ name: "name", type: "STRING", value: "value" }])
|
32
|
+
# api.metric_definitions.execute_metric_definition(id: "id", inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
|
33
33
|
def execute_metric_definition(id:, inputs:, release_tag: nil, request_options: nil)
|
34
34
|
response = @request_client.conn.post do | req |
|
35
35
|
unless request_options&.timeout_in_seconds.nil?
|
@@ -38,6 +38,11 @@ module Vellum
|
|
38
38
|
unless request_options&.api_key.nil?
|
39
39
|
req.headers["X-API-KEY"] = request_options.api_key
|
40
40
|
end
|
41
|
+
unless request_options&.api_version.nil?
|
42
|
+
req.headers["X-API-Version"] = request_options.api_version
|
43
|
+
else
|
44
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
45
|
+
end
|
41
46
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
42
47
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
43
48
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -68,6 +73,11 @@ end
|
|
68
73
|
unless request_options&.api_key.nil?
|
69
74
|
req.headers["X-API-KEY"] = request_options.api_key
|
70
75
|
end
|
76
|
+
unless request_options&.api_version.nil?
|
77
|
+
req.headers["X-API-Version"] = request_options.api_version
|
78
|
+
else
|
79
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
80
|
+
end
|
71
81
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
72
82
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
73
83
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -101,7 +111,7 @@ end
|
|
101
111
|
# environment: Vellum::Environment::PRODUCTION,
|
102
112
|
# api_key: "YOUR_API_KEY"
|
103
113
|
# )
|
104
|
-
# api.metric_definitions.execute_metric_definition(id: "id", inputs: [{ name: "name", type: "STRING", value: "value" }])
|
114
|
+
# api.metric_definitions.execute_metric_definition(id: "id", inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
|
105
115
|
def execute_metric_definition(id:, inputs:, release_tag: nil, request_options: nil)
|
106
116
|
Async do
|
107
117
|
response = @request_client.conn.post do | req |
|
@@ -111,6 +121,11 @@ end
|
|
111
121
|
unless request_options&.api_key.nil?
|
112
122
|
req.headers["X-API-KEY"] = request_options.api_key
|
113
123
|
end
|
124
|
+
unless request_options&.api_version.nil?
|
125
|
+
req.headers["X-API-Version"] = request_options.api_version
|
126
|
+
else
|
127
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
128
|
+
end
|
114
129
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
115
130
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
116
131
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -143,6 +158,11 @@ end
|
|
143
158
|
unless request_options&.api_key.nil?
|
144
159
|
req.headers["X-API-KEY"] = request_options.api_key
|
145
160
|
end
|
161
|
+
unless request_options&.api_version.nil?
|
162
|
+
req.headers["X-API-Version"] = request_options.api_version
|
163
|
+
else
|
164
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
165
|
+
end
|
146
166
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
147
167
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
148
168
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -35,6 +35,11 @@ module Vellum
|
|
35
35
|
unless request_options&.api_key.nil?
|
36
36
|
req.headers["X-API-KEY"] = request_options.api_key
|
37
37
|
end
|
38
|
+
unless request_options&.api_version.nil?
|
39
|
+
req.headers["X-API-Version"] = request_options.api_version
|
40
|
+
else
|
41
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
42
|
+
end
|
38
43
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
39
44
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
40
45
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -78,6 +83,11 @@ end
|
|
78
83
|
unless request_options&.api_key.nil?
|
79
84
|
req.headers["X-API-KEY"] = request_options.api_key
|
80
85
|
end
|
86
|
+
unless request_options&.api_version.nil?
|
87
|
+
req.headers["X-API-Version"] = request_options.api_version
|
88
|
+
else
|
89
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
90
|
+
end
|
81
91
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
82
92
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
83
93
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -34,6 +34,11 @@ module Vellum
|
|
34
34
|
unless request_options&.api_key.nil?
|
35
35
|
req.headers["X-API-KEY"] = request_options.api_key
|
36
36
|
end
|
37
|
+
unless request_options&.api_version.nil?
|
38
|
+
req.headers["X-API-Version"] = request_options.api_version
|
39
|
+
else
|
40
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
41
|
+
end
|
37
42
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
38
43
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
39
44
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -76,6 +81,11 @@ end
|
|
76
81
|
unless request_options&.api_key.nil?
|
77
82
|
req.headers["X-API-KEY"] = request_options.api_key
|
78
83
|
end
|
84
|
+
unless request_options&.api_version.nil?
|
85
|
+
req.headers["X-API-Version"] = request_options.api_version
|
86
|
+
else
|
87
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
88
|
+
end
|
79
89
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
80
90
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
81
91
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -39,6 +39,11 @@ module Vellum
|
|
39
39
|
unless request_options&.api_key.nil?
|
40
40
|
req.headers["X-API-KEY"] = request_options.api_key
|
41
41
|
end
|
42
|
+
unless request_options&.api_version.nil?
|
43
|
+
req.headers["X-API-Version"] = request_options.api_version
|
44
|
+
else
|
45
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
46
|
+
end
|
42
47
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}), "Accept": "application/json" }.compact
|
43
48
|
req.params = { **(request_options&.additional_query_parameters || {}), "prompt_variant_id": prompt_variant_id }.compact
|
44
49
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -80,7 +85,7 @@ end
|
|
80
85
|
# environment: Vellum::Environment::PRODUCTION,
|
81
86
|
# api_key: "YOUR_API_KEY"
|
82
87
|
# )
|
83
|
-
# api.prompts.push(exec_config: { ml_model: "ml_model", input_variables: [{ id: "id", key: "key", type: STRING }], parameters: { }, blocks: [{ block_type: "JINJA", template: "template" }] })
|
88
|
+
# api.prompts.push(exec_config: { ml_model: "ml_model", input_variables: [{ id: "x", key: "key", type: STRING }, { id: "x", key: "key", type: STRING }], parameters: { }, blocks: [{ block_type: "JINJA", template: "template" }, { block_type: "JINJA", template: "template" }] })
|
84
89
|
def push(prompt_variant_id: nil, prompt_variant_label: nil, prompt_sandbox_id: nil, exec_config:, request_options: nil)
|
85
90
|
response = @request_client.conn.post do | req |
|
86
91
|
unless request_options&.timeout_in_seconds.nil?
|
@@ -89,6 +94,11 @@ end
|
|
89
94
|
unless request_options&.api_key.nil?
|
90
95
|
req.headers["X-API-KEY"] = request_options.api_key
|
91
96
|
end
|
97
|
+
unless request_options&.api_version.nil?
|
98
|
+
req.headers["X-API-Version"] = request_options.api_version
|
99
|
+
else
|
100
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
101
|
+
end
|
92
102
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
93
103
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
94
104
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -132,6 +142,11 @@ end
|
|
132
142
|
unless request_options&.api_key.nil?
|
133
143
|
req.headers["X-API-KEY"] = request_options.api_key
|
134
144
|
end
|
145
|
+
unless request_options&.api_version.nil?
|
146
|
+
req.headers["X-API-Version"] = request_options.api_version
|
147
|
+
else
|
148
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
149
|
+
end
|
135
150
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}), "Accept": "application/json" }.compact
|
136
151
|
req.params = { **(request_options&.additional_query_parameters || {}), "prompt_variant_id": prompt_variant_id }.compact
|
137
152
|
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
@@ -174,7 +189,7 @@ end
|
|
174
189
|
# environment: Vellum::Environment::PRODUCTION,
|
175
190
|
# api_key: "YOUR_API_KEY"
|
176
191
|
# )
|
177
|
-
# api.prompts.push(exec_config: { ml_model: "ml_model", input_variables: [{ id: "id", key: "key", type: STRING }], parameters: { }, blocks: [{ block_type: "JINJA", template: "template" }] })
|
192
|
+
# api.prompts.push(exec_config: { ml_model: "ml_model", input_variables: [{ id: "x", key: "key", type: STRING }, { id: "x", key: "key", type: STRING }], parameters: { }, blocks: [{ block_type: "JINJA", template: "template" }, { block_type: "JINJA", template: "template" }] })
|
178
193
|
def push(prompt_variant_id: nil, prompt_variant_label: nil, prompt_sandbox_id: nil, exec_config:, request_options: nil)
|
179
194
|
Async do
|
180
195
|
response = @request_client.conn.post do | req |
|
@@ -184,6 +199,11 @@ end
|
|
184
199
|
unless request_options&.api_key.nil?
|
185
200
|
req.headers["X-API-KEY"] = request_options.api_key
|
186
201
|
end
|
202
|
+
unless request_options&.api_version.nil?
|
203
|
+
req.headers["X-API-Version"] = request_options.api_version
|
204
|
+
else
|
205
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
206
|
+
end
|
187
207
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
188
208
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
189
209
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -39,6 +39,11 @@ module Vellum
|
|
39
39
|
unless request_options&.api_key.nil?
|
40
40
|
req.headers["X-API-KEY"] = request_options.api_key
|
41
41
|
end
|
42
|
+
unless request_options&.api_version.nil?
|
43
|
+
req.headers["X-API-Version"] = request_options.api_version
|
44
|
+
else
|
45
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
46
|
+
end
|
42
47
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
43
48
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
44
49
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
@@ -86,6 +91,11 @@ end
|
|
86
91
|
unless request_options&.api_key.nil?
|
87
92
|
req.headers["X-API-KEY"] = request_options.api_key
|
88
93
|
end
|
94
|
+
unless request_options&.api_version.nil?
|
95
|
+
req.headers["X-API-Version"] = request_options.api_version
|
96
|
+
else
|
97
|
+
req.headers["X-API-Version"] = "2025-07-30"
|
98
|
+
end
|
89
99
|
req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
|
90
100
|
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
91
101
|
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|