vellum-ai 0.14.88__py3-none-any.whl → 1.0.0__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 (62) hide show
  1. vellum/__init__.py +1 -1
  2. vellum/client/README.md +33 -10
  3. vellum/client/__init__.py +141 -40
  4. vellum/client/core/client_wrapper.py +18 -5
  5. vellum/client/reference.md +241 -318
  6. vellum/client/resources/ad_hoc/client.py +76 -24
  7. vellum/client/resources/container_images/client.py +14 -6
  8. vellum/client/resources/deployments/client.py +28 -4
  9. vellum/client/resources/document_indexes/client.py +30 -38
  10. vellum/client/resources/documents/client.py +8 -30
  11. vellum/client/resources/folder_entities/client.py +4 -0
  12. vellum/client/resources/metric_definitions/client.py +16 -4
  13. vellum/client/resources/ml_models/client.py +2 -0
  14. vellum/client/resources/organizations/client.py +2 -0
  15. vellum/client/resources/prompts/client.py +26 -6
  16. vellum/client/resources/release_reviews/client.py +2 -0
  17. vellum/client/resources/sandboxes/client.py +10 -10
  18. vellum/client/resources/test_suite_runs/client.py +6 -0
  19. vellum/client/resources/test_suites/client.py +96 -58
  20. vellum/client/resources/workflow_deployments/client.py +16 -0
  21. vellum/client/resources/workflow_sandboxes/client.py +4 -0
  22. vellum/client/resources/workflows/client.py +0 -30
  23. vellum/client/resources/workspace_secrets/client.py +4 -0
  24. vellum/client/resources/workspaces/client.py +2 -0
  25. vellum/evaluations/resources.py +5 -5
  26. vellum/workflows/events/node.py +1 -1
  27. vellum/workflows/events/types.py +1 -1
  28. vellum/workflows/events/workflow.py +1 -1
  29. vellum/workflows/nodes/bases/tests/test_base_node.py +1 -1
  30. vellum/workflows/nodes/displayable/bases/base_prompt_node/node.py +1 -1
  31. vellum/workflows/nodes/displayable/bases/search_node.py +1 -1
  32. vellum/workflows/nodes/displayable/code_execution_node/node.py +1 -1
  33. vellum/workflows/nodes/displayable/guardrail_node/node.py +1 -1
  34. vellum/workflows/nodes/displayable/subworkflow_deployment_node/node.py +1 -1
  35. vellum/workflows/nodes/displayable/tool_calling_node/node.py +1 -5
  36. vellum/workflows/nodes/displayable/tool_calling_node/state.py +9 -0
  37. vellum/workflows/nodes/displayable/tool_calling_node/utils.py +133 -155
  38. vellum/workflows/nodes/experimental/__init__.py +2 -2
  39. vellum/workflows/state/base.py +1 -1
  40. vellum/workflows/state/delta.py +1 -1
  41. {vellum_ai-0.14.88.dist-info → vellum_ai-1.0.0.dist-info}/METADATA +1 -1
  42. {vellum_ai-0.14.88.dist-info → vellum_ai-1.0.0.dist-info}/RECORD +59 -61
  43. vellum_cli/config.py +1 -1
  44. vellum_cli/push.py +1 -1
  45. vellum_ee/workflows/display/base.py +0 -54
  46. vellum_ee/workflows/display/nodes/vellum/conditional_node.py +16 -2
  47. vellum_ee/workflows/display/nodes/vellum/tests/test_utils.py +3 -3
  48. vellum_ee/workflows/display/tests/test_base_workflow_display.py +2 -4
  49. vellum_ee/workflows/display/tests/workflow_serialization/generic_nodes/conftest.py +2 -2
  50. vellum_ee/workflows/display/tests/workflow_serialization/test_basic_conditional_node_serialization.py +11 -11
  51. vellum_ee/workflows/display/vellum.py +2 -128
  52. vellum_ee/workflows/display/workflows/__init__.py +0 -1
  53. vellum_ee/workflows/display/workflows/base_workflow_display.py +1 -1
  54. vellum_ee/workflows/tests/local_workflow/display/nodes/final_output.py +1 -1
  55. vellum_ee/workflows/tests/local_workflow/display/nodes/templating_node.py +1 -1
  56. vellum_ee/workflows/tests/local_workflow/display/workflow.py +11 -14
  57. vellum/workflows/nodes/experimental/tool_calling_node/__init__.py +0 -3
  58. vellum/workflows/nodes/experimental/tool_calling_node/node.py +0 -3
  59. vellum_ee/workflows/display/workflows/vellum_workflow_display.py +0 -9
  60. {vellum_ai-0.14.88.dist-info → vellum_ai-1.0.0.dist-info}/LICENSE +0 -0
  61. {vellum_ai-0.14.88.dist-info → vellum_ai-1.0.0.dist-info}/WHEEL +0 -0
  62. {vellum_ai-0.14.88.dist-info → vellum_ai-1.0.0.dist-info}/entry_points.txt +0 -0
@@ -15,10 +15,11 @@
15
15
  from vellum import Vellum
16
16
 
17
17
  client = Vellum(
18
+ api_version="YOUR_API_VERSION",
18
19
  api_key="YOUR_API_KEY",
19
20
  )
20
21
  client.execute_api(
21
- url="url",
22
+ url="x",
22
23
  )
23
24
 
24
25
  ```
@@ -103,22 +104,31 @@ client.execute_api(
103
104
  from vellum import CodeExecutionPackage, StringInput, Vellum
104
105
 
105
106
  client = Vellum(
107
+ api_version="YOUR_API_VERSION",
106
108
  api_key="YOUR_API_KEY",
107
109
  )
108
110
  client.execute_code(
109
- code="code",
111
+ code="x",
110
112
  runtime="PYTHON_3_11_6",
111
113
  input_values=[
112
114
  StringInput(
113
- name="name",
115
+ name="x",
114
116
  value="value",
115
- )
117
+ ),
118
+ StringInput(
119
+ name="x",
120
+ value="value",
121
+ ),
116
122
  ],
117
123
  packages=[
118
124
  CodeExecutionPackage(
119
125
  version="version",
120
126
  name="name",
121
- )
127
+ ),
128
+ CodeExecutionPackage(
129
+ version="version",
130
+ name="name",
131
+ ),
122
132
  ],
123
133
  output_type="STRING",
124
134
  )
@@ -219,14 +229,19 @@ Executes a deployed Prompt and returns the result.
219
229
  from vellum import StringInputRequest, Vellum
220
230
 
221
231
  client = Vellum(
232
+ api_version="YOUR_API_VERSION",
222
233
  api_key="YOUR_API_KEY",
223
234
  )
224
235
  client.execute_prompt(
225
236
  inputs=[
226
237
  StringInputRequest(
227
- name="name",
238
+ name="x",
228
239
  value="value",
229
- )
240
+ ),
241
+ StringInputRequest(
242
+ name="x",
243
+ value="value",
244
+ ),
230
245
  ],
231
246
  )
232
247
 
@@ -358,14 +373,19 @@ Executes a deployed Prompt and streams back the results.
358
373
  from vellum import StringInputRequest, Vellum
359
374
 
360
375
  client = Vellum(
376
+ api_version="YOUR_API_VERSION",
361
377
  api_key="YOUR_API_KEY",
362
378
  )
363
379
  response = client.execute_prompt_stream(
364
380
  inputs=[
365
381
  StringInputRequest(
366
- name="name",
382
+ name="x",
367
383
  value="value",
368
- )
384
+ ),
385
+ StringInputRequest(
386
+ name="x",
387
+ value="value",
388
+ ),
369
389
  ],
370
390
  )
371
391
  for chunk in response:
@@ -499,14 +519,19 @@ Executes a deployed Workflow and returns its outputs.
499
519
  from vellum import Vellum, WorkflowRequestStringInputRequest
500
520
 
501
521
  client = Vellum(
522
+ api_version="YOUR_API_VERSION",
502
523
  api_key="YOUR_API_KEY",
503
524
  )
504
525
  client.execute_workflow(
505
526
  inputs=[
506
527
  WorkflowRequestStringInputRequest(
507
- name="name",
528
+ name="x",
508
529
  value="value",
509
- )
530
+ ),
531
+ WorkflowRequestStringInputRequest(
532
+ name="x",
533
+ value="value",
534
+ ),
510
535
  ],
511
536
  )
512
537
 
@@ -622,14 +647,19 @@ Executes a deployed Workflow and streams back its results.
622
647
  from vellum import Vellum, WorkflowRequestStringInputRequest
623
648
 
624
649
  client = Vellum(
650
+ api_version="YOUR_API_VERSION",
625
651
  api_key="YOUR_API_KEY",
626
652
  )
627
653
  response = client.execute_workflow_stream(
628
654
  inputs=[
629
655
  WorkflowRequestStringInputRequest(
630
- name="name",
656
+ name="x",
631
657
  value="value",
632
- )
658
+ ),
659
+ WorkflowRequestStringInputRequest(
660
+ name="x",
661
+ value="value",
662
+ ),
633
663
  ],
634
664
  )
635
665
  for chunk in response:
@@ -758,13 +788,17 @@ Important: This endpoint is DEPRECATED and has been superseded by
758
788
  from vellum import GenerateRequest, Vellum
759
789
 
760
790
  client = Vellum(
791
+ api_version="YOUR_API_VERSION",
761
792
  api_key="YOUR_API_KEY",
762
793
  )
763
794
  client.generate(
764
795
  requests=[
765
796
  GenerateRequest(
766
- input_values={"key": "value"},
767
- )
797
+ input_values={"input_values": {"key": "value"}},
798
+ ),
799
+ GenerateRequest(
800
+ input_values={"input_values": {"key": "value"}},
801
+ ),
768
802
  ],
769
803
  )
770
804
 
@@ -859,13 +893,17 @@ Important: This endpoint is DEPRECATED and has been superseded by
859
893
  from vellum import GenerateRequest, Vellum
860
894
 
861
895
  client = Vellum(
896
+ api_version="YOUR_API_VERSION",
862
897
  api_key="YOUR_API_KEY",
863
898
  )
864
899
  response = client.generate_stream(
865
900
  requests=[
866
901
  GenerateRequest(
867
- input_values={"key": "value"},
868
- )
902
+ input_values={"input_values": {"key": "value"}},
903
+ ),
904
+ GenerateRequest(
905
+ input_values={"input_values": {"key": "value"}},
906
+ ),
869
907
  ],
870
908
  )
871
909
  for chunk in response:
@@ -959,10 +997,11 @@ Perform a search against a document index.
959
997
  from vellum import Vellum
960
998
 
961
999
  client = Vellum(
1000
+ api_version="YOUR_API_VERSION",
962
1001
  api_key="YOUR_API_KEY",
963
1002
  )
964
1003
  client.search(
965
- query="query",
1004
+ query="x",
966
1005
  )
967
1006
 
968
1007
  ```
@@ -1061,10 +1100,11 @@ Used to submit feedback regarding the quality of previously generated completion
1061
1100
  from vellum import SubmitCompletionActualRequest, Vellum
1062
1101
 
1063
1102
  client = Vellum(
1103
+ api_version="YOUR_API_VERSION",
1064
1104
  api_key="YOUR_API_KEY",
1065
1105
  )
1066
1106
  client.submit_completion_actuals(
1067
- actuals=[SubmitCompletionActualRequest()],
1107
+ actuals=[SubmitCompletionActualRequest(), SubmitCompletionActualRequest()],
1068
1108
  )
1069
1109
 
1070
1110
  ```
@@ -1149,10 +1189,14 @@ client.submit_completion_actuals(
1149
1189
  from vellum import Vellum, WorkflowExecutionActualStringRequest
1150
1190
 
1151
1191
  client = Vellum(
1192
+ api_version="YOUR_API_VERSION",
1152
1193
  api_key="YOUR_API_KEY",
1153
1194
  )
1154
1195
  client.submit_workflow_execution_actuals(
1155
- actuals=[WorkflowExecutionActualStringRequest()],
1196
+ actuals=[
1197
+ WorkflowExecutionActualStringRequest(),
1198
+ WorkflowExecutionActualStringRequest(),
1199
+ ],
1156
1200
  )
1157
1201
 
1158
1202
  ```
@@ -1228,28 +1272,41 @@ from vellum import (
1228
1272
  )
1229
1273
 
1230
1274
  client = Vellum(
1275
+ api_version="YOUR_API_VERSION",
1231
1276
  api_key="YOUR_API_KEY",
1232
1277
  )
1233
1278
  client.ad_hoc.adhoc_execute_prompt(
1234
- ml_model="ml_model",
1279
+ ml_model="x",
1235
1280
  input_values=[
1236
1281
  PromptRequestStringInput(
1237
- key="key",
1282
+ key="x",
1283
+ value="value",
1284
+ ),
1285
+ PromptRequestStringInput(
1286
+ key="x",
1238
1287
  value="value",
1239
- )
1288
+ ),
1240
1289
  ],
1241
1290
  input_variables=[
1242
1291
  VellumVariable(
1243
- id="id",
1292
+ id="x",
1293
+ key="key",
1294
+ type="STRING",
1295
+ ),
1296
+ VellumVariable(
1297
+ id="x",
1244
1298
  key="key",
1245
1299
  type="STRING",
1246
- )
1300
+ ),
1247
1301
  ],
1248
1302
  parameters=PromptParameters(),
1249
1303
  blocks=[
1250
1304
  JinjaPromptBlock(
1251
1305
  template="template",
1252
- )
1306
+ ),
1307
+ JinjaPromptBlock(
1308
+ template="template",
1309
+ ),
1253
1310
  ],
1254
1311
  )
1255
1312
 
@@ -1365,28 +1422,41 @@ from vellum import (
1365
1422
  )
1366
1423
 
1367
1424
  client = Vellum(
1425
+ api_version="YOUR_API_VERSION",
1368
1426
  api_key="YOUR_API_KEY",
1369
1427
  )
1370
1428
  response = client.ad_hoc.adhoc_execute_prompt_stream(
1371
- ml_model="ml_model",
1429
+ ml_model="x",
1372
1430
  input_values=[
1373
1431
  PromptRequestStringInput(
1374
- key="key",
1432
+ key="x",
1433
+ value="value",
1434
+ ),
1435
+ PromptRequestStringInput(
1436
+ key="x",
1375
1437
  value="value",
1376
- )
1438
+ ),
1377
1439
  ],
1378
1440
  input_variables=[
1379
1441
  VellumVariable(
1380
- id="id",
1442
+ id="x",
1381
1443
  key="key",
1382
1444
  type="STRING",
1383
- )
1445
+ ),
1446
+ VellumVariable(
1447
+ id="x",
1448
+ key="key",
1449
+ type="STRING",
1450
+ ),
1384
1451
  ],
1385
1452
  parameters=PromptParameters(),
1386
1453
  blocks=[
1387
1454
  JinjaPromptBlock(
1388
1455
  template="template",
1389
- )
1456
+ ),
1457
+ JinjaPromptBlock(
1458
+ template="template",
1459
+ ),
1390
1460
  ],
1391
1461
  )
1392
1462
  for chunk in response:
@@ -1513,6 +1583,7 @@ Retrieve a list of container images for the organization.
1513
1583
  from vellum import Vellum
1514
1584
 
1515
1585
  client = Vellum(
1586
+ api_version="YOUR_API_VERSION",
1516
1587
  api_key="YOUR_API_KEY",
1517
1588
  )
1518
1589
  client.container_images.list()
@@ -1597,6 +1668,7 @@ Retrieve a Container Image by its ID or name.
1597
1668
  from vellum import Vellum
1598
1669
 
1599
1670
  client = Vellum(
1671
+ api_version="YOUR_API_VERSION",
1600
1672
  api_key="YOUR_API_KEY",
1601
1673
  )
1602
1674
  client.container_images.retrieve(
@@ -1653,6 +1725,7 @@ client.container_images.retrieve(
1653
1725
  from vellum import Vellum
1654
1726
 
1655
1727
  client = Vellum(
1728
+ api_version="YOUR_API_VERSION",
1656
1729
  api_key="YOUR_API_KEY",
1657
1730
  )
1658
1731
  client.container_images.docker_service_token()
@@ -1699,12 +1772,13 @@ client.container_images.docker_service_token()
1699
1772
  from vellum import Vellum
1700
1773
 
1701
1774
  client = Vellum(
1775
+ api_version="YOUR_API_VERSION",
1702
1776
  api_key="YOUR_API_KEY",
1703
1777
  )
1704
1778
  client.container_images.push_container_image(
1705
- name="name",
1706
- sha="sha",
1707
- tags=["tags"],
1779
+ name="x",
1780
+ sha="x",
1781
+ tags=["tags", "tags"],
1708
1782
  )
1709
1783
 
1710
1784
  ```
@@ -1788,6 +1862,7 @@ Used to list all Prompt Deployments.
1788
1862
  from vellum import Vellum
1789
1863
 
1790
1864
  client = Vellum(
1865
+ api_version="YOUR_API_VERSION",
1791
1866
  api_key="YOUR_API_KEY",
1792
1867
  )
1793
1868
  client.deployments.list()
@@ -1880,6 +1955,7 @@ Used to retrieve a Prompt Deployment given its ID or name.
1880
1955
  from vellum import Vellum
1881
1956
 
1882
1957
  client = Vellum(
1958
+ api_version="YOUR_API_VERSION",
1883
1959
  api_key="YOUR_API_KEY",
1884
1960
  )
1885
1961
  client.deployments.retrieve(
@@ -1951,6 +2027,7 @@ DEPRECATED: This endpoint is deprecated and will be removed in a future release.
1951
2027
  from vellum import Vellum
1952
2028
 
1953
2029
  client = Vellum(
2030
+ api_version="YOUR_API_VERSION",
1954
2031
  api_key="YOUR_API_KEY",
1955
2032
  )
1956
2033
  client.deployments.deployment_history_item_retrieve(
@@ -2030,6 +2107,7 @@ List Release Tags associated with the specified Prompt Deployment
2030
2107
  from vellum import Vellum
2031
2108
 
2032
2109
  client = Vellum(
2110
+ api_version="YOUR_API_VERSION",
2033
2111
  api_key="YOUR_API_KEY",
2034
2112
  )
2035
2113
  client.deployments.list_deployment_release_tags(
@@ -2132,6 +2210,7 @@ Retrieve a Deployment Release Tag by tag name, associated with a specified Deplo
2132
2210
  from vellum import Vellum
2133
2211
 
2134
2212
  client = Vellum(
2213
+ api_version="YOUR_API_VERSION",
2135
2214
  api_key="YOUR_API_KEY",
2136
2215
  )
2137
2216
  client.deployments.retrieve_deployment_release_tag(
@@ -2211,6 +2290,7 @@ Updates an existing Release Tag associated with the specified Prompt Deployment.
2211
2290
  from vellum import Vellum
2212
2291
 
2213
2292
  client = Vellum(
2293
+ api_version="YOUR_API_VERSION",
2214
2294
  api_key="YOUR_API_KEY",
2215
2295
  )
2216
2296
  client.deployments.update_deployment_release_tag(
@@ -2298,6 +2378,7 @@ Retrieve a specific Prompt Deployment Release by either its UUID or the name of
2298
2378
  from vellum import Vellum
2299
2379
 
2300
2380
  client = Vellum(
2381
+ api_version="YOUR_API_VERSION",
2301
2382
  api_key="YOUR_API_KEY",
2302
2383
  )
2303
2384
  client.deployments.retrieve_prompt_deployment_release(
@@ -2386,14 +2467,19 @@ We encourage you to seek advise from Vellum Support before integrating with this
2386
2467
  from vellum import StringInputRequest, Vellum
2387
2468
 
2388
2469
  client = Vellum(
2470
+ api_version="YOUR_API_VERSION",
2389
2471
  api_key="YOUR_API_KEY",
2390
2472
  )
2391
2473
  client.deployments.retrieve_provider_payload(
2392
2474
  inputs=[
2393
2475
  StringInputRequest(
2394
- name="name",
2476
+ name="x",
2395
2477
  value="value",
2396
- )
2478
+ ),
2479
+ StringInputRequest(
2480
+ name="x",
2481
+ value="value",
2482
+ ),
2397
2483
  ],
2398
2484
  )
2399
2485
 
@@ -2494,6 +2580,7 @@ Used to retrieve a list of Document Indexes.
2494
2580
  from vellum import Vellum
2495
2581
 
2496
2582
  client = Vellum(
2583
+ api_version="YOUR_API_VERSION",
2497
2584
  api_key="YOUR_API_KEY",
2498
2585
  )
2499
2586
  client.document_indexes.list()
@@ -2599,29 +2686,20 @@ Creates a new document index.
2599
2686
  from vellum import (
2600
2687
  DocumentIndexIndexingConfigRequest,
2601
2688
  OpenAiVectorizerConfigRequest,
2602
- OpenAiVectorizerTextEmbeddingAda002Request,
2603
- SentenceChunkerConfigRequest,
2604
- SentenceChunkingRequest,
2689
+ OpenAiVectorizerTextEmbedding3SmallRequest,
2605
2690
  Vellum,
2606
2691
  )
2607
2692
 
2608
2693
  client = Vellum(
2694
+ api_version="YOUR_API_VERSION",
2609
2695
  api_key="YOUR_API_KEY",
2610
2696
  )
2611
2697
  client.document_indexes.create(
2612
- label="My Document Index",
2613
- name="my-document-index",
2698
+ label="x",
2699
+ name="x",
2614
2700
  indexing_config=DocumentIndexIndexingConfigRequest(
2615
- vectorizer=OpenAiVectorizerTextEmbeddingAda002Request(
2616
- config=OpenAiVectorizerConfigRequest(
2617
- add_openai_api_key=True,
2618
- ),
2619
- ),
2620
- chunking=SentenceChunkingRequest(
2621
- chunker_config=SentenceChunkerConfigRequest(
2622
- character_limit=1000,
2623
- min_overlap_ratio=0.5,
2624
- ),
2701
+ vectorizer=OpenAiVectorizerTextEmbedding3SmallRequest(
2702
+ config=OpenAiVectorizerConfigRequest(),
2625
2703
  ),
2626
2704
  ),
2627
2705
  )
@@ -2727,6 +2805,7 @@ Used to retrieve a Document Index given its ID or name.
2727
2805
  from vellum import Vellum
2728
2806
 
2729
2807
  client = Vellum(
2808
+ api_version="YOUR_API_VERSION",
2730
2809
  api_key="YOUR_API_KEY",
2731
2810
  )
2732
2811
  client.document_indexes.retrieve(
@@ -2797,11 +2876,12 @@ Used to fully update a Document Index given its ID or name.
2797
2876
  from vellum import Vellum
2798
2877
 
2799
2878
  client = Vellum(
2879
+ api_version="YOUR_API_VERSION",
2800
2880
  api_key="YOUR_API_KEY",
2801
2881
  )
2802
2882
  client.document_indexes.update(
2803
2883
  id="id",
2804
- label="label",
2884
+ label="x",
2805
2885
  )
2806
2886
 
2807
2887
  ```
@@ -2889,6 +2969,7 @@ Used to delete a Document Index given its ID or name.
2889
2969
  from vellum import Vellum
2890
2970
 
2891
2971
  client = Vellum(
2972
+ api_version="YOUR_API_VERSION",
2892
2973
  api_key="YOUR_API_KEY",
2893
2974
  )
2894
2975
  client.document_indexes.destroy(
@@ -2959,6 +3040,7 @@ Used to partial update a Document Index given its ID or name.
2959
3040
  from vellum import Vellum
2960
3041
 
2961
3042
  client = Vellum(
3043
+ api_version="YOUR_API_VERSION",
2962
3044
  api_key="YOUR_API_KEY",
2963
3045
  )
2964
3046
  client.document_indexes.partial_update(
@@ -3050,6 +3132,7 @@ Adds a previously uploaded Document to the specified Document Index.
3050
3132
  from vellum import Vellum
3051
3133
 
3052
3134
  client = Vellum(
3135
+ api_version="YOUR_API_VERSION",
3053
3136
  api_key="YOUR_API_KEY",
3054
3137
  )
3055
3138
  client.document_indexes.add_document(
@@ -3129,6 +3212,7 @@ Removes a Document from a Document Index without deleting the Document itself.
3129
3212
  from vellum import Vellum
3130
3213
 
3131
3214
  client = Vellum(
3215
+ api_version="YOUR_API_VERSION",
3132
3216
  api_key="YOUR_API_KEY",
3133
3217
  )
3134
3218
  client.document_indexes.remove_document(
@@ -3209,6 +3293,7 @@ Used to list documents. Optionally filter on supported fields.
3209
3293
  from vellum import Vellum
3210
3294
 
3211
3295
  client = Vellum(
3296
+ api_version="YOUR_API_VERSION",
3212
3297
  api_key="YOUR_API_KEY",
3213
3298
  )
3214
3299
  client.documents.list()
@@ -3309,6 +3394,7 @@ Retrieve a Document, keying off of either its Vellum-generated ID or its externa
3309
3394
  from vellum import Vellum
3310
3395
 
3311
3396
  client = Vellum(
3397
+ api_version="YOUR_API_VERSION",
3312
3398
  api_key="YOUR_API_KEY",
3313
3399
  )
3314
3400
  client.documents.retrieve(
@@ -3379,6 +3465,7 @@ Delete a Document, keying off of either its Vellum-generated ID or its external
3379
3465
  from vellum import Vellum
3380
3466
 
3381
3467
  client = Vellum(
3468
+ api_version="YOUR_API_VERSION",
3382
3469
  api_key="YOUR_API_KEY",
3383
3470
  )
3384
3471
  client.documents.destroy(
@@ -3449,6 +3536,7 @@ Update a Document, keying off of either its Vellum-generated ID or its external
3449
3536
  from vellum import Vellum
3450
3537
 
3451
3538
  client = Vellum(
3539
+ api_version="YOUR_API_VERSION",
3452
3540
  api_key="YOUR_API_KEY",
3453
3541
  )
3454
3542
  client.documents.partial_update(
@@ -3521,120 +3609,6 @@ The current status of the document
3521
3609
  </dl>
3522
3610
 
3523
3611
 
3524
- </dd>
3525
- </dl>
3526
- </details>
3527
-
3528
- <details><summary><code>client.documents.<a href="src/vellum/resources/documents/client.py">upload</a>(...)</code></summary>
3529
- <dl>
3530
- <dd>
3531
-
3532
- #### 📝 Description
3533
-
3534
- <dl>
3535
- <dd>
3536
-
3537
- <dl>
3538
- <dd>
3539
-
3540
- Upload a document to be indexed and used for search.
3541
-
3542
- **Note:** Uses a base url of `https://documents.vellum.ai`.
3543
- </dd>
3544
- </dl>
3545
- </dd>
3546
- </dl>
3547
-
3548
- #### 🔌 Usage
3549
-
3550
- <dl>
3551
- <dd>
3552
-
3553
- <dl>
3554
- <dd>
3555
-
3556
- ```python
3557
- from vellum import Vellum
3558
-
3559
- client = Vellum(
3560
- api_key="YOUR_API_KEY",
3561
- )
3562
- client.documents.upload(
3563
- label="label",
3564
- )
3565
-
3566
- ```
3567
- </dd>
3568
- </dl>
3569
- </dd>
3570
- </dl>
3571
-
3572
- #### ⚙️ Parameters
3573
-
3574
- <dl>
3575
- <dd>
3576
-
3577
- <dl>
3578
- <dd>
3579
-
3580
- **label:** `str` — A human-friendly name for this document. Typically the filename.
3581
-
3582
- </dd>
3583
- </dl>
3584
-
3585
- <dl>
3586
- <dd>
3587
-
3588
- **contents:** `from __future__ import annotations
3589
-
3590
- core.File` — See core.File for more documentation
3591
-
3592
- </dd>
3593
- </dl>
3594
-
3595
- <dl>
3596
- <dd>
3597
-
3598
- **add_to_index_names:** `typing.Optional[typing.List[str]]` — Optionally include the names of all indexes that you'd like this document to be included in
3599
-
3600
- </dd>
3601
- </dl>
3602
-
3603
- <dl>
3604
- <dd>
3605
-
3606
- **external_id:** `typing.Optional[str]` — Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
3607
-
3608
- </dd>
3609
- </dl>
3610
-
3611
- <dl>
3612
- <dd>
3613
-
3614
- **keywords:** `typing.Optional[typing.List[str]]` — Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
3615
-
3616
- </dd>
3617
- </dl>
3618
-
3619
- <dl>
3620
- <dd>
3621
-
3622
- **metadata:** `typing.Optional[str]` — A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
3623
-
3624
- </dd>
3625
- </dl>
3626
-
3627
- <dl>
3628
- <dd>
3629
-
3630
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
3631
-
3632
- </dd>
3633
- </dl>
3634
- </dd>
3635
- </dl>
3636
-
3637
-
3638
3612
  </dd>
3639
3613
  </dl>
3640
3614
  </details>
@@ -3670,6 +3644,7 @@ List all folder entities within a specified folder.
3670
3644
  from vellum import Vellum
3671
3645
 
3672
3646
  client = Vellum(
3647
+ api_version="YOUR_API_VERSION",
3673
3648
  api_key="YOUR_API_KEY",
3674
3649
  )
3675
3650
  client.folder_entities.list(
@@ -3788,6 +3763,7 @@ Adding an entity to a folder will remove it from any other folders it might have
3788
3763
  from vellum import Vellum
3789
3764
 
3790
3765
  client = Vellum(
3766
+ api_version="YOUR_API_VERSION",
3791
3767
  api_key="YOUR_API_KEY",
3792
3768
  )
3793
3769
  client.folder_entities.add_entity_to_folder(
@@ -3861,15 +3837,20 @@ directory. Supported root directories include:
3861
3837
  from vellum import StringInput, Vellum
3862
3838
 
3863
3839
  client = Vellum(
3840
+ api_version="YOUR_API_VERSION",
3864
3841
  api_key="YOUR_API_KEY",
3865
3842
  )
3866
3843
  client.metric_definitions.execute_metric_definition(
3867
3844
  id="id",
3868
3845
  inputs=[
3869
3846
  StringInput(
3870
- name="name",
3847
+ name="x",
3848
+ value="value",
3849
+ ),
3850
+ StringInput(
3851
+ name="x",
3871
3852
  value="value",
3872
- )
3853
+ ),
3873
3854
  ],
3874
3855
  )
3875
3856
 
@@ -3939,6 +3920,7 @@ client.metric_definitions.execute_metric_definition(
3939
3920
  from vellum import Vellum
3940
3921
 
3941
3922
  client = Vellum(
3923
+ api_version="YOUR_API_VERSION",
3942
3924
  api_key="YOUR_API_KEY",
3943
3925
  )
3944
3926
  client.metric_definitions.metric_definition_history_item_retrieve(
@@ -4019,6 +4001,7 @@ Retrieve details about an ML Model
4019
4001
  from vellum import Vellum
4020
4002
 
4021
4003
  client = Vellum(
4004
+ api_version="YOUR_API_VERSION",
4022
4005
  api_key="YOUR_API_KEY",
4023
4006
  )
4024
4007
  client.ml_models.retrieve(
@@ -4090,6 +4073,7 @@ Retrieves information about the active Organization
4090
4073
  from vellum import Vellum
4091
4074
 
4092
4075
  client = Vellum(
4076
+ api_version="YOUR_API_VERSION",
4093
4077
  api_key="YOUR_API_KEY",
4094
4078
  )
4095
4079
  client.organizations.organization_identity()
@@ -4151,6 +4135,7 @@ Used to pull the definition of a Prompt from Vellum.
4151
4135
  from vellum import Vellum
4152
4136
 
4153
4137
  client = Vellum(
4138
+ api_version="YOUR_API_VERSION",
4154
4139
  api_key="YOUR_API_KEY",
4155
4140
  )
4156
4141
  client.prompts.pull(
@@ -4235,6 +4220,7 @@ from vellum import (
4235
4220
  )
4236
4221
 
4237
4222
  client = Vellum(
4223
+ api_version="YOUR_API_VERSION",
4238
4224
  api_key="YOUR_API_KEY",
4239
4225
  )
4240
4226
  client.prompts.push(
@@ -4242,16 +4228,24 @@ client.prompts.push(
4242
4228
  ml_model="ml_model",
4243
4229
  input_variables=[
4244
4230
  VellumVariable(
4245
- id="id",
4231
+ id="x",
4246
4232
  key="key",
4247
4233
  type="STRING",
4248
- )
4234
+ ),
4235
+ VellumVariable(
4236
+ id="x",
4237
+ key="key",
4238
+ type="STRING",
4239
+ ),
4249
4240
  ],
4250
4241
  parameters=PromptParameters(),
4251
4242
  blocks=[
4252
4243
  JinjaPromptBlock(
4253
4244
  template="template",
4254
- )
4245
+ ),
4246
+ JinjaPromptBlock(
4247
+ template="template",
4248
+ ),
4255
4249
  ],
4256
4250
  ),
4257
4251
  )
@@ -4331,6 +4325,7 @@ client.prompts.push(
4331
4325
  from vellum import Vellum
4332
4326
 
4333
4327
  client = Vellum(
4328
+ api_version="YOUR_API_VERSION",
4334
4329
  api_key="YOUR_API_KEY",
4335
4330
  )
4336
4331
  client.sandboxes.deploy_prompt(
@@ -4453,32 +4448,21 @@ or overwritten with default values.
4453
4448
  <dd>
4454
4449
 
4455
4450
  ```python
4456
- from vellum import (
4457
- ChatMessageRequest,
4458
- NamedScenarioInputChatHistoryVariableValueRequest,
4459
- Vellum,
4460
- )
4451
+ from vellum import NamedScenarioInputStringVariableValueRequest, Vellum
4461
4452
 
4462
4453
  client = Vellum(
4454
+ api_version="YOUR_API_VERSION",
4463
4455
  api_key="YOUR_API_KEY",
4464
4456
  )
4465
4457
  client.sandboxes.upsert_sandbox_scenario(
4466
4458
  id="id",
4467
- label="Scenario 2",
4468
4459
  inputs=[
4469
- NamedScenarioInputChatHistoryVariableValueRequest(
4470
- value=[
4471
- ChatMessageRequest(
4472
- text="What's your favorite color?",
4473
- role="USER",
4474
- ),
4475
- ChatMessageRequest(
4476
- text="AI's don't have a favorite color.... Yet.",
4477
- role="ASSISTANT",
4478
- ),
4479
- ],
4480
- name="chat_history",
4481
- )
4460
+ NamedScenarioInputStringVariableValueRequest(
4461
+ name="x",
4462
+ ),
4463
+ NamedScenarioInputStringVariableValueRequest(
4464
+ name="x",
4465
+ ),
4482
4466
  ],
4483
4467
  )
4484
4468
 
@@ -4570,6 +4554,7 @@ Deletes an existing scenario from a sandbox, keying off of the provided scenario
4570
4554
  from vellum import Vellum
4571
4555
 
4572
4556
  client = Vellum(
4557
+ api_version="YOUR_API_VERSION",
4573
4558
  api_key="YOUR_API_KEY",
4574
4559
  )
4575
4560
  client.sandboxes.delete_sandbox_scenario(
@@ -4654,6 +4639,7 @@ from vellum import (
4654
4639
  )
4655
4640
 
4656
4641
  client = Vellum(
4642
+ api_version="YOUR_API_VERSION",
4657
4643
  api_key="YOUR_API_KEY",
4658
4644
  )
4659
4645
  client.test_suite_runs.create(
@@ -4744,6 +4730,7 @@ Retrieve a specific Test Suite Run by ID
4744
4730
  from vellum import Vellum
4745
4731
 
4746
4732
  client = Vellum(
4733
+ api_version="YOUR_API_VERSION",
4747
4734
  api_key="YOUR_API_KEY",
4748
4735
  )
4749
4736
  client.test_suite_runs.retrieve(
@@ -4800,6 +4787,7 @@ client.test_suite_runs.retrieve(
4800
4787
  from vellum import Vellum
4801
4788
 
4802
4789
  client = Vellum(
4790
+ api_version="YOUR_API_VERSION",
4803
4791
  api_key="YOUR_API_KEY",
4804
4792
  )
4805
4793
  client.test_suite_runs.list_executions(
@@ -4900,6 +4888,7 @@ List the Test Cases associated with a Test Suite
4900
4888
  from vellum import Vellum
4901
4889
 
4902
4890
  client = Vellum(
4891
+ api_version="YOUR_API_VERSION",
4903
4892
  api_key="YOUR_API_KEY",
4904
4893
  )
4905
4894
  client.test_suites.list_test_suite_test_cases(
@@ -4989,40 +4978,29 @@ or overwritten with default values.
4989
4978
  <dd>
4990
4979
 
4991
4980
  ```python
4992
- from vellum import (
4993
- NamedTestCaseArrayVariableValueRequest,
4994
- NamedTestCaseStringVariableValueRequest,
4995
- StringVellumValueRequest,
4996
- Vellum,
4997
- )
4981
+ from vellum import NamedTestCaseStringVariableValueRequest, Vellum
4998
4982
 
4999
4983
  client = Vellum(
4984
+ api_version="YOUR_API_VERSION",
5000
4985
  api_key="YOUR_API_KEY",
5001
4986
  )
5002
4987
  client.test_suites.upsert_test_suite_test_case(
5003
4988
  id_="id",
5004
- label="Test Case 1",
5005
4989
  input_values=[
5006
4990
  NamedTestCaseStringVariableValueRequest(
5007
- value="What are your favorite colors?",
5008
- name="var_1",
5009
- )
4991
+ name="x",
4992
+ ),
4993
+ NamedTestCaseStringVariableValueRequest(
4994
+ name="x",
4995
+ ),
5010
4996
  ],
5011
4997
  evaluation_values=[
5012
- NamedTestCaseArrayVariableValueRequest(
5013
- value=[
5014
- StringVellumValueRequest(
5015
- value="Red",
5016
- ),
5017
- StringVellumValueRequest(
5018
- value="Green",
5019
- ),
5020
- StringVellumValueRequest(
5021
- value="Blue",
5022
- ),
5023
- ],
5024
- name="var_2",
5025
- )
4998
+ NamedTestCaseStringVariableValueRequest(
4999
+ name="x",
5000
+ ),
5001
+ NamedTestCaseStringVariableValueRequest(
5002
+ name="x",
5003
+ ),
5026
5004
  ],
5027
5005
  )
5028
5006
 
@@ -5135,6 +5113,7 @@ from vellum import (
5135
5113
  )
5136
5114
 
5137
5115
  client = Vellum(
5116
+ api_version="YOUR_API_VERSION",
5138
5117
  api_key="YOUR_API_KEY",
5139
5118
  )
5140
5119
  response = client.test_suites.test_suite_test_cases_bulk(
@@ -5145,16 +5124,43 @@ response = client.test_suites.test_suite_test_cases_bulk(
5145
5124
  data=CreateTestSuiteTestCaseRequest(
5146
5125
  input_values=[
5147
5126
  NamedTestCaseStringVariableValueRequest(
5148
- name="name",
5149
- )
5127
+ name="x",
5128
+ ),
5129
+ NamedTestCaseStringVariableValueRequest(
5130
+ name="x",
5131
+ ),
5150
5132
  ],
5151
5133
  evaluation_values=[
5152
5134
  NamedTestCaseStringVariableValueRequest(
5153
- name="name",
5154
- )
5135
+ name="x",
5136
+ ),
5137
+ NamedTestCaseStringVariableValueRequest(
5138
+ name="x",
5139
+ ),
5155
5140
  ],
5156
5141
  ),
5157
- )
5142
+ ),
5143
+ TestSuiteTestCaseCreateBulkOperationRequest(
5144
+ id="id",
5145
+ data=CreateTestSuiteTestCaseRequest(
5146
+ input_values=[
5147
+ NamedTestCaseStringVariableValueRequest(
5148
+ name="x",
5149
+ ),
5150
+ NamedTestCaseStringVariableValueRequest(
5151
+ name="x",
5152
+ ),
5153
+ ],
5154
+ evaluation_values=[
5155
+ NamedTestCaseStringVariableValueRequest(
5156
+ name="x",
5157
+ ),
5158
+ NamedTestCaseStringVariableValueRequest(
5159
+ name="x",
5160
+ ),
5161
+ ],
5162
+ ),
5163
+ ),
5158
5164
  ],
5159
5165
  )
5160
5166
  for chunk in response:
@@ -5232,6 +5238,7 @@ Deletes an existing test case for a test suite, keying off of the test case id.
5232
5238
  from vellum import Vellum
5233
5239
 
5234
5240
  client = Vellum(
5241
+ api_version="YOUR_API_VERSION",
5235
5242
  api_key="YOUR_API_KEY",
5236
5243
  )
5237
5244
  client.test_suites.delete_test_suite_test_case(
@@ -5312,6 +5319,7 @@ Used to list all Workflow Deployments.
5312
5319
  from vellum import Vellum
5313
5320
 
5314
5321
  client = Vellum(
5322
+ api_version="YOUR_API_VERSION",
5315
5323
  api_key="YOUR_API_KEY",
5316
5324
  )
5317
5325
  client.workflow_deployments.list()
@@ -5404,6 +5412,7 @@ Used to retrieve a workflow deployment given its ID or name.
5404
5412
  from vellum import Vellum
5405
5413
 
5406
5414
  client = Vellum(
5415
+ api_version="YOUR_API_VERSION",
5407
5416
  api_key="YOUR_API_KEY",
5408
5417
  )
5409
5418
  client.workflow_deployments.retrieve(
@@ -5460,6 +5469,7 @@ client.workflow_deployments.retrieve(
5460
5469
  from vellum import Vellum
5461
5470
 
5462
5471
  client = Vellum(
5472
+ api_version="YOUR_API_VERSION",
5463
5473
  api_key="YOUR_API_KEY",
5464
5474
  )
5465
5475
  client.workflow_deployments.list_workflow_deployment_event_executions(
@@ -5540,6 +5550,7 @@ client.workflow_deployments.list_workflow_deployment_event_executions(
5540
5550
  from vellum import Vellum
5541
5551
 
5542
5552
  client = Vellum(
5553
+ api_version="YOUR_API_VERSION",
5543
5554
  api_key="YOUR_API_KEY",
5544
5555
  )
5545
5556
  client.workflow_deployments.workflow_deployment_event_execution(
@@ -5620,6 +5631,7 @@ DEPRECATED: This endpoint is deprecated and will be removed in a future release.
5620
5631
  from vellum import Vellum
5621
5632
 
5622
5633
  client = Vellum(
5634
+ api_version="YOUR_API_VERSION",
5623
5635
  api_key="YOUR_API_KEY",
5624
5636
  )
5625
5637
  client.workflow_deployments.workflow_deployment_history_item_retrieve(
@@ -5699,6 +5711,7 @@ List Release Tags associated with the specified Workflow Deployment
5699
5711
  from vellum import Vellum
5700
5712
 
5701
5713
  client = Vellum(
5714
+ api_version="YOUR_API_VERSION",
5702
5715
  api_key="YOUR_API_KEY",
5703
5716
  )
5704
5717
  client.workflow_deployments.list_workflow_release_tags(
@@ -5801,6 +5814,7 @@ Retrieve a Workflow Release Tag by tag name, associated with a specified Workflo
5801
5814
  from vellum import Vellum
5802
5815
 
5803
5816
  client = Vellum(
5817
+ api_version="YOUR_API_VERSION",
5804
5818
  api_key="YOUR_API_KEY",
5805
5819
  )
5806
5820
  client.workflow_deployments.retrieve_workflow_release_tag(
@@ -5880,6 +5894,7 @@ Updates an existing Release Tag associated with the specified Workflow Deploymen
5880
5894
  from vellum import Vellum
5881
5895
 
5882
5896
  client = Vellum(
5897
+ api_version="YOUR_API_VERSION",
5883
5898
  api_key="YOUR_API_KEY",
5884
5899
  )
5885
5900
  client.workflow_deployments.update_workflow_release_tag(
@@ -5968,6 +5983,7 @@ Retrieve a specific Workflow Deployment Release by either its UUID or the name o
5968
5983
  from vellum import Vellum
5969
5984
 
5970
5985
  client = Vellum(
5986
+ api_version="YOUR_API_VERSION",
5971
5987
  api_key="YOUR_API_KEY",
5972
5988
  )
5973
5989
  client.release_reviews.retrieve_workflow_deployment_release(
@@ -6034,6 +6050,7 @@ client.release_reviews.retrieve_workflow_deployment_release(
6034
6050
  from vellum import Vellum
6035
6051
 
6036
6052
  client = Vellum(
6053
+ api_version="YOUR_API_VERSION",
6037
6054
  api_key="YOUR_API_KEY",
6038
6055
  )
6039
6056
  client.workflow_sandboxes.deploy_workflow(
@@ -6153,6 +6170,7 @@ List Workflow Sandbox examples that were previously cloned into the User's Works
6153
6170
  from vellum import Vellum
6154
6171
 
6155
6172
  client = Vellum(
6173
+ api_version="YOUR_API_VERSION",
6156
6174
  api_key="YOUR_API_KEY",
6157
6175
  )
6158
6176
  client.workflow_sandboxes.list_workflow_sandbox_examples()
@@ -6216,104 +6234,6 @@ client.workflow_sandboxes.list_workflow_sandbox_examples()
6216
6234
  </details>
6217
6235
 
6218
6236
  ## Workflows
6219
- <details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">push</a>(...)</code></summary>
6220
- <dl>
6221
- <dd>
6222
-
6223
- #### 🔌 Usage
6224
-
6225
- <dl>
6226
- <dd>
6227
-
6228
- <dl>
6229
- <dd>
6230
-
6231
- ```python
6232
- from vellum import Vellum
6233
-
6234
- client = Vellum(
6235
- api_key="YOUR_API_KEY",
6236
- )
6237
- client.workflows.push(
6238
- exec_config="exec_config",
6239
- )
6240
-
6241
- ```
6242
- </dd>
6243
- </dl>
6244
- </dd>
6245
- </dl>
6246
-
6247
- #### ⚙️ Parameters
6248
-
6249
- <dl>
6250
- <dd>
6251
-
6252
- <dl>
6253
- <dd>
6254
-
6255
- **exec_config:** `WorkflowPushExecConfig` — The execution configuration of the workflow.
6256
-
6257
- </dd>
6258
- </dl>
6259
-
6260
- <dl>
6261
- <dd>
6262
-
6263
- **workflow_sandbox_id:** `typing.Optional[str]`
6264
-
6265
- </dd>
6266
- </dl>
6267
-
6268
- <dl>
6269
- <dd>
6270
-
6271
- **deployment_config:** `typing.Optional[WorkflowPushDeploymentConfigRequest]`
6272
-
6273
- </dd>
6274
- </dl>
6275
-
6276
- <dl>
6277
- <dd>
6278
-
6279
- **artifact:** `from __future__ import annotations
6280
-
6281
- typing.Optional[core.File]` — See core.File for more documentation
6282
-
6283
- </dd>
6284
- </dl>
6285
-
6286
- <dl>
6287
- <dd>
6288
-
6289
- **dry_run:** `typing.Optional[bool]`
6290
-
6291
- </dd>
6292
- </dl>
6293
-
6294
- <dl>
6295
- <dd>
6296
-
6297
- **strict:** `typing.Optional[bool]`
6298
-
6299
- </dd>
6300
- </dl>
6301
-
6302
- <dl>
6303
- <dd>
6304
-
6305
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
6306
-
6307
- </dd>
6308
- </dl>
6309
- </dd>
6310
- </dl>
6311
-
6312
-
6313
- </dd>
6314
- </dl>
6315
- </details>
6316
-
6317
6237
  ## WorkspaceSecrets
6318
6238
  <details><summary><code>client.workspace_secrets.<a href="src/vellum/resources/workspace_secrets/client.py">retrieve</a>(...)</code></summary>
6319
6239
  <dl>
@@ -6345,6 +6265,7 @@ Used to retrieve a Workspace Secret given its ID or name.
6345
6265
  from vellum import Vellum
6346
6266
 
6347
6267
  client = Vellum(
6268
+ api_version="YOUR_API_VERSION",
6348
6269
  api_key="YOUR_API_KEY",
6349
6270
  )
6350
6271
  client.workspace_secrets.retrieve(
@@ -6415,6 +6336,7 @@ Used to update a Workspace Secret given its ID or name.
6415
6336
  from vellum import Vellum
6416
6337
 
6417
6338
  client = Vellum(
6339
+ api_version="YOUR_API_VERSION",
6418
6340
  api_key="YOUR_API_KEY",
6419
6341
  )
6420
6342
  client.workspace_secrets.partial_update(
@@ -6502,6 +6424,7 @@ Retrieves information about the active Workspace
6502
6424
  from vellum import Vellum
6503
6425
 
6504
6426
  client = Vellum(
6427
+ api_version="YOUR_API_VERSION",
6505
6428
  api_key="YOUR_API_KEY",
6506
6429
  )
6507
6430
  client.workspaces.workspace_identity()