vellum-ai 0.6.3__py3-none-any.whl → 0.6.5__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.
- vellum/__init__.py +56 -0
 - vellum/client.py +8 -12
 - vellum/core/client_wrapper.py +1 -1
 - vellum/resources/test_suites/client.py +175 -6
 - vellum/types/__init__.py +60 -0
 - vellum/types/bulk_create_test_suite_test_case_data_request.py +39 -0
 - vellum/types/bulk_replace_test_suite_test_case_data_request.py +44 -0
 - vellum/types/create_enum.py +5 -0
 - vellum/types/created_enum.py +5 -0
 - vellum/types/delete_enum.py +5 -0
 - vellum/types/deleted_enum.py +5 -0
 - vellum/types/deployment_read.py +5 -0
 - vellum/types/replace_enum.py +5 -0
 - vellum/types/replaced_enum.py +5 -0
 - vellum/types/test_suite_test_case_bulk_operation_request.py +46 -0
 - vellum/types/test_suite_test_case_bulk_result.py +58 -0
 - vellum/types/test_suite_test_case_create_bulk_operation_request.py +35 -0
 - vellum/types/test_suite_test_case_created_bulk_result.py +31 -0
 - vellum/types/test_suite_test_case_created_bulk_result_data.py +29 -0
 - vellum/types/test_suite_test_case_delete_bulk_operation_data_request.py +25 -0
 - vellum/types/test_suite_test_case_delete_bulk_operation_request.py +38 -0
 - vellum/types/test_suite_test_case_deleted_bulk_result.py +35 -0
 - vellum/types/test_suite_test_case_deleted_bulk_result_data.py +29 -0
 - vellum/types/test_suite_test_case_rejected_bulk_result.py +37 -0
 - vellum/types/test_suite_test_case_replace_bulk_operation_request.py +35 -0
 - vellum/types/test_suite_test_case_replaced_bulk_result.py +35 -0
 - vellum/types/test_suite_test_case_replaced_bulk_result_data.py +29 -0
 - vellum/types/workflow_deployment_read.py +5 -0
 - vellum_ai-0.6.5.dist-info/METADATA +126 -0
 - {vellum_ai-0.6.3.dist-info → vellum_ai-0.6.5.dist-info}/RECORD +32 -11
 - vellum_ai-0.6.3.dist-info/METADATA +0 -109
 - {vellum_ai-0.6.3.dist-info → vellum_ai-0.6.5.dist-info}/LICENSE +0 -0
 - {vellum_ai-0.6.3.dist-info → vellum_ai-0.6.5.dist-info}/WHEEL +0 -0
 
| 
         @@ -1,8 +1,8 @@ 
     | 
|
| 
       1 
     | 
    
         
            -
            vellum/__init__.py,sha256= 
     | 
| 
       2 
     | 
    
         
            -
            vellum/client.py,sha256= 
     | 
| 
      
 1 
     | 
    
         
            +
            vellum/__init__.py,sha256=7aKsuZge9dDZncC299GYskQc1AJ1GUkJ64doEDqHmS4,44855
         
     | 
| 
      
 2 
     | 
    
         
            +
            vellum/client.py,sha256=FklbOzCaDTPP_EQn0HJXUq1_ZFOHuSePt6_nVQ_YLgY,97463
         
     | 
| 
       3 
3 
     | 
    
         
             
            vellum/core/__init__.py,sha256=1pNSKkwyQvMl_F0wohBqmoQAITptg3zlvCwsoSSzy7c,853
         
     | 
| 
       4 
4 
     | 
    
         
             
            vellum/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
         
     | 
| 
       5 
     | 
    
         
            -
            vellum/core/client_wrapper.py,sha256 
     | 
| 
      
 5 
     | 
    
         
            +
            vellum/core/client_wrapper.py,sha256=qDiIYijRBOToj6MOYVMjrOKpLovjDPs7PkLNsbJSgGM,1697
         
     | 
| 
       6 
6 
     | 
    
         
             
            vellum/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
         
     | 
| 
       7 
7 
     | 
    
         
             
            vellum/core/file.py,sha256=sy1RUGZ3aJYuw998bZytxxo6QdgKmlnlgBaMvwEKCGg,1480
         
     | 
| 
       8 
8 
     | 
    
         
             
            vellum/core/http_client.py,sha256=5ok6hqgZDJhg57EHvMnr0BBaHdG50QxFPKaCZ9aVWTc,5059
         
     | 
| 
         @@ -44,7 +44,7 @@ vellum/resources/sandboxes/client.py,sha256=Lm45GGIRSODx5WJbyXP3ThR3FB8QSPajMWiq 
     | 
|
| 
       44 
44 
     | 
    
         
             
            vellum/resources/test_suite_runs/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
         
     | 
| 
       45 
45 
     | 
    
         
             
            vellum/resources/test_suite_runs/client.py,sha256=LOcjVwBAgQF__yEGvsbZpjBhefGtLL1vnSqJ1K3uly0,18728
         
     | 
| 
       46 
46 
     | 
    
         
             
            vellum/resources/test_suites/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
         
     | 
| 
       47 
     | 
    
         
            -
            vellum/resources/test_suites/client.py,sha256 
     | 
| 
      
 47 
     | 
    
         
            +
            vellum/resources/test_suites/client.py,sha256=-2c6_FPv0Hh-cni3vDpXb26JJAcW8p1hGXpyYfjs0WM,27268
         
     | 
| 
       48 
48 
     | 
    
         
             
            vellum/resources/workflow_deployments/__init__.py,sha256=-5BCA0kSmW6WUh4gqLuQtHv4zFdt9lccuDwMU5YvEu4,173
         
     | 
| 
       49 
49 
     | 
    
         
             
            vellum/resources/workflow_deployments/client.py,sha256=Oal32DF472B46CBWkb8GgDonjyAFQ28hHV5lq4DF1AM,22437
         
     | 
| 
       50 
50 
     | 
    
         
             
            vellum/resources/workflow_deployments/types/__init__.py,sha256=rmS_4dtbgLHGNQJ_pOloygrjl4sNbKZjTEKBxbMyz6E,208
         
     | 
| 
         @@ -60,7 +60,7 @@ vellum/terraform/document_index/__init__.py,sha256=qq2zENI22bUvqGk_a1lmsoTr5O_xC 
     | 
|
| 
       60 
60 
     | 
    
         
             
            vellum/terraform/provider/__init__.py,sha256=K1yLlTZkYBxhD4bhUV1v23hxDGgbfsAIGsSyeB54dNQ,10298
         
     | 
| 
       61 
61 
     | 
    
         
             
            vellum/terraform/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
         
     | 
| 
       62 
62 
     | 
    
         
             
            vellum/terraform/versions.json,sha256=STW6Mg3BKDacFmbWHXziHxE90GWncZf4AIzCLiXm_7o,56
         
     | 
| 
       63 
     | 
    
         
            -
            vellum/types/__init__.py,sha256= 
     | 
| 
      
 63 
     | 
    
         
            +
            vellum/types/__init__.py,sha256=m_bPT573NbzP7hGs8Ykc-qbN9XnIT3pSO0Mox1iwH_8,60130
         
     | 
| 
       64 
64 
     | 
    
         
             
            vellum/types/add_openai_api_key_enum.py,sha256=GB7sLK_Ou7-Xn73sKJHUo6Gx3TjyhU7uJvWZAg4UeaI,92
         
     | 
| 
       65 
65 
     | 
    
         
             
            vellum/types/api_node_result.py,sha256=SvYIi1T-N_P3FVjzv9I91PaCT0IN958A3easp5Q7jqE,983
         
     | 
| 
       66 
66 
     | 
    
         
             
            vellum/types/api_node_result_data.py,sha256=KFBmmizcEg73GwQMXUtEdJ4e9YGFpRLYAnalwxIcDug,1161
         
     | 
| 
         @@ -77,6 +77,8 @@ vellum/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_cos_v_1. 
     | 
|
| 
       77 
77 
     | 
    
         
             
            vellum/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_cos_v_1_request.py,sha256=grnDm5vh1wofvXLCQVUfA2wYYFce03hRGHCECNFJ7kk,1043
         
     | 
| 
       78 
78 
     | 
    
         
             
            vellum/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_dot_v_1.py,sha256=HbB1bJpoUuRt-orgOThdrcB0RiBTNHVuTBOehitN3tQ,1036
         
     | 
| 
       79 
79 
     | 
    
         
             
            vellum/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_dot_v_1_request.py,sha256=0N_YrysJ-HVPBaUDD56V1Fxu1aZQJNMt7O6heY-Z5hY,1043
         
     | 
| 
      
 80 
     | 
    
         
            +
            vellum/types/bulk_create_test_suite_test_case_data_request.py,sha256=hY6n2s-bmZrxR3Nyb2xhetqRNkYbH7BK-cAxz44VBPs,1376
         
     | 
| 
      
 81 
     | 
    
         
            +
            vellum/types/bulk_replace_test_suite_test_case_data_request.py,sha256=d_SQFs_wCcBbAo31ze9xGZixSegw6nDQqs0VbIcJf6g,1469
         
     | 
| 
       80 
82 
     | 
    
         
             
            vellum/types/chat_history_enum.py,sha256=etXbSJGuOjEcYXyCoQEw0bd9sfbZZNctMQyFoCdnywM,129
         
     | 
| 
       81 
83 
     | 
    
         
             
            vellum/types/chat_history_input_request.py,sha256=iBqK5uT7wzR2C9TPvtQfugUeL1-4kOg_KQAc7fWYpnk,1121
         
     | 
| 
       82 
84 
     | 
    
         
             
            vellum/types/chat_message.py,sha256=jROO5ASj_l0MoGGmno1TCUP7aMLIk48miMDWHpKUn_w,1213
         
     | 
| 
         @@ -97,8 +99,12 @@ vellum/types/code_execution_node_search_results_result.py,sha256=sX2alyDbwH6M8X- 
     | 
|
| 
       97 
99 
     | 
    
         
             
            vellum/types/code_execution_node_string_result.py,sha256=w_FeNnHyjpc-bjXPKBxHywO6lLszNGqia9xgYInIs0w,903
         
     | 
| 
       98 
100 
     | 
    
         
             
            vellum/types/conditional_node_result.py,sha256=mR8FHOnTwLDO8U5uVNB2SkDrJSDRkcyLqXPSSL8Dil4,1022
         
     | 
| 
       99 
101 
     | 
    
         
             
            vellum/types/conditional_node_result_data.py,sha256=BoSK8B_qDx-CztZw5qwl2Gk0Ow56gifNu2Ahg-P15iE,898
         
     | 
| 
      
 102 
     | 
    
         
            +
            vellum/types/create_enum.py,sha256=38jp66mStym6pDxoXS4z6y7bfArh1jgjjV8xgf4KBBw,118
         
     | 
| 
      
 103 
     | 
    
         
            +
            vellum/types/created_enum.py,sha256=_dfKJhEenYcIUYY1uKQuq1uNS3k9HbPGCxXnW-Tu5uo,120
         
     | 
| 
      
 104 
     | 
    
         
            +
            vellum/types/delete_enum.py,sha256=g6Rnc2pbgXkEbqhG0Bx1z-ZGr4DMkb8QK8du9dQQcpQ,118
         
     | 
| 
      
 105 
     | 
    
         
            +
            vellum/types/deleted_enum.py,sha256=F7VTcnxIkXrwyQr5CjGikBbCnlo6To_rP0pibWm-ioo,120
         
     | 
| 
       100 
106 
     | 
    
         
             
            vellum/types/deployment_provider_payload_response.py,sha256=nEw7v0EVo3NgKDVtsBMjd9XLWmFAGk59U1Z-qSs-Stc,898
         
     | 
| 
       101 
     | 
    
         
            -
            vellum/types/deployment_read.py,sha256= 
     | 
| 
      
 107 
     | 
    
         
            +
            vellum/types/deployment_read.py,sha256=Ob9ArdqKJb5vjRx26hX_iOnPF2MwtBYxB5xx2LVNbEk,2100
         
     | 
| 
       102 
108 
     | 
    
         
             
            vellum/types/deployment_release_tag_deployment_history_item.py,sha256=997C-J0NOEvOm7Y_dyyaqYvKMIEHCDj0JEpAcmOjOEQ,903
         
     | 
| 
       103 
109 
     | 
    
         
             
            vellum/types/deployment_release_tag_read.py,sha256=o0X8dMSqajT3-lEnLk9tRb8PRhs3l3M4iBM7CX9316c,1432
         
     | 
| 
       104 
110 
     | 
    
         
             
            vellum/types/document_document_to_document_index.py,sha256=kCPPJFnXu9HFZbk7PgRCtRDj5Cw2_0yEPjAStm-YC2E,1532
         
     | 
| 
         @@ -268,6 +274,8 @@ vellum/types/rejected_execute_workflow_workflow_result_event.py,sha256=acYvyXoZf 
     | 
|
| 
       268 
274 
     | 
    
         
             
            vellum/types/rejected_prompt_execution_meta.py,sha256=kBS6bThYk1vvhKv47UB0FZP7WuCBoCAsbTnK43XQWbI,1138
         
     | 
| 
       269 
275 
     | 
    
         
             
            vellum/types/rejected_workflow_node_result_event.py,sha256=NbHR7Dhd9QBxDY9AMVM3uHx6HkgPiW6C0LaBGktGycA,1293
         
     | 
| 
       270 
276 
     | 
    
         
             
            vellum/types/release_tag_source.py,sha256=YavosOXZ976yfXTNWRTZwh2HhRiYmSDk0bQCkl-jCoQ,158
         
     | 
| 
      
 277 
     | 
    
         
            +
            vellum/types/replace_enum.py,sha256=A27UrZHyriKUSLCJDDG3mQmWyoFDpUKiutwfhZMc0Sw,120
         
     | 
| 
      
 278 
     | 
    
         
            +
            vellum/types/replaced_enum.py,sha256=oC-pUajQvOhS1G5G55GS2Jdaityny520XbnrD1nuOD8,122
         
     | 
| 
       271 
279 
     | 
    
         
             
            vellum/types/sandbox_scenario.py,sha256=-MaSvpH6jSokr5XsCZybafKez3fnPctTFqm30Lfk8Ko,1144
         
     | 
| 
       272 
280 
     | 
    
         
             
            vellum/types/scenario_input.py,sha256=6_jN2JaqgEOkQpP5h17l5HeRhI_kdNMD_jjVyNFDM7Q,907
         
     | 
| 
       273 
281 
     | 
    
         
             
            vellum/types/scenario_input_chat_history_variable_value.py,sha256=j5CbnDsEQYHwVxXLSJFrXMDYKHCnvGYgDpozJ9NxB0A,1071
         
     | 
| 
         @@ -380,6 +388,19 @@ vellum/types/test_suite_run_workflow_release_tag_exec_config_data_request.py,sha 
     | 
|
| 
       380 
388 
     | 
    
         
             
            vellum/types/test_suite_run_workflow_release_tag_exec_config_request.py,sha256=P0zRtzh7ekun8pcEH2EFTB6p4Kq54cE955Vff4q6-dE,1405
         
     | 
| 
       381 
389 
     | 
    
         
             
            vellum/types/test_suite_run_workflow_release_tag_exec_config_type_enum.py,sha256=JMN3-aK8SWJzTli6c-j9xmHSYVwGND1PaZgGzwwkMjo,170
         
     | 
| 
       382 
390 
     | 
    
         
             
            vellum/types/test_suite_test_case.py,sha256=Zi4uLAXIgZnecVdrG0BTKA4I8Ri_Qrt83OuClyQkzIc,1086
         
     | 
| 
      
 391 
     | 
    
         
            +
            vellum/types/test_suite_test_case_bulk_operation_request.py,sha256=eDAZV9NwbvH_dhaTmzUaHC5858B47Dqz7Dq6_kIXtu0,1528
         
     | 
| 
      
 392 
     | 
    
         
            +
            vellum/types/test_suite_test_case_bulk_result.py,sha256=Cu3zBu6PFltkTsQRcdzA5dcVAyESK6U3jMcMfe28K44,1798
         
     | 
| 
      
 393 
     | 
    
         
            +
            vellum/types/test_suite_test_case_create_bulk_operation_request.py,sha256=W8-aXODDF5oWjshwJdBagajEzukN2lC-2_9XY27Bmoo,1283
         
     | 
| 
      
 394 
     | 
    
         
            +
            vellum/types/test_suite_test_case_created_bulk_result.py,sha256=hUH8duBtZsrWXp7p0kZeCoP5W48Ioui-9fjoXycCnSA,1094
         
     | 
| 
      
 395 
     | 
    
         
            +
            vellum/types/test_suite_test_case_created_bulk_result_data.py,sha256=7_3ZxGLWHxP0Ggft7LeunDjY0ZaMgJ3yMpgFJRKw1_k,944
         
     | 
| 
      
 396 
     | 
    
         
            +
            vellum/types/test_suite_test_case_delete_bulk_operation_data_request.py,sha256=JUON1LJ8pBIzpsICjk6qIMSzg4Ctjrf2DYCNAzhPwCY,882
         
     | 
| 
      
 397 
     | 
    
         
            +
            vellum/types/test_suite_test_case_delete_bulk_operation_request.py,sha256=UWtptA-rAuDaBL133784D8jn015t__y8NQV1Q7XXDmk,1395
         
     | 
| 
      
 398 
     | 
    
         
            +
            vellum/types/test_suite_test_case_deleted_bulk_result.py,sha256=1CsSapclH45R6Jje8D5fPDvzajUsaMtNbfMIYu0FZuU,1261
         
     | 
| 
      
 399 
     | 
    
         
            +
            vellum/types/test_suite_test_case_deleted_bulk_result_data.py,sha256=ua_wuUfrrXSYbG-m17Hdw1lEJBQnzn8s6M6W2t0RvHA,943
         
     | 
| 
      
 400 
     | 
    
         
            +
            vellum/types/test_suite_test_case_rejected_bulk_result.py,sha256=gvBqlLu-vxRVJIweNaTOS_LSm_JMfLlzPxMUTgYwS0c,1247
         
     | 
| 
      
 401 
     | 
    
         
            +
            vellum/types/test_suite_test_case_replace_bulk_operation_request.py,sha256=ZwmyWyYDQlEaAC6bGQMeHVMQxIucA4hKvMvx4FgAll4,1288
         
     | 
| 
      
 402 
     | 
    
         
            +
            vellum/types/test_suite_test_case_replaced_bulk_result.py,sha256=36m3raleko_4VQXCIGexVlHZ8CiIJ9Fg73vv3Bivuck,1266
         
     | 
| 
      
 403 
     | 
    
         
            +
            vellum/types/test_suite_test_case_replaced_bulk_result_data.py,sha256=fbH0CsKTE-bhEqzCa_ZFR2X3aX7JhungfEfueuIQkP4,945
         
     | 
| 
       383 
404 
     | 
    
         
             
            vellum/types/text_embedding_3_large_enum.py,sha256=mniEbUgFr40fnVAGnlL_aNaFET3PhrQ8flune0mm2H4,147
         
     | 
| 
       384 
405 
     | 
    
         
             
            vellum/types/text_embedding_3_small_enum.py,sha256=_fBJkCGGk8o9FD19oWq_ARJHIU3KjPTKMPGSvAe3Vxw,147
         
     | 
| 
       385 
406 
     | 
    
         
             
            vellum/types/text_embedding_ada_002_enum.py,sha256=FzY5woDqAEElY-ulFR9u7Rrw93KKhGiVwBkrmE1URxM,147
         
     | 
| 
         @@ -397,7 +418,7 @@ vellum/types/vellum_image.py,sha256=1QCMf26kEKRKP9DTxNI0qp7CNC1viWGFV9hmIxFyxoY, 
     | 
|
| 
       397 
418 
     | 
    
         
             
            vellum/types/vellum_image_request.py,sha256=ADerbxbSJHzNYouJa1jaBIGvbHR2nSmqYAxE-cgS2Rg,921
         
     | 
| 
       398 
419 
     | 
    
         
             
            vellum/types/vellum_variable.py,sha256=MPxkKBtuxtg4HZud4xwsyT_sH6FG-YDGeFLpUa4NZDs,944
         
     | 
| 
       399 
420 
     | 
    
         
             
            vellum/types/vellum_variable_type.py,sha256=uHeBCGi7U_SksgKOxtvI4KxYffD4BD2TlddTPo_LUSM,281
         
     | 
| 
       400 
     | 
    
         
            -
            vellum/types/workflow_deployment_read.py,sha256= 
     | 
| 
      
 421 
     | 
    
         
            +
            vellum/types/workflow_deployment_read.py,sha256=010Jqbj-XOXRm4evLM5yIg4RwDVFB5ayKopMIRPUH88,2281
         
     | 
| 
       401 
422 
     | 
    
         
             
            vellum/types/workflow_event_error.py,sha256=1f-xt3rNeCIpSm37KmAqVMc9IEbDD-3pNH4zwBYzXP0,981
         
     | 
| 
       402 
423 
     | 
    
         
             
            vellum/types/workflow_execution_actual_chat_history_request.py,sha256=ZBk37qbr-gXYeFLhgmkQQLKvrtlJCWVe9B6GYjq763o,2223
         
     | 
| 
       403 
424 
     | 
    
         
             
            vellum/types/workflow_execution_actual_json_request.py,sha256=XuiH6iE_NZiut9E3Y8VwiY5rOHx8u3sd2i_TxbfG8d8,2160
         
     | 
| 
         @@ -438,7 +459,7 @@ vellum/types/workflow_result_event_output_data_search_results.py,sha256=gazaUrC5 
     | 
|
| 
       438 
459 
     | 
    
         
             
            vellum/types/workflow_result_event_output_data_string.py,sha256=aVWIIGbLj4TJJhTTj6WzhbYXQkcZatKuhhNy8UYwXbw,1482
         
     | 
| 
       439 
460 
     | 
    
         
             
            vellum/types/workflow_stream_event.py,sha256=KA6Bkk_XA6AIPWR-1vKnwF1A8l_Bm5y0arQCWWWRpsk,911
         
     | 
| 
       440 
461 
     | 
    
         
             
            vellum/version.py,sha256=neLt8HBHHUtDF9M5fsyUzHT-pKooEPvceaLDqqIGb0s,77
         
     | 
| 
       441 
     | 
    
         
            -
            vellum_ai-0.6. 
     | 
| 
       442 
     | 
    
         
            -
            vellum_ai-0.6. 
     | 
| 
       443 
     | 
    
         
            -
            vellum_ai-0.6. 
     | 
| 
       444 
     | 
    
         
            -
            vellum_ai-0.6. 
     | 
| 
      
 462 
     | 
    
         
            +
            vellum_ai-0.6.5.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
         
     | 
| 
      
 463 
     | 
    
         
            +
            vellum_ai-0.6.5.dist-info/METADATA,sha256=LRrhuNTE8VAO6jeFWXRA5RDnsW1OtcniYmYj_nGX548,3872
         
     | 
| 
      
 464 
     | 
    
         
            +
            vellum_ai-0.6.5.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
         
     | 
| 
      
 465 
     | 
    
         
            +
            vellum_ai-0.6.5.dist-info/RECORD,,
         
     | 
| 
         @@ -1,109 +0,0 @@ 
     | 
|
| 
       1 
     | 
    
         
            -
            Metadata-Version: 2.1
         
     | 
| 
       2 
     | 
    
         
            -
            Name: vellum-ai
         
     | 
| 
       3 
     | 
    
         
            -
            Version: 0.6.3
         
     | 
| 
       4 
     | 
    
         
            -
            Summary: 
         
     | 
| 
       5 
     | 
    
         
            -
            Requires-Python: >=3.8,<4.0
         
     | 
| 
       6 
     | 
    
         
            -
            Classifier: Programming Language :: Python :: 3
         
     | 
| 
       7 
     | 
    
         
            -
            Classifier: Programming Language :: Python :: 3.8
         
     | 
| 
       8 
     | 
    
         
            -
            Classifier: Programming Language :: Python :: 3.9
         
     | 
| 
       9 
     | 
    
         
            -
            Classifier: Programming Language :: Python :: 3.10
         
     | 
| 
       10 
     | 
    
         
            -
            Classifier: Programming Language :: Python :: 3.11
         
     | 
| 
       11 
     | 
    
         
            -
            Requires-Dist: cdktf (>=0.20.5,<0.21.0)
         
     | 
| 
       12 
     | 
    
         
            -
            Requires-Dist: httpx (>=0.21.2)
         
     | 
| 
       13 
     | 
    
         
            -
            Requires-Dist: publication (==0.0.3)
         
     | 
| 
       14 
     | 
    
         
            -
            Requires-Dist: pydantic (>=1.9.2)
         
     | 
| 
       15 
     | 
    
         
            -
            Requires-Dist: typing_extensions (>=4.0.0)
         
     | 
| 
       16 
     | 
    
         
            -
            Description-Content-Type: text/markdown
         
     | 
| 
       17 
     | 
    
         
            -
             
     | 
| 
       18 
     | 
    
         
            -
            # Vellum Python Library
         
     | 
| 
       19 
     | 
    
         
            -
             
     | 
| 
       20 
     | 
    
         
            -
            [](https://pypi.python.org/pypi/vellum-ai)
         
     | 
| 
       21 
     | 
    
         
            -
            [](https://buildwithfern.com/?utm_source=vellum-ai/vellum-client-python/readme)
         
     | 
| 
       22 
     | 
    
         
            -
             
     | 
| 
       23 
     | 
    
         
            -
            The Vellum Python Library provides access to the Vellum API from python.
         
     | 
| 
       24 
     | 
    
         
            -
             
     | 
| 
       25 
     | 
    
         
            -
             
     | 
| 
       26 
     | 
    
         
            -
            ## API Docs
         
     | 
| 
       27 
     | 
    
         
            -
            You can find Vellum's complete API docs at [docs.vellum.ai](https://docs.vellum.ai).
         
     | 
| 
       28 
     | 
    
         
            -
             
     | 
| 
       29 
     | 
    
         
            -
            ## Installation
         
     | 
| 
       30 
     | 
    
         
            -
             
     | 
| 
       31 
     | 
    
         
            -
            ```sh
         
     | 
| 
       32 
     | 
    
         
            -
            pip install --upgrade vellum-ai
         
     | 
| 
       33 
     | 
    
         
            -
            ```
         
     | 
| 
       34 
     | 
    
         
            -
             
     | 
| 
       35 
     | 
    
         
            -
            ## Usage
         
     | 
| 
       36 
     | 
    
         
            -
             
     | 
| 
       37 
     | 
    
         
            -
            ```python
         
     | 
| 
       38 
     | 
    
         
            -
            import vellum
         
     | 
| 
       39 
     | 
    
         
            -
            from vellum.client import Vellum
         
     | 
| 
       40 
     | 
    
         
            -
             
     | 
| 
       41 
     | 
    
         
            -
             
     | 
| 
       42 
     | 
    
         
            -
            client = Vellum(api_key="YOUR_API_KEY")
         
     | 
| 
       43 
     | 
    
         
            -
             
     | 
| 
       44 
     | 
    
         
            -
            result = client.generate(
         
     | 
| 
       45 
     | 
    
         
            -
                deployment_name="my-deployment",
         
     | 
| 
       46 
     | 
    
         
            -
                requests=[
         
     | 
| 
       47 
     | 
    
         
            -
                    vellum.GenerateRequest(
         
     | 
| 
       48 
     | 
    
         
            -
                        input_values={"question": "Can I get a refund?"})]
         
     | 
| 
       49 
     | 
    
         
            -
                )
         
     | 
| 
       50 
     | 
    
         
            -
             
     | 
| 
       51 
     | 
    
         
            -
            print(result.text)
         
     | 
| 
       52 
     | 
    
         
            -
            ```
         
     | 
| 
       53 
     | 
    
         
            -
             
     | 
| 
       54 
     | 
    
         
            -
            ## Async Client
         
     | 
| 
       55 
     | 
    
         
            -
             
     | 
| 
       56 
     | 
    
         
            -
            ```python
         
     | 
| 
       57 
     | 
    
         
            -
            import vellum
         
     | 
| 
       58 
     | 
    
         
            -
            from vellum.client import AsyncVellum
         
     | 
| 
       59 
     | 
    
         
            -
             
     | 
| 
       60 
     | 
    
         
            -
            raven = AsyncVellum(api_key="YOUR_API_KEY")
         
     | 
| 
       61 
     | 
    
         
            -
             
     | 
| 
       62 
     | 
    
         
            -
            async def generate() -> str:
         
     | 
| 
       63 
     | 
    
         
            -
              result = client.generate(
         
     | 
| 
       64 
     | 
    
         
            -
                deployment_name="my-deployment",
         
     | 
| 
       65 
     | 
    
         
            -
                requests=[
         
     | 
| 
       66 
     | 
    
         
            -
                    vellum.GenerateRequest(
         
     | 
| 
       67 
     | 
    
         
            -
                        input_values={"question": "Can I get a refund?"})]
         
     | 
| 
       68 
     | 
    
         
            -
                )
         
     | 
| 
       69 
     | 
    
         
            -
              
         
     | 
| 
       70 
     | 
    
         
            -
              return result.text
         
     | 
| 
       71 
     | 
    
         
            -
            ```
         
     | 
| 
       72 
     | 
    
         
            -
             
     | 
| 
       73 
     | 
    
         
            -
            ## Uploading documents
         
     | 
| 
       74 
     | 
    
         
            -
             
     | 
| 
       75 
     | 
    
         
            -
            Documents can be uploaded to Vellum via either the UI or this API. Once uploaded and indexed, Vellum's Search allows you to perform semantic searches against them.
         
     | 
| 
       76 
     | 
    
         
            -
             
     | 
| 
       77 
     | 
    
         
            -
            ```python
         
     | 
| 
       78 
     | 
    
         
            -
            from vellum.client import Vellum
         
     | 
| 
       79 
     | 
    
         
            -
             
     | 
| 
       80 
     | 
    
         
            -
            client = Vellum(api_key="YOUR_API_KEY")
         
     | 
| 
       81 
     | 
    
         
            -
             
     | 
| 
       82 
     | 
    
         
            -
            with open("/path/to/your/file.txt", "rb") as file:
         
     | 
| 
       83 
     | 
    
         
            -
                result = client.documents.upload(
         
     | 
| 
       84 
     | 
    
         
            -
                    # File to upload
         
     | 
| 
       85 
     | 
    
         
            -
                    contents=file,
         
     | 
| 
       86 
     | 
    
         
            -
                    # Document label
         
     | 
| 
       87 
     | 
    
         
            -
                    label="Human-friendly label for your document",
         
     | 
| 
       88 
     | 
    
         
            -
                    # The names of indexes that you'd like this document to be added to.
         
     | 
| 
       89 
     | 
    
         
            -
                    add_to_index_names=["<your-index-name>"],
         
     | 
| 
       90 
     | 
    
         
            -
                    # Optionally include a unique ID from your system to this document later.
         
     | 
| 
       91 
     | 
    
         
            -
                    #   Useful if you want to perform updates later
         
     | 
| 
       92 
     | 
    
         
            -
                    external_id="<your-index-name>",
         
     | 
| 
       93 
     | 
    
         
            -
                    # Optionally include keywords to associate with the document that can be used in hybrid search
         
     | 
| 
       94 
     | 
    
         
            -
                    keywords=[],
         
     | 
| 
       95 
     | 
    
         
            -
                )
         
     | 
| 
       96 
     | 
    
         
            -
             
     | 
| 
       97 
     | 
    
         
            -
            print(result)
         
     | 
| 
       98 
     | 
    
         
            -
            ```
         
     | 
| 
       99 
     | 
    
         
            -
             
     | 
| 
       100 
     | 
    
         
            -
            ## Beta status
         
     | 
| 
       101 
     | 
    
         
            -
             
     | 
| 
       102 
     | 
    
         
            -
            This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
         
     | 
| 
       103 
     | 
    
         
            -
             
     | 
| 
       104 
     | 
    
         
            -
            ## Contributing
         
     | 
| 
       105 
     | 
    
         
            -
             
     | 
| 
       106 
     | 
    
         
            -
            While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
         
     | 
| 
       107 
     | 
    
         
            -
             
     | 
| 
       108 
     | 
    
         
            -
            On the other hand, contributions to the README are always very welcome!
         
     | 
| 
       109 
     | 
    
         
            -
             
     | 
| 
         
            File without changes
         
     | 
| 
         
            File without changes
         
     |