vellum-ai 0.3.14__py3-none-any.whl → 0.3.16__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (318) hide show
  1. vellum/__init__.py +22 -0
  2. vellum/client.py +846 -100
  3. vellum/core/__init__.py +8 -0
  4. vellum/core/client_wrapper.py +27 -8
  5. vellum/core/file.py +38 -0
  6. vellum/core/http_client.py +130 -0
  7. vellum/core/jsonable_encoder.py +2 -2
  8. vellum/core/request_options.py +32 -0
  9. vellum/resources/deployments/client.py +161 -24
  10. vellum/resources/document_indexes/client.py +337 -80
  11. vellum/resources/documents/client.py +278 -58
  12. vellum/resources/folder_entities/client.py +60 -10
  13. vellum/resources/model_versions/client.py +48 -8
  14. vellum/resources/registered_prompts/client.py +52 -6
  15. vellum/resources/sandboxes/client.py +108 -26
  16. vellum/resources/test_suite_runs/client.py +221 -38
  17. vellum/resources/test_suites/client.py +110 -24
  18. vellum/resources/workflow_deployments/client.py +110 -14
  19. vellum/types/__init__.py +20 -0
  20. vellum/types/api_node_result.py +1 -0
  21. vellum/types/api_node_result_data.py +4 -2
  22. vellum/types/array_chat_message_content.py +1 -0
  23. vellum/types/array_chat_message_content_item.py +6 -5
  24. vellum/types/array_chat_message_content_item_request.py +6 -5
  25. vellum/types/array_chat_message_content_request.py +1 -0
  26. vellum/types/array_enum.py +2 -2
  27. vellum/types/array_variable_value_item.py +16 -10
  28. vellum/types/chat_history_enum.py +2 -2
  29. vellum/types/chat_history_input_request.py +6 -1
  30. vellum/types/chat_history_variable_value.py +2 -1
  31. vellum/types/chat_message.py +7 -5
  32. vellum/types/chat_message_content.py +8 -6
  33. vellum/types/chat_message_content_request.py +8 -6
  34. vellum/types/chat_message_request.py +7 -5
  35. vellum/types/code_execution_node_array_result.py +31 -0
  36. vellum/types/code_execution_node_chat_history_result.py +2 -1
  37. vellum/types/code_execution_node_error_result.py +2 -1
  38. vellum/types/code_execution_node_function_call_result.py +31 -0
  39. vellum/types/code_execution_node_json_result.py +2 -1
  40. vellum/types/code_execution_node_number_result.py +2 -1
  41. vellum/types/code_execution_node_result.py +1 -0
  42. vellum/types/code_execution_node_result_data.py +2 -1
  43. vellum/types/code_execution_node_result_output.py +36 -8
  44. vellum/types/code_execution_node_search_results_result.py +2 -1
  45. vellum/types/code_execution_node_string_result.py +2 -1
  46. vellum/types/conditional_node_result.py +1 -0
  47. vellum/types/conditional_node_result_data.py +2 -1
  48. vellum/types/deployment_provider_payload_response.py +1 -0
  49. vellum/types/deployment_read.py +32 -17
  50. vellum/types/document_document_to_document_index.py +21 -15
  51. vellum/types/document_index_read.py +32 -19
  52. vellum/types/document_read.py +34 -24
  53. vellum/types/document_status.py +2 -2
  54. vellum/types/enriched_normalized_completion.py +36 -19
  55. vellum/types/error_enum.py +2 -2
  56. vellum/types/error_variable_value.py +2 -1
  57. vellum/types/execute_prompt_api_error_response.py +5 -1
  58. vellum/types/execute_prompt_event.py +8 -6
  59. vellum/types/execute_prompt_response.py +4 -4
  60. vellum/types/execute_workflow_error_response.py +5 -1
  61. vellum/types/execute_workflow_response.py +3 -2
  62. vellum/types/execute_workflow_stream_error_response.py +5 -1
  63. vellum/types/execute_workflow_workflow_result_event.py +4 -4
  64. vellum/types/execution_array_vellum_value.py +7 -2
  65. vellum/types/execution_chat_history_vellum_value.py +7 -2
  66. vellum/types/execution_error_vellum_value.py +7 -2
  67. vellum/types/execution_function_call_vellum_value.py +7 -2
  68. vellum/types/execution_json_vellum_value.py +7 -2
  69. vellum/types/execution_number_vellum_value.py +7 -2
  70. vellum/types/execution_search_results_vellum_value.py +7 -2
  71. vellum/types/execution_string_vellum_value.py +7 -2
  72. vellum/types/execution_vellum_value.py +16 -10
  73. vellum/types/fulfilled_enum.py +2 -2
  74. vellum/types/fulfilled_execute_prompt_event.py +2 -1
  75. vellum/types/fulfilled_execute_prompt_response.py +12 -5
  76. vellum/types/fulfilled_execute_workflow_workflow_result_event.py +1 -0
  77. vellum/types/fulfilled_function_call.py +2 -1
  78. vellum/types/fulfilled_prompt_execution_meta.py +3 -2
  79. vellum/types/fulfilled_workflow_node_result_event.py +6 -5
  80. vellum/types/function_call.py +4 -4
  81. vellum/types/function_call_chat_message_content.py +1 -0
  82. vellum/types/function_call_chat_message_content_request.py +1 -0
  83. vellum/types/function_call_chat_message_content_value.py +2 -1
  84. vellum/types/function_call_chat_message_content_value_request.py +2 -1
  85. vellum/types/function_call_enum.py +2 -2
  86. vellum/types/function_call_variable_value.py +1 -0
  87. vellum/types/generate_error_response.py +5 -1
  88. vellum/types/generate_options_request.py +8 -5
  89. vellum/types/generate_request.py +15 -9
  90. vellum/types/generate_result.py +10 -6
  91. vellum/types/generate_result_data.py +5 -3
  92. vellum/types/generate_result_error.py +5 -1
  93. vellum/types/generate_stream_response.py +1 -0
  94. vellum/types/generate_stream_result.py +3 -2
  95. vellum/types/generate_stream_result_data.py +1 -0
  96. vellum/types/image_chat_message_content.py +1 -0
  97. vellum/types/image_chat_message_content_request.py +1 -0
  98. vellum/types/image_enum.py +2 -2
  99. vellum/types/image_variable_value.py +2 -1
  100. vellum/types/initiated_enum.py +2 -2
  101. vellum/types/initiated_execute_prompt_event.py +2 -1
  102. vellum/types/initiated_prompt_execution_meta.py +5 -4
  103. vellum/types/initiated_workflow_node_result_event.py +5 -4
  104. vellum/types/json_enum.py +2 -2
  105. vellum/types/json_input_request.py +6 -1
  106. vellum/types/json_variable_value.py +2 -1
  107. vellum/types/logprobs_enum.py +2 -2
  108. vellum/types/metadata_filter_config_request.py +7 -6
  109. vellum/types/metadata_filter_rule_request.py +7 -6
  110. vellum/types/model_version_build_config.py +12 -7
  111. vellum/types/model_version_exec_config.py +18 -11
  112. vellum/types/model_version_exec_config_parameters.py +7 -6
  113. vellum/types/model_version_read.py +51 -32
  114. vellum/types/model_version_sandbox_snapshot.py +17 -4
  115. vellum/types/named_test_case_chat_history_variable_value_request.py +2 -1
  116. vellum/types/named_test_case_error_variable_value_request.py +2 -1
  117. vellum/types/named_test_case_json_variable_value_request.py +2 -1
  118. vellum/types/named_test_case_number_variable_value_request.py +2 -1
  119. vellum/types/named_test_case_search_results_variable_value_request.py +2 -1
  120. vellum/types/named_test_case_string_variable_value_request.py +2 -1
  121. vellum/types/named_test_case_variable_value_request.py +12 -8
  122. vellum/types/node_input_compiled_array_value.py +2 -1
  123. vellum/types/node_input_compiled_chat_history_value.py +2 -1
  124. vellum/types/node_input_compiled_error_value.py +2 -1
  125. vellum/types/node_input_compiled_function_call.py +32 -0
  126. vellum/types/node_input_compiled_json_value.py +2 -1
  127. vellum/types/node_input_compiled_number_value.py +2 -1
  128. vellum/types/node_input_compiled_search_results_value.py +2 -1
  129. vellum/types/node_input_compiled_string_value.py +2 -1
  130. vellum/types/node_input_variable_compiled_value.py +26 -9
  131. vellum/types/node_output_compiled_array_value.py +2 -1
  132. vellum/types/node_output_compiled_chat_history_value.py +2 -1
  133. vellum/types/node_output_compiled_error_value.py +2 -1
  134. vellum/types/node_output_compiled_function_value.py +2 -1
  135. vellum/types/node_output_compiled_json_value.py +2 -1
  136. vellum/types/node_output_compiled_number_value.py +2 -1
  137. vellum/types/node_output_compiled_search_results_value.py +2 -1
  138. vellum/types/node_output_compiled_string_value.py +2 -1
  139. vellum/types/node_output_compiled_value.py +16 -10
  140. vellum/types/normalized_log_probs.py +2 -1
  141. vellum/types/normalized_token_log_probs.py +3 -2
  142. vellum/types/number_enum.py +2 -2
  143. vellum/types/number_variable_value.py +2 -1
  144. vellum/types/paginated_document_index_read_list.py +5 -4
  145. vellum/types/paginated_slim_deployment_read_list.py +5 -4
  146. vellum/types/paginated_slim_document_list.py +5 -4
  147. vellum/types/paginated_slim_workflow_deployment_list.py +5 -4
  148. vellum/types/paginated_test_suite_run_execution_list.py +5 -4
  149. vellum/types/prompt_deployment_expand_meta_request_request.py +25 -15
  150. vellum/types/prompt_deployment_input_request.py +6 -5
  151. vellum/types/prompt_execution_meta.py +6 -5
  152. vellum/types/prompt_node_result.py +1 -0
  153. vellum/types/prompt_node_result_data.py +4 -3
  154. vellum/types/prompt_output.py +8 -6
  155. vellum/types/prompt_template_block.py +1 -0
  156. vellum/types/prompt_template_block_data.py +1 -0
  157. vellum/types/prompt_template_block_data_request.py +1 -0
  158. vellum/types/prompt_template_block_properties.py +11 -10
  159. vellum/types/prompt_template_block_properties_request.py +11 -10
  160. vellum/types/prompt_template_block_request.py +1 -0
  161. vellum/types/raw_prompt_execution_overrides_request.py +11 -5
  162. vellum/types/register_prompt_error_response.py +5 -1
  163. vellum/types/register_prompt_model_parameters_request.py +5 -4
  164. vellum/types/register_prompt_prompt.py +10 -2
  165. vellum/types/register_prompt_prompt_info_request.py +5 -3
  166. vellum/types/register_prompt_response.py +30 -10
  167. vellum/types/registered_prompt_deployment.py +15 -3
  168. vellum/types/registered_prompt_input_variable_request.py +3 -2
  169. vellum/types/registered_prompt_model_version.py +10 -2
  170. vellum/types/registered_prompt_sandbox.py +10 -2
  171. vellum/types/registered_prompt_sandbox_snapshot.py +5 -1
  172. vellum/types/rejected_enum.py +2 -2
  173. vellum/types/rejected_execute_prompt_event.py +2 -1
  174. vellum/types/rejected_execute_prompt_response.py +12 -5
  175. vellum/types/rejected_execute_workflow_workflow_result_event.py +1 -0
  176. vellum/types/rejected_function_call.py +2 -1
  177. vellum/types/rejected_prompt_execution_meta.py +3 -2
  178. vellum/types/rejected_workflow_node_result_event.py +4 -3
  179. vellum/types/sandbox_scenario.py +11 -3
  180. vellum/types/scenario_input.py +4 -3
  181. vellum/types/scenario_input_request.py +4 -3
  182. vellum/types/search_error_response.py +5 -1
  183. vellum/types/search_filters_request.py +10 -6
  184. vellum/types/search_node_result.py +1 -0
  185. vellum/types/search_node_result_data.py +7 -4
  186. vellum/types/search_request_options_request.py +20 -8
  187. vellum/types/search_response.py +5 -3
  188. vellum/types/search_result.py +15 -5
  189. vellum/types/search_result_document.py +20 -8
  190. vellum/types/search_result_document_request.py +15 -7
  191. vellum/types/search_result_merging_request.py +5 -1
  192. vellum/types/search_result_request.py +15 -5
  193. vellum/types/search_results_enum.py +2 -2
  194. vellum/types/search_results_variable_value.py +2 -1
  195. vellum/types/search_weights_request.py +10 -4
  196. vellum/types/slim_deployment_read.py +28 -14
  197. vellum/types/slim_document.py +56 -35
  198. vellum/types/slim_workflow_deployment.py +37 -24
  199. vellum/types/streaming_enum.py +2 -2
  200. vellum/types/streaming_execute_prompt_event.py +6 -4
  201. vellum/types/streaming_prompt_execution_meta.py +2 -1
  202. vellum/types/streaming_workflow_node_result_event.py +6 -5
  203. vellum/types/string_chat_message_content.py +1 -0
  204. vellum/types/string_chat_message_content_request.py +1 -0
  205. vellum/types/string_enum.py +2 -2
  206. vellum/types/string_input_request.py +6 -1
  207. vellum/types/string_variable_value.py +2 -1
  208. vellum/types/submit_completion_actual_request.py +25 -13
  209. vellum/types/submit_completion_actuals_error_response.py +1 -0
  210. vellum/types/submit_workflow_execution_actual_request.py +6 -5
  211. vellum/types/subworkflow_enum.py +2 -2
  212. vellum/types/subworkflow_node_result.py +1 -0
  213. vellum/types/templating_node_array_result.py +31 -0
  214. vellum/types/templating_node_chat_history_result.py +2 -1
  215. vellum/types/templating_node_error_result.py +2 -1
  216. vellum/types/templating_node_function_call_result.py +31 -0
  217. vellum/types/templating_node_json_result.py +2 -1
  218. vellum/types/templating_node_number_result.py +2 -1
  219. vellum/types/templating_node_result.py +1 -0
  220. vellum/types/templating_node_result_data.py +1 -0
  221. vellum/types/templating_node_result_output.py +36 -8
  222. vellum/types/templating_node_search_results_result.py +2 -1
  223. vellum/types/templating_node_string_result.py +2 -1
  224. vellum/types/terminal_node_array_result.py +8 -3
  225. vellum/types/terminal_node_chat_history_result.py +8 -3
  226. vellum/types/terminal_node_error_result.py +8 -3
  227. vellum/types/terminal_node_function_call_result.py +8 -3
  228. vellum/types/terminal_node_json_result.py +8 -3
  229. vellum/types/terminal_node_number_result.py +8 -3
  230. vellum/types/terminal_node_result.py +1 -0
  231. vellum/types/terminal_node_result_data.py +1 -0
  232. vellum/types/terminal_node_result_output.py +16 -10
  233. vellum/types/terminal_node_search_results_result.py +8 -3
  234. vellum/types/terminal_node_string_result.py +8 -3
  235. vellum/types/test_case_chat_history_variable_value.py +2 -1
  236. vellum/types/test_case_error_variable_value.py +2 -1
  237. vellum/types/test_case_json_variable_value.py +2 -1
  238. vellum/types/test_case_number_variable_value.py +2 -1
  239. vellum/types/test_case_search_results_variable_value.py +2 -1
  240. vellum/types/test_case_string_variable_value.py +2 -1
  241. vellum/types/test_case_variable_value.py +12 -8
  242. vellum/types/test_suite_run_deployment_release_tag_exec_config.py +5 -3
  243. vellum/types/test_suite_run_deployment_release_tag_exec_config_data.py +10 -4
  244. vellum/types/test_suite_run_deployment_release_tag_exec_config_data_request.py +10 -4
  245. vellum/types/test_suite_run_deployment_release_tag_exec_config_request.py +5 -3
  246. vellum/types/test_suite_run_deployment_release_tag_exec_config_type_enum.py +2 -2
  247. vellum/types/test_suite_run_exec_config.py +4 -4
  248. vellum/types/test_suite_run_exec_config_request.py +4 -4
  249. vellum/types/test_suite_run_execution.py +1 -0
  250. vellum/types/test_suite_run_execution_chat_history_output.py +2 -1
  251. vellum/types/test_suite_run_execution_error_output.py +2 -1
  252. vellum/types/test_suite_run_execution_json_output.py +2 -1
  253. vellum/types/test_suite_run_execution_metric_result.py +1 -0
  254. vellum/types/test_suite_run_execution_number_output.py +2 -1
  255. vellum/types/test_suite_run_execution_output.py +12 -8
  256. vellum/types/test_suite_run_execution_search_results_output.py +2 -1
  257. vellum/types/test_suite_run_execution_string_output.py +2 -1
  258. vellum/types/test_suite_run_metric_error_output.py +1 -0
  259. vellum/types/test_suite_run_metric_error_output_type_enum.py +2 -2
  260. vellum/types/test_suite_run_metric_number_output.py +1 -0
  261. vellum/types/test_suite_run_metric_number_output_type_enum.py +2 -2
  262. vellum/types/test_suite_run_metric_output.py +4 -4
  263. vellum/types/test_suite_run_read.py +16 -14
  264. vellum/types/test_suite_run_test_suite.py +1 -0
  265. vellum/types/test_suite_run_workflow_release_tag_exec_config.py +5 -3
  266. vellum/types/test_suite_run_workflow_release_tag_exec_config_data.py +10 -6
  267. vellum/types/test_suite_run_workflow_release_tag_exec_config_data_request.py +10 -6
  268. vellum/types/test_suite_run_workflow_release_tag_exec_config_request.py +5 -3
  269. vellum/types/test_suite_run_workflow_release_tag_exec_config_type_enum.py +2 -2
  270. vellum/types/test_suite_test_case.py +3 -2
  271. vellum/types/upload_document_error_response.py +1 -0
  272. vellum/types/upload_document_response.py +5 -1
  273. vellum/types/vellum_error.py +1 -0
  274. vellum/types/vellum_error_request.py +1 -0
  275. vellum/types/vellum_image.py +2 -1
  276. vellum/types/vellum_image_request.py +2 -1
  277. vellum/types/vellum_variable.py +1 -0
  278. vellum/types/workflow_deployment_read.py +37 -24
  279. vellum/types/workflow_event_error.py +1 -0
  280. vellum/types/workflow_execution_actual_chat_history_request.py +25 -15
  281. vellum/types/workflow_execution_actual_json_request.py +25 -15
  282. vellum/types/workflow_execution_actual_string_request.py +25 -15
  283. vellum/types/workflow_execution_node_result_event.py +3 -2
  284. vellum/types/workflow_execution_workflow_result_event.py +3 -2
  285. vellum/types/workflow_node_result_data.py +16 -10
  286. vellum/types/workflow_node_result_event.py +8 -6
  287. vellum/types/workflow_output.py +18 -11
  288. vellum/types/workflow_output_array.py +7 -2
  289. vellum/types/workflow_output_chat_history.py +7 -2
  290. vellum/types/workflow_output_error.py +7 -2
  291. vellum/types/workflow_output_function_call.py +7 -2
  292. vellum/types/workflow_output_image.py +7 -2
  293. vellum/types/workflow_output_json.py +7 -2
  294. vellum/types/workflow_output_number.py +7 -2
  295. vellum/types/workflow_output_search_results.py +7 -2
  296. vellum/types/workflow_output_string.py +7 -2
  297. vellum/types/workflow_request_chat_history_input_request.py +6 -1
  298. vellum/types/workflow_request_input_request.py +8 -6
  299. vellum/types/workflow_request_json_input_request.py +6 -1
  300. vellum/types/workflow_request_number_input_request.py +6 -1
  301. vellum/types/workflow_request_string_input_request.py +6 -1
  302. vellum/types/workflow_result_event.py +5 -4
  303. vellum/types/workflow_result_event_output_data.py +16 -10
  304. vellum/types/workflow_result_event_output_data_array.py +8 -5
  305. vellum/types/workflow_result_event_output_data_chat_history.py +8 -5
  306. vellum/types/workflow_result_event_output_data_error.py +8 -5
  307. vellum/types/workflow_result_event_output_data_function_call.py +8 -5
  308. vellum/types/workflow_result_event_output_data_json.py +8 -5
  309. vellum/types/workflow_result_event_output_data_number.py +8 -5
  310. vellum/types/workflow_result_event_output_data_search_results.py +8 -5
  311. vellum/types/workflow_result_event_output_data_string.py +11 -7
  312. vellum/types/workflow_stream_event.py +4 -4
  313. vellum/version.py +4 -0
  314. {vellum_ai-0.3.14.dist-info → vellum_ai-0.3.16.dist-info}/METADATA +5 -4
  315. vellum_ai-0.3.16.dist-info/RECORD +365 -0
  316. vellum_ai-0.3.14.dist-info/RECORD +0 -356
  317. {vellum_ai-0.3.14.dist-info → vellum_ai-0.3.16.dist-info}/LICENSE +0 -0
  318. {vellum_ai-0.3.14.dist-info → vellum_ai-0.3.16.dist-info}/WHEEL +0 -0
@@ -12,12 +12,15 @@ except ImportError:
12
12
 
13
13
 
14
14
  class TestSuiteRunWorkflowReleaseTagExecConfigData(pydantic.BaseModel):
15
- workflow_deployment_id: str = pydantic.Field(
16
- description="The ID of the Workflow Deployment to run the Test Suite against."
17
- )
18
- tag: typing.Optional[str] = pydantic.Field(
19
- description="A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment"
20
- )
15
+ workflow_deployment_id: str = pydantic.Field()
16
+ """
17
+ The ID of the Workflow Deployment to run the Test Suite against.
18
+ """
19
+
20
+ tag: typing.Optional[str] = pydantic.Field(default=None)
21
+ """
22
+ A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment
23
+ """
21
24
 
22
25
  def json(self, **kwargs: typing.Any) -> str:
23
26
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -30,4 +33,5 @@ class TestSuiteRunWorkflowReleaseTagExecConfigData(pydantic.BaseModel):
30
33
  class Config:
31
34
  frozen = True
32
35
  smart_union = True
36
+ extra = pydantic.Extra.allow
33
37
  json_encoders = {dt.datetime: serialize_datetime}
@@ -12,12 +12,15 @@ except ImportError:
12
12
 
13
13
 
14
14
  class TestSuiteRunWorkflowReleaseTagExecConfigDataRequest(pydantic.BaseModel):
15
- workflow_deployment_id: str = pydantic.Field(
16
- description="The ID of the Workflow Deployment to run the Test Suite against."
17
- )
18
- tag: typing.Optional[str] = pydantic.Field(
19
- description="A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment"
20
- )
15
+ workflow_deployment_id: str = pydantic.Field()
16
+ """
17
+ The ID of the Workflow Deployment to run the Test Suite against.
18
+ """
19
+
20
+ tag: typing.Optional[str] = pydantic.Field(default=None)
21
+ """
22
+ A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment
23
+ """
21
24
 
22
25
  def json(self, **kwargs: typing.Any) -> str:
23
26
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -30,4 +33,5 @@ class TestSuiteRunWorkflowReleaseTagExecConfigDataRequest(pydantic.BaseModel):
30
33
  class Config:
31
34
  frozen = True
32
35
  smart_union = True
36
+ extra = pydantic.Extra.allow
33
37
  json_encoders = {dt.datetime: serialize_datetime}
@@ -20,9 +20,10 @@ class TestSuiteRunWorkflowReleaseTagExecConfigRequest(pydantic.BaseModel):
20
20
  """
21
21
 
22
22
  data: TestSuiteRunWorkflowReleaseTagExecConfigDataRequest
23
- test_case_ids: typing.Optional[typing.List[str]] = pydantic.Field(
24
- description="Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default."
25
- )
23
+ test_case_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
24
+ """
25
+ Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
26
+ """
26
27
 
27
28
  def json(self, **kwargs: typing.Any) -> str:
28
29
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -35,4 +36,5 @@ class TestSuiteRunWorkflowReleaseTagExecConfigRequest(pydantic.BaseModel):
35
36
  class Config:
36
37
  frozen = True
37
38
  smart_union = True
39
+ extra = pydantic.Extra.allow
38
40
  json_encoders = {dt.datetime: serialize_datetime}
@@ -1,5 +1,5 @@
1
1
  # This file was auto-generated by Fern from our API Definition.
2
2
 
3
- import typing_extensions
3
+ import typing
4
4
 
5
- TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum = typing_extensions.Literal["WORKFLOW_RELEASE_TAG"]
5
+ TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum = typing.Literal["WORKFLOW_RELEASE_TAG"]
@@ -13,8 +13,8 @@ except ImportError:
13
13
 
14
14
 
15
15
  class TestSuiteTestCase(pydantic.BaseModel):
16
- id: typing.Optional[str]
17
- label: typing.Optional[str]
16
+ id: typing.Optional[str] = None
17
+ label: typing.Optional[str] = None
18
18
  input_values: typing.List[TestCaseVariableValue]
19
19
  evaluation_values: typing.List[TestCaseVariableValue]
20
20
 
@@ -29,4 +29,5 @@ class TestSuiteTestCase(pydantic.BaseModel):
29
29
  class Config:
30
30
  frozen = True
31
31
  smart_union = True
32
+ extra = pydantic.Extra.allow
32
33
  json_encoders = {dt.datetime: serialize_datetime}
@@ -25,4 +25,5 @@ class UploadDocumentErrorResponse(pydantic.BaseModel):
25
25
  class Config:
26
26
  frozen = True
27
27
  smart_union = True
28
+ extra = pydantic.Extra.allow
28
29
  json_encoders = {dt.datetime: serialize_datetime}
@@ -12,7 +12,10 @@ except ImportError:
12
12
 
13
13
 
14
14
  class UploadDocumentResponse(pydantic.BaseModel):
15
- document_id: str = pydantic.Field(description="The ID of the newly created document.")
15
+ document_id: str = pydantic.Field()
16
+ """
17
+ The ID of the newly created document.
18
+ """
16
19
 
17
20
  def json(self, **kwargs: typing.Any) -> str:
18
21
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -25,4 +28,5 @@ class UploadDocumentResponse(pydantic.BaseModel):
25
28
  class Config:
26
29
  frozen = True
27
30
  smart_union = True
31
+ extra = pydantic.Extra.allow
28
32
  json_encoders = {dt.datetime: serialize_datetime}
@@ -27,4 +27,5 @@ class VellumError(pydantic.BaseModel):
27
27
  class Config:
28
28
  frozen = True
29
29
  smart_union = True
30
+ extra = pydantic.Extra.allow
30
31
  json_encoders = {dt.datetime: serialize_datetime}
@@ -27,4 +27,5 @@ class VellumErrorRequest(pydantic.BaseModel):
27
27
  class Config:
28
28
  frozen = True
29
29
  smart_union = True
30
+ extra = pydantic.Extra.allow
30
31
  json_encoders = {dt.datetime: serialize_datetime}
@@ -13,7 +13,7 @@ except ImportError:
13
13
 
14
14
  class VellumImage(pydantic.BaseModel):
15
15
  src: str
16
- metadata: typing.Optional[typing.Dict[str, typing.Any]]
16
+ metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
17
17
 
18
18
  def json(self, **kwargs: typing.Any) -> str:
19
19
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -26,4 +26,5 @@ class VellumImage(pydantic.BaseModel):
26
26
  class Config:
27
27
  frozen = True
28
28
  smart_union = True
29
+ extra = pydantic.Extra.allow
29
30
  json_encoders = {dt.datetime: serialize_datetime}
@@ -13,7 +13,7 @@ except ImportError:
13
13
 
14
14
  class VellumImageRequest(pydantic.BaseModel):
15
15
  src: str
16
- metadata: typing.Optional[typing.Dict[str, typing.Any]]
16
+ metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
17
17
 
18
18
  def json(self, **kwargs: typing.Any) -> str:
19
19
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -26,4 +26,5 @@ class VellumImageRequest(pydantic.BaseModel):
26
26
  class Config:
27
27
  frozen = True
28
28
  smart_union = True
29
+ extra = pydantic.Extra.allow
29
30
  json_encoders = {dt.datetime: serialize_datetime}
@@ -28,4 +28,5 @@ class VellumVariable(pydantic.BaseModel):
28
28
  class Config:
29
29
  frozen = True
30
30
  smart_union = True
31
+ extra = pydantic.Extra.allow
31
32
  json_encoders = {dt.datetime: serialize_datetime}
@@ -16,32 +16,44 @@ except ImportError:
16
16
 
17
17
  class WorkflowDeploymentRead(pydantic.BaseModel):
18
18
  id: str
19
- name: str = pydantic.Field(
20
- description="A name that uniquely identifies this workflow deployment within its workspace"
21
- )
22
- label: str = pydantic.Field(description="A human-readable label for the workflow deployment")
23
- status: typing.Optional[EntityStatus] = pydantic.Field(
24
- description=(
25
- "The current status of the workflow deployment\n" "\n" "- `ACTIVE` - Active\n" "- `ARCHIVED` - Archived\n"
26
- )
27
- )
28
- environment: typing.Optional[EnvironmentEnum] = pydantic.Field(
29
- description=(
30
- "The environment this workflow deployment is used in\n"
31
- "\n"
32
- "- `DEVELOPMENT` - Development\n"
33
- "- `STAGING` - Staging\n"
34
- "- `PRODUCTION` - Production\n"
35
- )
36
- )
19
+ name: str = pydantic.Field()
20
+ """
21
+ A name that uniquely identifies this workflow deployment within its workspace
22
+ """
23
+
24
+ label: str = pydantic.Field()
25
+ """
26
+ A human-readable label for the workflow deployment
27
+ """
28
+
29
+ status: typing.Optional[EntityStatus] = pydantic.Field(default=None)
30
+ """
31
+ The current status of the workflow deployment
32
+
33
+ - `ACTIVE` - Active
34
+ - `ARCHIVED` - Archived
35
+ """
36
+
37
+ environment: typing.Optional[EnvironmentEnum] = pydantic.Field(default=None)
38
+ """
39
+ The environment this workflow deployment is used in
40
+
41
+ - `DEVELOPMENT` - Development
42
+ - `STAGING` - Staging
43
+ - `PRODUCTION` - Production
44
+ """
45
+
37
46
  created: dt.datetime
38
47
  last_deployed_on: dt.datetime
39
- input_variables: typing.List[VellumVariable] = pydantic.Field(
40
- description="The input variables this Workflow Deployment expects to receive values for when it is executed."
41
- )
42
- output_variables: typing.List[VellumVariable] = pydantic.Field(
43
- description="The output variables this Workflow Deployment produces values for when it's executed."
44
- )
48
+ input_variables: typing.List[VellumVariable] = pydantic.Field()
49
+ """
50
+ The input variables this Workflow Deployment expects to receive values for when it is executed.
51
+ """
52
+
53
+ output_variables: typing.List[VellumVariable] = pydantic.Field()
54
+ """
55
+ The output variables this Workflow Deployment produces values for when it's executed.
56
+ """
45
57
 
46
58
  def json(self, **kwargs: typing.Any) -> str:
47
59
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -54,4 +66,5 @@ class WorkflowDeploymentRead(pydantic.BaseModel):
54
66
  class Config:
55
67
  frozen = True
56
68
  smart_union = True
69
+ extra = pydantic.Extra.allow
57
70
  json_encoders = {dt.datetime: serialize_datetime}
@@ -27,4 +27,5 @@ class WorkflowEventError(pydantic.BaseModel):
27
27
  class Config:
28
28
  frozen = True
29
29
  smart_union = True
30
+ extra = pydantic.Extra.allow
30
31
  json_encoders = {dt.datetime: serialize_datetime}
@@ -13,21 +13,30 @@ except ImportError:
13
13
 
14
14
 
15
15
  class WorkflowExecutionActualChatHistoryRequest(pydantic.BaseModel):
16
- output_id: typing.Optional[str] = pydantic.Field(
17
- description="The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred."
18
- )
19
- output_key: typing.Optional[str] = pydantic.Field(
20
- description="The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id."
21
- )
22
- quality: typing.Optional[float] = pydantic.Field(
23
- description="Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best."
24
- )
25
- timestamp: typing.Optional[float] = pydantic.Field(
26
- description="Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."
27
- )
28
- desired_output_value: typing.Optional[typing.List[ChatMessageRequest]] = pydantic.Field(
29
- description="Optionally provide the value that the output ideally should have been."
30
- )
16
+ output_id: typing.Optional[str] = pydantic.Field(default=None)
17
+ """
18
+ The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred.
19
+ """
20
+
21
+ output_key: typing.Optional[str] = pydantic.Field(default=None)
22
+ """
23
+ The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id.
24
+ """
25
+
26
+ quality: typing.Optional[float] = pydantic.Field(default=None)
27
+ """
28
+ Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best.
29
+ """
30
+
31
+ timestamp: typing.Optional[float] = pydantic.Field(default=None)
32
+ """
33
+ Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.
34
+ """
35
+
36
+ desired_output_value: typing.Optional[typing.List[ChatMessageRequest]] = pydantic.Field(default=None)
37
+ """
38
+ Optionally provide the value that the output ideally should have been.
39
+ """
31
40
 
32
41
  def json(self, **kwargs: typing.Any) -> str:
33
42
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -40,4 +49,5 @@ class WorkflowExecutionActualChatHistoryRequest(pydantic.BaseModel):
40
49
  class Config:
41
50
  frozen = True
42
51
  smart_union = True
52
+ extra = pydantic.Extra.allow
43
53
  json_encoders = {dt.datetime: serialize_datetime}
@@ -12,21 +12,30 @@ except ImportError:
12
12
 
13
13
 
14
14
  class WorkflowExecutionActualJsonRequest(pydantic.BaseModel):
15
- output_id: typing.Optional[str] = pydantic.Field(
16
- description="The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred."
17
- )
18
- output_key: typing.Optional[str] = pydantic.Field(
19
- description="The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id."
20
- )
21
- quality: typing.Optional[float] = pydantic.Field(
22
- description="Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best."
23
- )
24
- timestamp: typing.Optional[float] = pydantic.Field(
25
- description="Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."
26
- )
27
- desired_output_value: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
28
- description="Optionally provide the value that the output ideally should have been."
29
- )
15
+ output_id: typing.Optional[str] = pydantic.Field(default=None)
16
+ """
17
+ The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred.
18
+ """
19
+
20
+ output_key: typing.Optional[str] = pydantic.Field(default=None)
21
+ """
22
+ The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id.
23
+ """
24
+
25
+ quality: typing.Optional[float] = pydantic.Field(default=None)
26
+ """
27
+ Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best.
28
+ """
29
+
30
+ timestamp: typing.Optional[float] = pydantic.Field(default=None)
31
+ """
32
+ Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.
33
+ """
34
+
35
+ desired_output_value: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
36
+ """
37
+ Optionally provide the value that the output ideally should have been.
38
+ """
30
39
 
31
40
  def json(self, **kwargs: typing.Any) -> str:
32
41
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -39,4 +48,5 @@ class WorkflowExecutionActualJsonRequest(pydantic.BaseModel):
39
48
  class Config:
40
49
  frozen = True
41
50
  smart_union = True
51
+ extra = pydantic.Extra.allow
42
52
  json_encoders = {dt.datetime: serialize_datetime}
@@ -12,21 +12,30 @@ except ImportError:
12
12
 
13
13
 
14
14
  class WorkflowExecutionActualStringRequest(pydantic.BaseModel):
15
- output_id: typing.Optional[str] = pydantic.Field(
16
- description="The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred."
17
- )
18
- output_key: typing.Optional[str] = pydantic.Field(
19
- description="The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id."
20
- )
21
- quality: typing.Optional[float] = pydantic.Field(
22
- description="Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best."
23
- )
24
- timestamp: typing.Optional[float] = pydantic.Field(
25
- description="Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."
26
- )
27
- desired_output_value: typing.Optional[str] = pydantic.Field(
28
- description="Optionally provide the value that the output ideally should have been."
29
- )
15
+ output_id: typing.Optional[str] = pydantic.Field(default=None)
16
+ """
17
+ The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred.
18
+ """
19
+
20
+ output_key: typing.Optional[str] = pydantic.Field(default=None)
21
+ """
22
+ The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id.
23
+ """
24
+
25
+ quality: typing.Optional[float] = pydantic.Field(default=None)
26
+ """
27
+ Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best.
28
+ """
29
+
30
+ timestamp: typing.Optional[float] = pydantic.Field(default=None)
31
+ """
32
+ Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.
33
+ """
34
+
35
+ desired_output_value: typing.Optional[str] = pydantic.Field(default=None)
36
+ """
37
+ Optionally provide the value that the output ideally should have been.
38
+ """
30
39
 
31
40
  def json(self, **kwargs: typing.Any) -> str:
32
41
  kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -39,4 +48,5 @@ class WorkflowExecutionActualStringRequest(pydantic.BaseModel):
39
48
  class Config:
40
49
  frozen = True
41
50
  smart_union = True
51
+ extra = pydantic.Extra.allow
42
52
  json_encoders = {dt.datetime: serialize_datetime}
@@ -18,8 +18,8 @@ class WorkflowExecutionNodeResultEvent(pydantic.BaseModel):
18
18
  """
19
19
 
20
20
  execution_id: str
21
- run_id: typing.Optional[str]
22
- external_id: typing.Optional[str]
21
+ run_id: typing.Optional[str] = None
22
+ external_id: typing.Optional[str] = None
23
23
  data: WorkflowNodeResultEvent
24
24
 
25
25
  def json(self, **kwargs: typing.Any) -> str:
@@ -33,4 +33,5 @@ class WorkflowExecutionNodeResultEvent(pydantic.BaseModel):
33
33
  class Config:
34
34
  frozen = True
35
35
  smart_union = True
36
+ extra = pydantic.Extra.allow
36
37
  json_encoders = {dt.datetime: serialize_datetime}
@@ -18,8 +18,8 @@ class WorkflowExecutionWorkflowResultEvent(pydantic.BaseModel):
18
18
  """
19
19
 
20
20
  execution_id: str
21
- run_id: typing.Optional[str]
22
- external_id: typing.Optional[str]
21
+ run_id: typing.Optional[str] = None
22
+ external_id: typing.Optional[str] = None
23
23
  data: WorkflowResultEvent
24
24
 
25
25
  def json(self, **kwargs: typing.Any) -> str:
@@ -33,4 +33,5 @@ class WorkflowExecutionWorkflowResultEvent(pydantic.BaseModel):
33
33
  class Config:
34
34
  frozen = True
35
35
  smart_union = True
36
+ extra = pydantic.Extra.allow
36
37
  json_encoders = {dt.datetime: serialize_datetime}
@@ -4,8 +4,6 @@ from __future__ import annotations
4
4
 
5
5
  import typing
6
6
 
7
- import typing_extensions
8
-
9
7
  from .api_node_result import ApiNodeResult
10
8
  from .code_execution_node_result import CodeExecutionNodeResult
11
9
  from .conditional_node_result import ConditionalNodeResult
@@ -17,75 +15,83 @@ from .terminal_node_result import TerminalNodeResult
17
15
 
18
16
 
19
17
  class WorkflowNodeResultData_Prompt(PromptNodeResult):
20
- type: typing_extensions.Literal["PROMPT"]
18
+ type: typing.Literal["PROMPT"] = "PROMPT"
21
19
 
22
20
  class Config:
23
21
  frozen = True
24
22
  smart_union = True
25
23
  allow_population_by_field_name = True
24
+ populate_by_name = True
26
25
 
27
26
 
28
27
  class WorkflowNodeResultData_Search(SearchNodeResult):
29
- type: typing_extensions.Literal["SEARCH"]
28
+ type: typing.Literal["SEARCH"] = "SEARCH"
30
29
 
31
30
  class Config:
32
31
  frozen = True
33
32
  smart_union = True
34
33
  allow_population_by_field_name = True
34
+ populate_by_name = True
35
35
 
36
36
 
37
37
  class WorkflowNodeResultData_Templating(TemplatingNodeResult):
38
- type: typing_extensions.Literal["TEMPLATING"]
38
+ type: typing.Literal["TEMPLATING"] = "TEMPLATING"
39
39
 
40
40
  class Config:
41
41
  frozen = True
42
42
  smart_union = True
43
43
  allow_population_by_field_name = True
44
+ populate_by_name = True
44
45
 
45
46
 
46
47
  class WorkflowNodeResultData_CodeExecution(CodeExecutionNodeResult):
47
- type: typing_extensions.Literal["CODE_EXECUTION"]
48
+ type: typing.Literal["CODE_EXECUTION"] = "CODE_EXECUTION"
48
49
 
49
50
  class Config:
50
51
  frozen = True
51
52
  smart_union = True
52
53
  allow_population_by_field_name = True
54
+ populate_by_name = True
53
55
 
54
56
 
55
57
  class WorkflowNodeResultData_Conditional(ConditionalNodeResult):
56
- type: typing_extensions.Literal["CONDITIONAL"]
58
+ type: typing.Literal["CONDITIONAL"] = "CONDITIONAL"
57
59
 
58
60
  class Config:
59
61
  frozen = True
60
62
  smart_union = True
61
63
  allow_population_by_field_name = True
64
+ populate_by_name = True
62
65
 
63
66
 
64
67
  class WorkflowNodeResultData_Api(ApiNodeResult):
65
- type: typing_extensions.Literal["API"]
68
+ type: typing.Literal["API"] = "API"
66
69
 
67
70
  class Config:
68
71
  frozen = True
69
72
  smart_union = True
70
73
  allow_population_by_field_name = True
74
+ populate_by_name = True
71
75
 
72
76
 
73
77
  class WorkflowNodeResultData_Terminal(TerminalNodeResult):
74
- type: typing_extensions.Literal["TERMINAL"]
78
+ type: typing.Literal["TERMINAL"] = "TERMINAL"
75
79
 
76
80
  class Config:
77
81
  frozen = True
78
82
  smart_union = True
79
83
  allow_population_by_field_name = True
84
+ populate_by_name = True
80
85
 
81
86
 
82
87
  class WorkflowNodeResultData_Subworkflow(SubworkflowNodeResult):
83
- type: typing_extensions.Literal["SUBWORKFLOW"]
88
+ type: typing.Literal["SUBWORKFLOW"] = "SUBWORKFLOW"
84
89
 
85
90
  class Config:
86
91
  frozen = True
87
92
  smart_union = True
88
93
  allow_population_by_field_name = True
94
+ populate_by_name = True
89
95
 
90
96
 
91
97
  WorkflowNodeResultData = typing.Union[
@@ -4,8 +4,6 @@ from __future__ import annotations
4
4
 
5
5
  import typing
6
6
 
7
- import typing_extensions
8
-
9
7
  from .fulfilled_workflow_node_result_event import FulfilledWorkflowNodeResultEvent
10
8
  from .initiated_workflow_node_result_event import InitiatedWorkflowNodeResultEvent
11
9
  from .rejected_workflow_node_result_event import RejectedWorkflowNodeResultEvent
@@ -13,39 +11,43 @@ from .streaming_workflow_node_result_event import StreamingWorkflowNodeResultEve
13
11
 
14
12
 
15
13
  class WorkflowNodeResultEvent_Initiated(InitiatedWorkflowNodeResultEvent):
16
- state: typing_extensions.Literal["INITIATED"]
14
+ state: typing.Literal["INITIATED"] = "INITIATED"
17
15
 
18
16
  class Config:
19
17
  frozen = True
20
18
  smart_union = True
21
19
  allow_population_by_field_name = True
20
+ populate_by_name = True
22
21
 
23
22
 
24
23
  class WorkflowNodeResultEvent_Streaming(StreamingWorkflowNodeResultEvent):
25
- state: typing_extensions.Literal["STREAMING"]
24
+ state: typing.Literal["STREAMING"] = "STREAMING"
26
25
 
27
26
  class Config:
28
27
  frozen = True
29
28
  smart_union = True
30
29
  allow_population_by_field_name = True
30
+ populate_by_name = True
31
31
 
32
32
 
33
33
  class WorkflowNodeResultEvent_Fulfilled(FulfilledWorkflowNodeResultEvent):
34
- state: typing_extensions.Literal["FULFILLED"]
34
+ state: typing.Literal["FULFILLED"] = "FULFILLED"
35
35
 
36
36
  class Config:
37
37
  frozen = True
38
38
  smart_union = True
39
39
  allow_population_by_field_name = True
40
+ populate_by_name = True
40
41
 
41
42
 
42
43
  class WorkflowNodeResultEvent_Rejected(RejectedWorkflowNodeResultEvent):
43
- state: typing_extensions.Literal["REJECTED"]
44
+ state: typing.Literal["REJECTED"] = "REJECTED"
44
45
 
45
46
  class Config:
46
47
  frozen = True
47
48
  smart_union = True
48
49
  allow_population_by_field_name = True
50
+ populate_by_name = True
49
51
 
50
52
 
51
53
  WorkflowNodeResultEvent = typing.Union[