vellum-ai 0.14.88__py3-none-any.whl → 0.14.89__py3-none-any.whl

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 (31) hide show
  1. vellum/client/README.md +33 -10
  2. vellum/client/__init__.py +141 -40
  3. vellum/client/core/client_wrapper.py +18 -5
  4. vellum/client/reference.md +241 -318
  5. vellum/client/resources/ad_hoc/client.py +76 -24
  6. vellum/client/resources/container_images/client.py +14 -6
  7. vellum/client/resources/deployments/client.py +28 -4
  8. vellum/client/resources/document_indexes/client.py +30 -38
  9. vellum/client/resources/documents/client.py +8 -30
  10. vellum/client/resources/folder_entities/client.py +4 -0
  11. vellum/client/resources/metric_definitions/client.py +16 -4
  12. vellum/client/resources/ml_models/client.py +2 -0
  13. vellum/client/resources/organizations/client.py +2 -0
  14. vellum/client/resources/prompts/client.py +26 -6
  15. vellum/client/resources/release_reviews/client.py +2 -0
  16. vellum/client/resources/sandboxes/client.py +10 -10
  17. vellum/client/resources/test_suite_runs/client.py +6 -0
  18. vellum/client/resources/test_suites/client.py +96 -58
  19. vellum/client/resources/workflow_deployments/client.py +16 -0
  20. vellum/client/resources/workflow_sandboxes/client.py +4 -0
  21. vellum/client/resources/workflows/client.py +0 -30
  22. vellum/client/resources/workspace_secrets/client.py +4 -0
  23. vellum/client/resources/workspaces/client.py +2 -0
  24. vellum/workflows/nodes/displayable/tool_calling_node/node.py +1 -5
  25. vellum/workflows/nodes/displayable/tool_calling_node/state.py +9 -0
  26. vellum/workflows/nodes/displayable/tool_calling_node/utils.py +50 -41
  27. {vellum_ai-0.14.88.dist-info → vellum_ai-0.14.89.dist-info}/METADATA +1 -1
  28. {vellum_ai-0.14.88.dist-info → vellum_ai-0.14.89.dist-info}/RECORD +31 -30
  29. {vellum_ai-0.14.88.dist-info → vellum_ai-0.14.89.dist-info}/LICENSE +0 -0
  30. {vellum_ai-0.14.88.dist-info → vellum_ai-0.14.89.dist-info}/WHEEL +0 -0
  31. {vellum_ai-0.14.88.dist-info → vellum_ai-0.14.89.dist-info}/entry_points.txt +0 -0
vellum/client/resources/documents/client.py CHANGED
@@ -68,6 +68,7 @@ class DocumentsClient:
68
68
  from vellum import Vellum
69
69
 
70
70
  client = Vellum(
71
+ api_version="YOUR_API_VERSION",
71
72
  api_key="YOUR_API_KEY",
72
73
  )
73
74
  client.documents.list()
@@ -120,6 +121,7 @@ class DocumentsClient:
120
121
  from vellum import Vellum
121
122
 
122
123
  client = Vellum(
124
+ api_version="YOUR_API_VERSION",
123
125
  api_key="YOUR_API_KEY",
124
126
  )
125
127
  client.documents.retrieve(
@@ -166,6 +168,7 @@ class DocumentsClient:
166
168
  from vellum import Vellum
167
169
 
168
170
  client = Vellum(
171
+ api_version="YOUR_API_VERSION",
169
172
  api_key="YOUR_API_KEY",
170
173
  )
171
174
  client.documents.destroy(
@@ -230,6 +233,7 @@ class DocumentsClient:
230
233
  from vellum import Vellum
231
234
 
232
235
  client = Vellum(
236
+ api_version="YOUR_API_VERSION",
233
237
  api_key="YOUR_API_KEY",
234
238
  )
235
239
  client.documents.partial_update(
@@ -309,17 +313,6 @@ class DocumentsClient:
309
313
  -------
310
314
  UploadDocumentResponse
311
315
 
312
-
313
- Examples
314
- --------
315
- from vellum import Vellum
316
-
317
- client = Vellum(
318
- api_key="YOUR_API_KEY",
319
- )
320
- client.documents.upload(
321
- label="label",
322
- )
323
316
  """
324
317
  _response = self._client_wrapper.httpx_client.request(
325
318
  "v1/upload-document",
@@ -432,6 +425,7 @@ class AsyncDocumentsClient:
432
425
  from vellum import AsyncVellum
433
426
 
434
427
  client = AsyncVellum(
428
+ api_version="YOUR_API_VERSION",
435
429
  api_key="YOUR_API_KEY",
436
430
  )
437
431
 
@@ -492,6 +486,7 @@ class AsyncDocumentsClient:
492
486
  from vellum import AsyncVellum
493
487
 
494
488
  client = AsyncVellum(
489
+ api_version="YOUR_API_VERSION",
495
490
  api_key="YOUR_API_KEY",
496
491
  )
497
492
 
@@ -546,6 +541,7 @@ class AsyncDocumentsClient:
546
541
  from vellum import AsyncVellum
547
542
 
548
543
  client = AsyncVellum(
544
+ api_version="YOUR_API_VERSION",
549
545
  api_key="YOUR_API_KEY",
550
546
  )
551
547
 
@@ -618,6 +614,7 @@ class AsyncDocumentsClient:
618
614
  from vellum import AsyncVellum
619
615
 
620
616
  client = AsyncVellum(
617
+ api_version="YOUR_API_VERSION",
621
618
  api_key="YOUR_API_KEY",
622
619
  )
623
620
 
@@ -703,25 +700,6 @@ class AsyncDocumentsClient:
703
700
  -------
704
701
  UploadDocumentResponse
705
702
 
706
-
707
- Examples
708
- --------
709
- import asyncio
710
-
711
- from vellum import AsyncVellum
712
-
713
- client = AsyncVellum(
714
- api_key="YOUR_API_KEY",
715
- )
716
-
717
-
718
- async def main() -> None:
719
- await client.documents.upload(
720
- label="label",
721
- )
722
-
723
-
724
- asyncio.run(main())
725
703
  """
726
704
  _response = await self._client_wrapper.httpx_client.request(
727
705
  "v1/upload-document",
vellum/client/resources/folder_entities/client.py CHANGED
@@ -72,6 +72,7 @@ class FolderEntitiesClient:
72
72
  from vellum import Vellum
73
73
 
74
74
  client = Vellum(
75
+ api_version="YOUR_API_VERSION",
75
76
  api_key="YOUR_API_KEY",
76
77
  )
77
78
  client.folder_entities.list(
@@ -138,6 +139,7 @@ class FolderEntitiesClient:
138
139
  from vellum import Vellum
139
140
 
140
141
  client = Vellum(
142
+ api_version="YOUR_API_VERSION",
141
143
  api_key="YOUR_API_KEY",
142
144
  )
143
145
  client.folder_entities.add_entity_to_folder(
@@ -226,6 +228,7 @@ class AsyncFolderEntitiesClient:
226
228
  from vellum import AsyncVellum
227
229
 
228
230
  client = AsyncVellum(
231
+ api_version="YOUR_API_VERSION",
229
232
  api_key="YOUR_API_KEY",
230
233
  )
231
234
 
@@ -300,6 +303,7 @@ class AsyncFolderEntitiesClient:
300
303
  from vellum import AsyncVellum
301
304
 
302
305
  client = AsyncVellum(
306
+ api_version="YOUR_API_VERSION",
303
307
  api_key="YOUR_API_KEY",
304
308
  )
305
309
 
vellum/client/resources/metric_definitions/client.py CHANGED
@@ -52,15 +52,20 @@ class MetricDefinitionsClient:
52
52
  from vellum import StringInput, Vellum
53
53
 
54
54
  client = Vellum(
55
+ api_version="YOUR_API_VERSION",
55
56
  api_key="YOUR_API_KEY",
56
57
  )
57
58
  client.metric_definitions.execute_metric_definition(
58
59
  id="id",
59
60
  inputs=[
60
61
  StringInput(
61
- name="name",
62
+ name="x",
62
63
  value="value",
63
- )
64
+ ),
65
+ StringInput(
66
+ name="x",
67
+ value="value",
68
+ ),
64
69
  ],
65
70
  )
66
71
  """
@@ -119,6 +124,7 @@ class MetricDefinitionsClient:
119
124
  from vellum import Vellum
120
125
 
121
126
  client = Vellum(
127
+ api_version="YOUR_API_VERSION",
122
128
  api_key="YOUR_API_KEY",
123
129
  )
124
130
  client.metric_definitions.metric_definition_history_item_retrieve(
@@ -184,6 +190,7 @@ class AsyncMetricDefinitionsClient:
184
190
  from vellum import AsyncVellum, StringInput
185
191
 
186
192
  client = AsyncVellum(
193
+ api_version="YOUR_API_VERSION",
187
194
  api_key="YOUR_API_KEY",
188
195
  )
189
196
 
@@ -193,9 +200,13 @@ class AsyncMetricDefinitionsClient:
193
200
  id="id",
194
201
  inputs=[
195
202
  StringInput(
196
- name="name",
203
+ name="x",
197
204
  value="value",
198
- )
205
+ ),
206
+ StringInput(
207
+ name="x",
208
+ value="value",
209
+ ),
199
210
  ],
200
211
  )
201
212
 
@@ -259,6 +270,7 @@ class AsyncMetricDefinitionsClient:
259
270
  from vellum import AsyncVellum
260
271
 
261
272
  client = AsyncVellum(
273
+ api_version="YOUR_API_VERSION",
262
274
  api_key="YOUR_API_KEY",
263
275
  )
264
276
 
vellum/client/resources/ml_models/client.py CHANGED
@@ -37,6 +37,7 @@ class MlModelsClient:
37
37
  from vellum import Vellum
38
38
 
39
39
  client = Vellum(
40
+ api_version="YOUR_API_VERSION",
40
41
  api_key="YOUR_API_KEY",
41
42
  )
42
43
  client.ml_models.retrieve(
@@ -92,6 +93,7 @@ class AsyncMlModelsClient:
92
93
  from vellum import AsyncVellum
93
94
 
94
95
  client = AsyncVellum(
96
+ api_version="YOUR_API_VERSION",
95
97
  api_key="YOUR_API_KEY",
96
98
  )
97
99
 
vellum/client/resources/organizations/client.py CHANGED
@@ -33,6 +33,7 @@ class OrganizationsClient:
33
33
  from vellum import Vellum
34
34
 
35
35
  client = Vellum(
36
+ api_version="YOUR_API_VERSION",
36
37
  api_key="YOUR_API_KEY",
37
38
  )
38
39
  client.organizations.organization_identity()
@@ -85,6 +86,7 @@ class AsyncOrganizationsClient:
85
86
  from vellum import AsyncVellum
86
87
 
87
88
  client = AsyncVellum(
89
+ api_version="YOUR_API_VERSION",
88
90
  api_key="YOUR_API_KEY",
89
91
  )
90
92
 
vellum/client/resources/prompts/client.py CHANGED
@@ -53,6 +53,7 @@ class PromptsClient:
53
53
  from vellum import Vellum
54
54
 
55
55
  client = Vellum(
56
+ api_version="YOUR_API_VERSION",
56
57
  api_key="YOUR_API_KEY",
57
58
  )
58
59
  client.prompts.pull(
@@ -148,6 +149,7 @@ class PromptsClient:
148
149
  )
149
150
 
150
151
  client = Vellum(
152
+ api_version="YOUR_API_VERSION",
151
153
  api_key="YOUR_API_KEY",
152
154
  )
153
155
  client.prompts.push(
@@ -155,16 +157,24 @@ class PromptsClient:
155
157
  ml_model="ml_model",
156
158
  input_variables=[
157
159
  VellumVariable(
158
- id="id",
160
+ id="x",
159
161
  key="key",
160
162
  type="STRING",
161
- )
163
+ ),
164
+ VellumVariable(
165
+ id="x",
166
+ key="key",
167
+ type="STRING",
168
+ ),
162
169
  ],
163
170
  parameters=PromptParameters(),
164
171
  blocks=[
165
172
  JinjaPromptBlock(
166
173
  template="template",
167
- )
174
+ ),
175
+ JinjaPromptBlock(
176
+ template="template",
177
+ ),
168
178
  ],
169
179
  ),
170
180
  )
@@ -259,6 +269,7 @@ class AsyncPromptsClient:
259
269
  from vellum import AsyncVellum
260
270
 
261
271
  client = AsyncVellum(
272
+ api_version="YOUR_API_VERSION",
262
273
  api_key="YOUR_API_KEY",
263
274
  )
264
275
 
@@ -362,6 +373,7 @@ class AsyncPromptsClient:
362
373
  )
363
374
 
364
375
  client = AsyncVellum(
376
+ api_version="YOUR_API_VERSION",
365
377
  api_key="YOUR_API_KEY",
366
378
  )
367
379
 
@@ -372,16 +384,24 @@ class AsyncPromptsClient:
372
384
  ml_model="ml_model",
373
385
  input_variables=[
374
386
  VellumVariable(
375
- id="id",
387
+ id="x",
388
+ key="key",
389
+ type="STRING",
390
+ ),
391
+ VellumVariable(
392
+ id="x",
376
393
  key="key",
377
394
  type="STRING",
378
- )
395
+ ),
379
396
  ],
380
397
  parameters=PromptParameters(),
381
398
  blocks=[
382
399
  JinjaPromptBlock(
383
400
  template="template",
384
- )
401
+ ),
402
+ JinjaPromptBlock(
403
+ template="template",
404
+ ),
385
405
  ],
386
406
  ),
387
407
  )
vellum/client/resources/release_reviews/client.py CHANGED
@@ -42,6 +42,7 @@ class ReleaseReviewsClient:
42
42
  from vellum import Vellum
43
43
 
44
44
  client = Vellum(
45
+ api_version="YOUR_API_VERSION",
45
46
  api_key="YOUR_API_KEY",
46
47
  )
47
48
  client.release_reviews.retrieve_workflow_deployment_release(
@@ -103,6 +104,7 @@ class AsyncReleaseReviewsClient:
103
104
  from vellum import AsyncVellum
104
105
 
105
106
  client = AsyncVellum(
107
+ api_version="YOUR_API_VERSION",
106
108
  api_key="YOUR_API_KEY",
107
109
  )
108
110
 
vellum/client/resources/sandboxes/client.py CHANGED
@@ -70,6 +70,7 @@ class SandboxesClient:
70
70
  from vellum import Vellum
71
71
 
72
72
  client = Vellum(
73
+ api_version="YOUR_API_VERSION",
73
74
  api_key="YOUR_API_KEY",
74
75
  )
75
76
  client.sandboxes.deploy_prompt(
@@ -152,19 +153,17 @@ class SandboxesClient:
152
153
  from vellum import NamedScenarioInputStringVariableValueRequest, Vellum
153
154
 
154
155
  client = Vellum(
156
+ api_version="YOUR_API_VERSION",
155
157
  api_key="YOUR_API_KEY",
156
158
  )
157
159
  client.sandboxes.upsert_sandbox_scenario(
158
160
  id="id",
159
- label="Scenario 1",
160
161
  inputs=[
161
162
  NamedScenarioInputStringVariableValueRequest(
162
- value="Hello, world!",
163
- name="var_1",
163
+ name="x",
164
164
  ),
165
165
  NamedScenarioInputStringVariableValueRequest(
166
- value="Why hello, there!",
167
- name="var_2",
166
+ name="x",
168
167
  ),
169
168
  ],
170
169
  )
@@ -226,6 +225,7 @@ class SandboxesClient:
226
225
  from vellum import Vellum
227
226
 
228
227
  client = Vellum(
228
+ api_version="YOUR_API_VERSION",
229
229
  api_key="YOUR_API_KEY",
230
230
  )
231
231
  client.sandboxes.delete_sandbox_scenario(
@@ -303,6 +303,7 @@ class AsyncSandboxesClient:
303
303
  from vellum import AsyncVellum
304
304
 
305
305
  client = AsyncVellum(
306
+ api_version="YOUR_API_VERSION",
306
307
  api_key="YOUR_API_KEY",
307
308
  )
308
309
 
@@ -393,6 +394,7 @@ class AsyncSandboxesClient:
393
394
  from vellum import AsyncVellum, NamedScenarioInputStringVariableValueRequest
394
395
 
395
396
  client = AsyncVellum(
397
+ api_version="YOUR_API_VERSION",
396
398
  api_key="YOUR_API_KEY",
397
399
  )
398
400
 
@@ -400,15 +402,12 @@ class AsyncSandboxesClient:
400
402
  async def main() -> None:
401
403
  await client.sandboxes.upsert_sandbox_scenario(
402
404
  id="id",
403
- label="Scenario 1",
404
405
  inputs=[
405
406
  NamedScenarioInputStringVariableValueRequest(
406
- value="Hello, world!",
407
- name="var_1",
407
+ name="x",
408
408
  ),
409
409
  NamedScenarioInputStringVariableValueRequest(
410
- value="Why hello, there!",
411
- name="var_2",
410
+ name="x",
412
411
  ),
413
412
  ],
414
413
  )
@@ -475,6 +474,7 @@ class AsyncSandboxesClient:
475
474
  from vellum import AsyncVellum
476
475
 
477
476
  client = AsyncVellum(
477
+ api_version="YOUR_API_VERSION",
478
478
  api_key="YOUR_API_KEY",
479
479
  )
480
480
 
vellum/client/resources/test_suite_runs/client.py CHANGED
@@ -60,6 +60,7 @@ class TestSuiteRunsClient:
60
60
  )
61
61
 
62
62
  client = Vellum(
63
+ api_version="YOUR_API_VERSION",
63
64
  api_key="YOUR_API_KEY",
64
65
  )
65
66
  client.test_suite_runs.create(
@@ -123,6 +124,7 @@ class TestSuiteRunsClient:
123
124
  from vellum import Vellum
124
125
 
125
126
  client = Vellum(
127
+ api_version="YOUR_API_VERSION",
126
128
  api_key="YOUR_API_KEY",
127
129
  )
128
130
  client.test_suite_runs.retrieve(
@@ -189,6 +191,7 @@ class TestSuiteRunsClient:
189
191
  from vellum import Vellum
190
192
 
191
193
  client = Vellum(
194
+ api_version="YOUR_API_VERSION",
192
195
  api_key="YOUR_API_KEY",
193
196
  )
194
197
  client.test_suite_runs.list_executions(
@@ -266,6 +269,7 @@ class AsyncTestSuiteRunsClient:
266
269
  )
267
270
 
268
271
  client = AsyncVellum(
272
+ api_version="YOUR_API_VERSION",
269
273
  api_key="YOUR_API_KEY",
270
274
  )
271
275
 
@@ -337,6 +341,7 @@ class AsyncTestSuiteRunsClient:
337
341
  from vellum import AsyncVellum
338
342
 
339
343
  client = AsyncVellum(
344
+ api_version="YOUR_API_VERSION",
340
345
  api_key="YOUR_API_KEY",
341
346
  )
342
347
 
@@ -411,6 +416,7 @@ class AsyncTestSuiteRunsClient:
411
416
  from vellum import AsyncVellum
412
417
 
413
418
  client = AsyncVellum(
419
+ api_version="YOUR_API_VERSION",
414
420
  api_key="YOUR_API_KEY",
415
421
  )
416
422