vellum_ai 0.3.14 → 0.14.74

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 (690) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +21 -0
  3. data/lib/core/file_utilities.rb +14 -13
  4. data/lib/environment.rb +4 -6
  5. data/lib/requests.rb +141 -59
  6. data/lib/types_export.rb +396 -109
  7. data/lib/vellum_ai/ad_hoc/client.rb +179 -0
  8. data/lib/vellum_ai/container_images/client.rb +289 -0
  9. data/lib/vellum_ai/deployments/client.rb +581 -111
  10. data/lib/vellum_ai/deployments/types/deployments_list_request_status.rb +7 -3
  11. data/lib/vellum_ai/deployments/types/list_deployment_release_tags_request_source.rb +12 -0
  12. data/lib/vellum_ai/document_indexes/client.rb +517 -261
  13. data/lib/vellum_ai/document_indexes/types/document_indexes_list_request_status.rb +7 -3
  14. data/lib/vellum_ai/documents/client.rb +337 -186
  15. data/lib/vellum_ai/folder_entities/client.rb +165 -33
  16. data/lib/vellum_ai/folder_entities/types/folder_entities_list_request_entity_status.rb +12 -0
  17. data/lib/vellum_ai/metric_definitions/client.rb +159 -0
  18. data/lib/vellum_ai/ml_models/client.rb +94 -0
  19. data/lib/vellum_ai/organizations/client.rb +92 -0
  20. data/lib/vellum_ai/prompts/client.rb +194 -0
  21. data/lib/vellum_ai/release_reviews/client.rb +102 -0
  22. data/lib/vellum_ai/sandboxes/client.rb +230 -90
  23. data/lib/vellum_ai/test_suite_runs/client.rb +188 -101
  24. data/lib/vellum_ai/test_suites/client.rb +208 -90
  25. data/lib/vellum_ai/types/ad_hoc_execute_prompt_event.rb +90 -0
  26. data/lib/vellum_ai/types/ad_hoc_expand_meta.rb +85 -0
  27. data/lib/vellum_ai/types/ad_hoc_fulfilled_prompt_execution_meta.rb +92 -0
  28. data/lib/vellum_ai/types/ad_hoc_initiated_prompt_execution_meta.rb +65 -0
  29. data/lib/vellum_ai/types/ad_hoc_rejected_prompt_execution_meta.rb +66 -0
  30. data/lib/vellum_ai/types/ad_hoc_streaming_prompt_execution_meta.rb +55 -0
  31. data/lib/vellum_ai/types/api_node_result.rb +43 -27
  32. data/lib/vellum_ai/types/api_node_result_data.rb +62 -51
  33. data/lib/vellum_ai/types/api_request_parent_context.rb +87 -0
  34. data/lib/vellum_ai/types/{image_enum.rb → api_version_enum.rb} +2 -2
  35. data/lib/vellum_ai/types/array_chat_message_content.rb +42 -26
  36. data/lib/vellum_ai/types/array_chat_message_content_item.rb +85 -82
  37. data/lib/vellum_ai/types/array_chat_message_content_item_request.rb +85 -82
  38. data/lib/vellum_ai/types/array_chat_message_content_request.rb +42 -26
  39. data/lib/vellum_ai/types/array_input.rb +73 -0
  40. data/lib/vellum_ai/types/array_vellum_value.rb +68 -0
  41. data/lib/vellum_ai/types/array_vellum_value_request.rb +68 -0
  42. data/lib/vellum_ai/types/audio_chat_message_content.rb +68 -0
  43. data/lib/vellum_ai/types/audio_chat_message_content_request.rb +68 -0
  44. data/lib/vellum_ai/types/audio_prompt_block.rb +92 -0
  45. data/lib/vellum_ai/types/audio_vellum_value.rb +70 -0
  46. data/lib/vellum_ai/types/audio_vellum_value_request.rb +70 -0
  47. data/lib/vellum_ai/types/base_output.rb +70 -0
  48. data/lib/vellum_ai/types/basic_vectorizer_intfloat_multilingual_e_5_large.rb +66 -0
  49. data/lib/vellum_ai/types/basic_vectorizer_intfloat_multilingual_e_5_large_request.rb +66 -0
  50. data/lib/vellum_ai/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_cos_v_1.rb +66 -0
  51. data/lib/vellum_ai/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_cos_v_1_request.rb +66 -0
  52. data/lib/vellum_ai/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_dot_v_1.rb +66 -0
  53. data/lib/vellum_ai/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_dot_v_1_request.rb +66 -0
  54. data/lib/vellum_ai/types/build_status_enum.rb +18 -0
  55. data/lib/vellum_ai/types/chat_history_input.rb +73 -0
  56. data/lib/vellum_ai/types/chat_history_input_request.rb +46 -28
  57. data/lib/vellum_ai/types/chat_history_vellum_value.rb +68 -0
  58. data/lib/vellum_ai/types/chat_history_vellum_value_request.rb +68 -0
  59. data/lib/vellum_ai/types/chat_message.rb +55 -38
  60. data/lib/vellum_ai/types/chat_message_content.rb +100 -94
  61. data/lib/vellum_ai/types/chat_message_content_request.rb +100 -94
  62. data/lib/vellum_ai/types/chat_message_prompt_block.rb +111 -0
  63. data/lib/vellum_ai/types/chat_message_request.rb +55 -38
  64. data/lib/vellum_ai/types/chat_message_role.rb +13 -3
  65. data/lib/vellum_ai/types/code_execution_node_array_result.rb +74 -0
  66. data/lib/vellum_ai/types/code_execution_node_chat_history_result.rb +49 -29
  67. data/lib/vellum_ai/types/code_execution_node_error_result.rb +50 -30
  68. data/lib/vellum_ai/types/code_execution_node_function_call_result.rb +76 -0
  69. data/lib/vellum_ai/types/code_execution_node_json_result.rb +45 -27
  70. data/lib/vellum_ai/types/code_execution_node_number_result.rb +47 -27
  71. data/lib/vellum_ai/types/code_execution_node_result.rb +43 -27
  72. data/lib/vellum_ai/types/code_execution_node_result_data.rb +43 -30
  73. data/lib/vellum_ai/types/code_execution_node_result_output.rb +131 -119
  74. data/lib/vellum_ai/types/code_execution_node_search_results_result.rb +49 -29
  75. data/lib/vellum_ai/types/code_execution_node_string_result.rb +47 -27
  76. data/lib/vellum_ai/types/code_execution_package.rb +61 -0
  77. data/lib/vellum_ai/types/code_execution_runtime.rb +12 -0
  78. data/lib/vellum_ai/types/code_executor_input.rb +170 -0
  79. data/lib/vellum_ai/types/code_executor_response.rb +67 -0
  80. data/lib/vellum_ai/types/code_executor_secret_input.rb +69 -0
  81. data/lib/vellum_ai/types/code_resource_definition.rb +62 -0
  82. data/lib/vellum_ai/types/compile_prompt_deployment_expand_meta_request.rb +76 -0
  83. data/lib/vellum_ai/types/compile_prompt_meta.rb +72 -0
  84. data/lib/vellum_ai/types/components_schemas_pdf_search_result_meta_source.rb +6 -0
  85. data/lib/vellum_ai/types/components_schemas_pdf_search_result_meta_source_request.rb +6 -0
  86. data/lib/vellum_ai/types/components_schemas_prompt_version_build_config_sandbox.rb +6 -0
  87. data/lib/vellum_ai/types/condition_combinator.rb +12 -0
  88. data/lib/vellum_ai/types/conditional_node_result.rb +43 -27
  89. data/lib/vellum_ai/types/conditional_node_result_data.rb +31 -23
  90. data/lib/vellum_ai/types/container_image_build_config.rb +55 -0
  91. data/lib/vellum_ai/types/container_image_container_image_tag.rb +66 -0
  92. data/lib/vellum_ai/types/container_image_read.rb +141 -0
  93. data/lib/vellum_ai/types/create_test_suite_test_case_request.rb +89 -0
  94. data/lib/vellum_ai/types/deployment_history_item.rb +107 -0
  95. data/lib/vellum_ai/types/deployment_provider_payload_response.rb +54 -24
  96. data/lib/vellum_ai/types/deployment_provider_payload_response_payload.rb +57 -0
  97. data/lib/vellum_ai/types/deployment_read.rb +113 -76
  98. data/lib/vellum_ai/types/deployment_release_tag_deployment_history_item.rb +68 -0
  99. data/lib/vellum_ai/types/deployment_release_tag_read.rb +92 -0
  100. data/lib/vellum_ai/types/docker_service_token.rb +68 -0
  101. data/lib/vellum_ai/types/document_chat_message_content.rb +68 -0
  102. data/lib/vellum_ai/types/document_chat_message_content_request.rb +68 -0
  103. data/lib/vellum_ai/types/document_document_to_document_index.rb +76 -43
  104. data/lib/vellum_ai/types/document_index_chunking.rb +74 -0
  105. data/lib/vellum_ai/types/document_index_chunking_request.rb +74 -0
  106. data/lib/vellum_ai/types/document_index_indexing_config.rb +75 -0
  107. data/lib/vellum_ai/types/document_index_indexing_config_request.rb +75 -0
  108. data/lib/vellum_ai/types/document_index_read.rb +73 -64
  109. data/lib/vellum_ai/types/document_processing_state.rb +18 -0
  110. data/lib/vellum_ai/types/document_prompt_block.rb +92 -0
  111. data/lib/vellum_ai/types/document_read.rb +91 -83
  112. data/lib/vellum_ai/types/document_status.rb +1 -1
  113. data/lib/vellum_ai/types/document_vellum_value.rb +70 -0
  114. data/lib/vellum_ai/types/document_vellum_value_request.rb +70 -0
  115. data/lib/vellum_ai/types/enriched_normalized_completion.rb +97 -78
  116. data/lib/vellum_ai/types/entity_status.rb +9 -3
  117. data/lib/vellum_ai/types/entity_visibility.rb +16 -0
  118. data/lib/vellum_ai/types/environment_enum.rb +11 -3
  119. data/lib/vellum_ai/types/ephemeral_prompt_cache_config.rb +54 -0
  120. data/lib/vellum_ai/types/ephemeral_prompt_cache_config_type_enum.rb +5 -0
  121. data/lib/vellum_ai/types/error_input.rb +75 -0
  122. data/lib/vellum_ai/types/error_vellum_value.rb +70 -0
  123. data/lib/vellum_ai/types/error_vellum_value_request.rb +70 -0
  124. data/lib/vellum_ai/types/execute_api_request_bearer_token.rb +57 -0
  125. data/lib/vellum_ai/types/execute_api_request_body.rb +71 -0
  126. data/lib/vellum_ai/types/execute_api_request_headers_value.rb +57 -0
  127. data/lib/vellum_ai/types/execute_api_response.rb +83 -0
  128. data/lib/vellum_ai/types/execute_api_response_json.rb +56 -0
  129. data/lib/vellum_ai/types/execute_prompt_event.rb +68 -94
  130. data/lib/vellum_ai/types/execute_prompt_response.rb +38 -70
  131. data/lib/vellum_ai/types/execute_workflow_response.rb +54 -38
  132. data/lib/vellum_ai/types/execute_workflow_workflow_result_event.rb +38 -70
  133. data/lib/vellum_ai/types/execution_array_vellum_value.rb +55 -32
  134. data/lib/vellum_ai/types/execution_chat_history_vellum_value.rb +54 -31
  135. data/lib/vellum_ai/types/execution_error_vellum_value.rb +55 -32
  136. data/lib/vellum_ai/types/execution_function_call_vellum_value.rb +55 -32
  137. data/lib/vellum_ai/types/execution_json_vellum_value.rb +50 -29
  138. data/lib/vellum_ai/types/execution_number_vellum_value.rb +52 -29
  139. data/lib/vellum_ai/types/execution_search_results_vellum_value.rb +54 -31
  140. data/lib/vellum_ai/types/execution_string_vellum_value.rb +52 -29
  141. data/lib/vellum_ai/types/execution_vellum_value.rb +129 -143
  142. data/lib/vellum_ai/types/external_input_descriptor.rb +86 -0
  143. data/lib/vellum_ai/types/external_test_case_execution.rb +67 -0
  144. data/lib/vellum_ai/types/external_test_case_execution_request.rb +67 -0
  145. data/lib/vellum_ai/types/fast_embed_vectorizer_baai_bge_small_en_v_15.rb +52 -0
  146. data/lib/vellum_ai/types/fast_embed_vectorizer_baai_bge_small_en_v_15_request.rb +54 -0
  147. data/lib/vellum_ai/types/finish_reason_enum.rb +11 -3
  148. data/lib/vellum_ai/types/folder_entity.rb +122 -0
  149. data/lib/vellum_ai/types/folder_entity_dataset.rb +75 -0
  150. data/lib/vellum_ai/types/folder_entity_dataset_data.rb +101 -0
  151. data/lib/vellum_ai/types/folder_entity_document_index.rb +75 -0
  152. data/lib/vellum_ai/types/folder_entity_document_index_data.rb +106 -0
  153. data/lib/vellum_ai/types/folder_entity_folder.rb +75 -0
  154. data/lib/vellum_ai/types/folder_entity_folder_data.rb +92 -0
  155. data/lib/vellum_ai/types/folder_entity_prompt_sandbox.rb +75 -0
  156. data/lib/vellum_ai/types/folder_entity_prompt_sandbox_data.rb +114 -0
  157. data/lib/vellum_ai/types/folder_entity_test_suite.rb +75 -0
  158. data/lib/vellum_ai/types/folder_entity_test_suite_data.rb +93 -0
  159. data/lib/vellum_ai/types/folder_entity_workflow_sandbox.rb +75 -0
  160. data/lib/vellum_ai/types/folder_entity_workflow_sandbox_data.rb +114 -0
  161. data/lib/vellum_ai/types/fulfilled_ad_hoc_execute_prompt_event.rb +89 -0
  162. data/lib/vellum_ai/types/fulfilled_execute_prompt_event.rb +60 -37
  163. data/lib/vellum_ai/types/fulfilled_execute_prompt_response.rb +67 -40
  164. data/lib/vellum_ai/types/fulfilled_execute_workflow_workflow_result_event.rb +59 -32
  165. data/lib/vellum_ai/types/fulfilled_prompt_execution_meta.rb +69 -29
  166. data/lib/vellum_ai/types/fulfilled_workflow_node_result_event.rb +92 -68
  167. data/lib/vellum_ai/types/function_call.rb +53 -72
  168. data/lib/vellum_ai/types/function_call_chat_message_content.rb +43 -27
  169. data/lib/vellum_ai/types/function_call_chat_message_content_request.rb +44 -27
  170. data/lib/vellum_ai/types/function_call_chat_message_content_value.rb +46 -31
  171. data/lib/vellum_ai/types/function_call_chat_message_content_value_request.rb +48 -31
  172. data/lib/vellum_ai/types/function_call_input.rb +75 -0
  173. data/lib/vellum_ai/types/function_call_prompt_block.rb +99 -0
  174. data/lib/vellum_ai/types/function_call_request.rb +71 -0
  175. data/lib/vellum_ai/types/function_call_vellum_value.rb +70 -0
  176. data/lib/vellum_ai/types/function_call_vellum_value_request.rb +70 -0
  177. data/lib/vellum_ai/types/function_definition.rb +109 -0
  178. data/lib/vellum_ai/types/generate_options_request.rb +35 -27
  179. data/lib/vellum_ai/types/generate_request.rb +52 -34
  180. data/lib/vellum_ai/types/generate_response.rb +29 -23
  181. data/lib/vellum_ai/types/generate_result.rb +52 -35
  182. data/lib/vellum_ai/types/generate_result_data.rb +29 -23
  183. data/lib/vellum_ai/types/generate_result_error.rb +26 -20
  184. data/lib/vellum_ai/types/generate_stream_response.rb +30 -24
  185. data/lib/vellum_ai/types/generate_stream_result.rb +53 -38
  186. data/lib/vellum_ai/types/generate_stream_result_data.rb +39 -28
  187. data/lib/vellum_ai/types/google_vertex_ai_vectorizer_config.rb +61 -0
  188. data/lib/vellum_ai/types/google_vertex_ai_vectorizer_config_request.rb +62 -0
  189. data/lib/vellum_ai/types/google_vertex_ai_vectorizer_text_embedding_004.rb +69 -0
  190. data/lib/vellum_ai/types/google_vertex_ai_vectorizer_text_embedding_004_request.rb +69 -0
  191. data/lib/vellum_ai/types/google_vertex_ai_vectorizer_text_multilingual_embedding_002.rb +69 -0
  192. data/lib/vellum_ai/types/google_vertex_ai_vectorizer_text_multilingual_embedding_002_request.rb +69 -0
  193. data/lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb +68 -0
  194. data/lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer_request.rb +68 -0
  195. data/lib/vellum_ai/types/image_chat_message_content.rb +43 -27
  196. data/lib/vellum_ai/types/image_chat_message_content_request.rb +43 -27
  197. data/lib/vellum_ai/types/image_prompt_block.rb +92 -0
  198. data/lib/vellum_ai/types/image_vellum_value.rb +70 -0
  199. data/lib/vellum_ai/types/image_vellum_value_request.rb +70 -0
  200. data/lib/vellum_ai/types/indexing_config_vectorizer.rb +186 -0
  201. data/lib/vellum_ai/types/indexing_config_vectorizer_request.rb +186 -0
  202. data/lib/vellum_ai/types/indexing_state_enum.rb +15 -9
  203. data/lib/vellum_ai/types/initiated_ad_hoc_execute_prompt_event.rb +78 -0
  204. data/lib/vellum_ai/types/initiated_execute_prompt_event.rb +52 -31
  205. data/lib/vellum_ai/types/initiated_prompt_execution_meta.rb +55 -44
  206. data/lib/vellum_ai/types/initiated_workflow_node_result_event.rb +86 -62
  207. data/lib/vellum_ai/types/instructor_vectorizer_config.rb +69 -0
  208. data/lib/vellum_ai/types/instructor_vectorizer_config_request.rb +69 -0
  209. data/lib/vellum_ai/types/invoked_port.rb +51 -0
  210. data/lib/vellum_ai/types/iteration_state_enum.rb +14 -0
  211. data/lib/vellum_ai/types/jinja_prompt_block.rb +85 -0
  212. data/lib/vellum_ai/types/json_input.rb +69 -0
  213. data/lib/vellum_ai/types/json_input_request.rb +46 -28
  214. data/lib/vellum_ai/types/json_vellum_value.rb +62 -0
  215. data/lib/vellum_ai/types/json_vellum_value_request.rb +62 -0
  216. data/lib/vellum_ai/types/logical_operator.rb +57 -22
  217. data/lib/vellum_ai/types/logprobs_enum.rb +9 -3
  218. data/lib/vellum_ai/types/map_node_result.rb +70 -0
  219. data/lib/vellum_ai/types/map_node_result_data.rb +64 -0
  220. data/lib/vellum_ai/types/merge_node_result.rb +68 -0
  221. data/lib/vellum_ai/types/merge_node_result_data.rb +53 -0
  222. data/lib/vellum_ai/types/metadata_filter_config_request.rb +71 -57
  223. data/lib/vellum_ai/types/metadata_filter_rule_combinator.rb +9 -3
  224. data/lib/vellum_ai/types/metadata_filter_rule_request.rb +69 -57
  225. data/lib/vellum_ai/types/metadata_filters_request.rb +58 -0
  226. data/lib/vellum_ai/types/method_enum.rb +18 -0
  227. data/lib/vellum_ai/types/metric_definition_execution.rb +55 -0
  228. data/lib/vellum_ai/types/metric_definition_history_item.rb +96 -0
  229. data/lib/vellum_ai/types/metric_definition_input.rb +90 -0
  230. data/lib/vellum_ai/types/metric_node_result.rb +52 -0
  231. data/lib/vellum_ai/types/ml_model_read.rb +62 -0
  232. data/lib/vellum_ai/types/ml_model_usage.rb +98 -0
  233. data/lib/vellum_ai/types/ml_model_usage_wrapper.rb +67 -0
  234. data/lib/vellum_ai/types/named_scenario_input_chat_history_variable_value_request.rb +77 -0
  235. data/lib/vellum_ai/types/named_scenario_input_json_variable_value_request.rb +71 -0
  236. data/lib/vellum_ai/types/named_scenario_input_request.rb +74 -0
  237. data/lib/vellum_ai/types/named_scenario_input_string_variable_value_request.rb +73 -0
  238. data/lib/vellum_ai/types/named_test_case_array_variable_value.rb +75 -0
  239. data/lib/vellum_ai/types/named_test_case_array_variable_value_request.rb +76 -0
  240. data/lib/vellum_ai/types/named_test_case_chat_history_variable_value.rb +76 -0
  241. data/lib/vellum_ai/types/named_test_case_chat_history_variable_value_request.rb +53 -30
  242. data/lib/vellum_ai/types/named_test_case_error_variable_value.rb +77 -0
  243. data/lib/vellum_ai/types/named_test_case_error_variable_value_request.rb +52 -30
  244. data/lib/vellum_ai/types/named_test_case_function_call_variable_value.rb +78 -0
  245. data/lib/vellum_ai/types/named_test_case_function_call_variable_value_request.rb +79 -0
  246. data/lib/vellum_ai/types/named_test_case_json_variable_value.rb +69 -0
  247. data/lib/vellum_ai/types/named_test_case_json_variable_value_request.rb +48 -28
  248. data/lib/vellum_ai/types/named_test_case_number_variable_value.rb +71 -0
  249. data/lib/vellum_ai/types/named_test_case_number_variable_value_request.rb +51 -28
  250. data/lib/vellum_ai/types/named_test_case_search_results_variable_value.rb +77 -0
  251. data/lib/vellum_ai/types/named_test_case_search_results_variable_value_request.rb +53 -30
  252. data/lib/vellum_ai/types/named_test_case_string_variable_value.rb +71 -0
  253. data/lib/vellum_ai/types/named_test_case_string_variable_value_request.rb +51 -28
  254. data/lib/vellum_ai/types/named_test_case_variable_value.rb +154 -0
  255. data/lib/vellum_ai/types/named_test_case_variable_value_request.rb +131 -119
  256. data/lib/vellum_ai/types/new_member_join_behavior_enum.rb +14 -0
  257. data/lib/vellum_ai/types/node_execution_fulfilled_body.rb +87 -0
  258. data/lib/vellum_ai/types/node_execution_fulfilled_event.rb +134 -0
  259. data/lib/vellum_ai/types/node_execution_initiated_body.rb +67 -0
  260. data/lib/vellum_ai/types/node_execution_initiated_event.rb +134 -0
  261. data/lib/vellum_ai/types/node_execution_paused_body.rb +57 -0
  262. data/lib/vellum_ai/types/node_execution_paused_event.rb +134 -0
  263. data/lib/vellum_ai/types/node_execution_rejected_body.rb +73 -0
  264. data/lib/vellum_ai/types/node_execution_rejected_event.rb +134 -0
  265. data/lib/vellum_ai/types/node_execution_resumed_body.rb +57 -0
  266. data/lib/vellum_ai/types/node_execution_resumed_event.rb +134 -0
  267. data/lib/vellum_ai/types/node_execution_span.rb +118 -0
  268. data/lib/vellum_ai/types/node_execution_span_attributes.rb +51 -0
  269. data/lib/vellum_ai/types/node_execution_streaming_body.rb +73 -0
  270. data/lib/vellum_ai/types/node_execution_streaming_event.rb +134 -0
  271. data/lib/vellum_ai/types/node_input_compiled_array_value.rb +55 -33
  272. data/lib/vellum_ai/types/node_input_compiled_chat_history_value.rb +54 -32
  273. data/lib/vellum_ai/types/node_input_compiled_error_value.rb +55 -33
  274. data/lib/vellum_ai/types/node_input_compiled_function_call_value.rb +83 -0
  275. data/lib/vellum_ai/types/node_input_compiled_json_value.rb +50 -30
  276. data/lib/vellum_ai/types/node_input_compiled_number_value.rb +52 -30
  277. data/lib/vellum_ai/types/node_input_compiled_search_results_value.rb +54 -32
  278. data/lib/vellum_ai/types/node_input_compiled_secret_value.rb +81 -0
  279. data/lib/vellum_ai/types/node_input_compiled_string_value.rb +52 -30
  280. data/lib/vellum_ai/types/node_input_variable_compiled_value.rb +146 -131
  281. data/lib/vellum_ai/types/node_output_compiled_array_value.rb +60 -31
  282. data/lib/vellum_ai/types/node_output_compiled_chat_history_value.rb +59 -30
  283. data/lib/vellum_ai/types/node_output_compiled_error_value.rb +59 -30
  284. data/lib/vellum_ai/types/node_output_compiled_function_call_value.rb +85 -0
  285. data/lib/vellum_ai/types/node_output_compiled_json_value.rb +57 -28
  286. data/lib/vellum_ai/types/node_output_compiled_number_value.rb +57 -28
  287. data/lib/vellum_ai/types/node_output_compiled_search_results_value.rb +59 -30
  288. data/lib/vellum_ai/types/node_output_compiled_string_value.rb +57 -28
  289. data/lib/vellum_ai/types/node_output_compiled_value.rb +130 -144
  290. data/lib/vellum_ai/types/node_parent_context.rb +100 -0
  291. data/lib/vellum_ai/types/normalized_log_probs.rb +42 -29
  292. data/lib/vellum_ai/types/normalized_token_log_probs.rb +51 -35
  293. data/lib/vellum_ai/types/number_input.rb +69 -0
  294. data/lib/vellum_ai/types/number_vellum_value.rb +64 -0
  295. data/lib/vellum_ai/types/number_vellum_value_request.rb +64 -0
  296. data/lib/vellum_ai/types/open_ai_vectorizer_config.rb +54 -0
  297. data/lib/vellum_ai/types/open_ai_vectorizer_config_request.rb +54 -0
  298. data/lib/vellum_ai/types/open_ai_vectorizer_text_embedding_3_large.rb +68 -0
  299. data/lib/vellum_ai/types/open_ai_vectorizer_text_embedding_3_large_request.rb +70 -0
  300. data/lib/vellum_ai/types/open_ai_vectorizer_text_embedding_3_small.rb +68 -0
  301. data/lib/vellum_ai/types/open_ai_vectorizer_text_embedding_3_small_request.rb +70 -0
  302. data/lib/vellum_ai/types/open_ai_vectorizer_text_embedding_ada_002.rb +68 -0
  303. data/lib/vellum_ai/types/open_ai_vectorizer_text_embedding_ada_002_request.rb +70 -0
  304. data/lib/vellum_ai/types/organization_read.rb +78 -0
  305. data/lib/vellum_ai/types/paginated_container_image_read_list.rb +81 -0
  306. data/lib/vellum_ai/types/paginated_deployment_release_tag_read_list.rb +82 -0
  307. data/lib/vellum_ai/types/paginated_document_index_read_list.rb +55 -38
  308. data/lib/vellum_ai/types/paginated_folder_entity_list.rb +81 -0
  309. data/lib/vellum_ai/types/paginated_slim_deployment_read_list.rb +55 -38
  310. data/lib/vellum_ai/types/paginated_slim_document_list.rb +55 -38
  311. data/lib/vellum_ai/types/paginated_slim_workflow_deployment_list.rb +55 -38
  312. data/lib/vellum_ai/types/paginated_test_suite_run_execution_list.rb +55 -38
  313. data/lib/vellum_ai/types/paginated_test_suite_test_case_list.rb +81 -0
  314. data/lib/vellum_ai/types/paginated_workflow_release_tag_read_list.rb +81 -0
  315. data/lib/vellum_ai/types/paginated_workflow_sandbox_example_list.rb +81 -0
  316. data/lib/vellum_ai/types/parent_context.rb +122 -0
  317. data/lib/vellum_ai/types/pdf_search_result_meta_source.rb +75 -0
  318. data/lib/vellum_ai/types/pdf_search_result_meta_source_request.rb +75 -0
  319. data/lib/vellum_ai/types/plain_text_prompt_block.rb +85 -0
  320. data/lib/vellum_ai/types/price.rb +62 -0
  321. data/lib/vellum_ai/types/processing_failure_reason_enum.rb +9 -6
  322. data/lib/vellum_ai/types/prompt_block.rb +154 -0
  323. data/lib/vellum_ai/types/prompt_block_state.rb +12 -0
  324. data/lib/vellum_ai/types/prompt_deployment_expand_meta_request.rb +110 -0
  325. data/lib/vellum_ai/types/prompt_deployment_input_request.rb +53 -82
  326. data/lib/vellum_ai/types/prompt_deployment_parent_context.rb +143 -0
  327. data/lib/vellum_ai/types/prompt_deployment_release.rb +149 -0
  328. data/lib/vellum_ai/types/prompt_deployment_release_prompt_deployment.rb +53 -0
  329. data/lib/vellum_ai/types/prompt_deployment_release_prompt_version.rb +68 -0
  330. data/lib/vellum_ai/types/prompt_exec_config.rb +115 -0
  331. data/lib/vellum_ai/types/prompt_execution_meta.rb +87 -50
  332. data/lib/vellum_ai/types/prompt_node_execution_meta.rb +84 -0
  333. data/lib/vellum_ai/types/prompt_node_result.rb +43 -27
  334. data/lib/vellum_ai/types/prompt_node_result_data.rb +72 -36
  335. data/lib/vellum_ai/types/prompt_output.rb +72 -98
  336. data/lib/vellum_ai/types/prompt_parameters.rb +112 -0
  337. data/lib/vellum_ai/types/prompt_push_response.rb +61 -0
  338. data/lib/vellum_ai/types/prompt_request_chat_history_input.rb +72 -0
  339. data/lib/vellum_ai/types/prompt_request_input.rb +74 -0
  340. data/lib/vellum_ai/types/prompt_request_json_input.rb +68 -0
  341. data/lib/vellum_ai/types/prompt_request_string_input.rb +68 -0
  342. data/lib/vellum_ai/types/prompt_settings.rb +63 -0
  343. data/lib/vellum_ai/types/prompt_version_build_config_sandbox.rb +75 -0
  344. data/lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb +45 -30
  345. data/lib/vellum_ai/types/reducto_chunker_config.rb +54 -0
  346. data/lib/vellum_ai/types/reducto_chunker_config_request.rb +54 -0
  347. data/lib/vellum_ai/types/reducto_chunking.rb +70 -0
  348. data/lib/vellum_ai/types/reducto_chunking_request.rb +70 -0
  349. data/lib/vellum_ai/types/rejected_ad_hoc_execute_prompt_event.rb +90 -0
  350. data/lib/vellum_ai/types/rejected_execute_prompt_event.rb +60 -38
  351. data/lib/vellum_ai/types/rejected_execute_prompt_response.rb +67 -41
  352. data/lib/vellum_ai/types/rejected_execute_workflow_workflow_result_event.rb +60 -33
  353. data/lib/vellum_ai/types/rejected_prompt_execution_meta.rb +43 -29
  354. data/lib/vellum_ai/types/rejected_workflow_node_result_event.rb +86 -62
  355. data/lib/vellum_ai/types/release_created_by.rb +70 -0
  356. data/lib/vellum_ai/types/release_environment.rb +68 -0
  357. data/lib/vellum_ai/types/release_release_tag.rb +66 -0
  358. data/lib/vellum_ai/types/release_review_reviewer.rb +63 -0
  359. data/lib/vellum_ai/types/release_review_state.rb +14 -0
  360. data/lib/vellum_ai/types/release_tag_release.rb +66 -0
  361. data/lib/vellum_ai/types/release_tag_source.rb +12 -0
  362. data/lib/vellum_ai/types/replace_test_suite_test_case_request.rb +98 -0
  363. data/lib/vellum_ai/types/rich_text_child_block.rb +58 -0
  364. data/lib/vellum_ai/types/rich_text_prompt_block.rb +89 -0
  365. data/lib/vellum_ai/types/sandbox_scenario.rb +47 -31
  366. data/lib/vellum_ai/types/scenario_input.rb +57 -53
  367. data/lib/vellum_ai/types/scenario_input_chat_history_variable_value.rb +76 -0
  368. data/lib/vellum_ai/types/scenario_input_json_variable_value.rb +69 -0
  369. data/lib/vellum_ai/types/scenario_input_string_variable_value.rb +71 -0
  370. data/lib/vellum_ai/types/search_filters_request.rb +44 -31
  371. data/lib/vellum_ai/types/search_node_result.rb +43 -27
  372. data/lib/vellum_ai/types/search_node_result_data.rb +54 -41
  373. data/lib/vellum_ai/types/search_request_options_request.rb +63 -47
  374. data/lib/vellum_ai/types/search_response.rb +31 -23
  375. data/lib/vellum_ai/types/search_result.rb +62 -32
  376. data/lib/vellum_ai/types/search_result_document.rb +55 -34
  377. data/lib/vellum_ai/types/search_result_document_request.rb +56 -30
  378. data/lib/vellum_ai/types/search_result_merging_request.rb +30 -22
  379. data/lib/vellum_ai/types/search_result_meta.rb +60 -0
  380. data/lib/vellum_ai/types/search_result_meta_request.rb +60 -0
  381. data/lib/vellum_ai/types/search_result_request.rb +62 -32
  382. data/lib/vellum_ai/types/search_results_input.rb +73 -0
  383. data/lib/vellum_ai/types/search_results_vellum_value.rb +68 -0
  384. data/lib/vellum_ai/types/search_results_vellum_value_request.rb +68 -0
  385. data/lib/vellum_ai/types/search_weights_request.rb +39 -26
  386. data/lib/vellum_ai/types/secret_type_enum.rb +16 -0
  387. data/lib/vellum_ai/types/sentence_chunker_config.rb +64 -0
  388. data/lib/vellum_ai/types/sentence_chunker_config_request.rb +64 -0
  389. data/lib/vellum_ai/types/sentence_chunking.rb +70 -0
  390. data/lib/vellum_ai/types/sentence_chunking_request.rb +70 -0
  391. data/lib/vellum_ai/types/slim_deployment_read.rb +99 -70
  392. data/lib/vellum_ai/types/slim_document.rb +102 -85
  393. data/lib/vellum_ai/types/slim_document_document_to_document_index.rb +96 -0
  394. data/lib/vellum_ai/types/slim_release_review.rb +87 -0
  395. data/lib/vellum_ai/types/slim_workflow_deployment.rb +109 -77
  396. data/lib/vellum_ai/types/slim_workflow_execution_read.rb +162 -0
  397. data/lib/vellum_ai/types/span_link.rb +75 -0
  398. data/lib/vellum_ai/types/{chat_history_enum.rb → span_link_type_enum.rb} +2 -2
  399. data/lib/vellum_ai/types/streaming_ad_hoc_execute_prompt_event.rb +106 -0
  400. data/lib/vellum_ai/types/streaming_execute_prompt_event.rb +73 -52
  401. data/lib/vellum_ai/types/streaming_prompt_execution_meta.rb +33 -24
  402. data/lib/vellum_ai/types/streaming_workflow_node_result_event.rb +93 -69
  403. data/lib/vellum_ai/types/string_chat_message_content.rb +40 -24
  404. data/lib/vellum_ai/types/string_chat_message_content_request.rb +40 -24
  405. data/lib/vellum_ai/types/string_input.rb +69 -0
  406. data/lib/vellum_ai/types/string_input_request.rb +45 -27
  407. data/lib/vellum_ai/types/string_vellum_value.rb +64 -0
  408. data/lib/vellum_ai/types/string_vellum_value_request.rb +64 -0
  409. data/lib/vellum_ai/types/submit_completion_actual_request.rb +76 -39
  410. data/lib/vellum_ai/types/submit_workflow_execution_actual_request.rb +53 -82
  411. data/lib/vellum_ai/types/subworkflow_node_result.rb +51 -21
  412. data/lib/vellum_ai/types/subworkflow_node_result_data.rb +53 -0
  413. data/lib/vellum_ai/types/templating_node_array_result.rb +74 -0
  414. data/lib/vellum_ai/types/templating_node_chat_history_result.rb +49 -29
  415. data/lib/vellum_ai/types/templating_node_error_result.rb +50 -30
  416. data/lib/vellum_ai/types/templating_node_function_call_result.rb +76 -0
  417. data/lib/vellum_ai/types/templating_node_json_result.rb +45 -27
  418. data/lib/vellum_ai/types/templating_node_number_result.rb +47 -27
  419. data/lib/vellum_ai/types/templating_node_result.rb +43 -27
  420. data/lib/vellum_ai/types/templating_node_result_data.rb +30 -24
  421. data/lib/vellum_ai/types/templating_node_result_output.rb +131 -119
  422. data/lib/vellum_ai/types/templating_node_search_results_result.rb +49 -29
  423. data/lib/vellum_ai/types/templating_node_string_result.rb +47 -27
  424. data/lib/vellum_ai/types/terminal_node_array_result.rb +55 -33
  425. data/lib/vellum_ai/types/terminal_node_chat_history_result.rb +54 -32
  426. data/lib/vellum_ai/types/terminal_node_error_result.rb +55 -33
  427. data/lib/vellum_ai/types/terminal_node_function_call_result.rb +55 -33
  428. data/lib/vellum_ai/types/terminal_node_json_result.rb +52 -30
  429. data/lib/vellum_ai/types/terminal_node_number_result.rb +52 -30
  430. data/lib/vellum_ai/types/terminal_node_result.rb +43 -27
  431. data/lib/vellum_ai/types/terminal_node_result_data.rb +30 -24
  432. data/lib/vellum_ai/types/terminal_node_result_output.rb +130 -144
  433. data/lib/vellum_ai/types/terminal_node_search_results_result.rb +54 -32
  434. data/lib/vellum_ai/types/terminal_node_string_result.rb +52 -30
  435. data/lib/vellum_ai/types/test_case_array_variable_value.rb +82 -0
  436. data/lib/vellum_ai/types/test_case_chat_history_variable_value.rb +57 -29
  437. data/lib/vellum_ai/types/test_case_error_variable_value.rb +58 -30
  438. data/lib/vellum_ai/types/test_case_function_call_variable_value.rb +84 -0
  439. data/lib/vellum_ai/types/test_case_json_variable_value.rb +53 -27
  440. data/lib/vellum_ai/types/test_case_number_variable_value.rb +55 -27
  441. data/lib/vellum_ai/types/test_case_search_results_variable_value.rb +57 -29
  442. data/lib/vellum_ai/types/test_case_string_variable_value.rb +55 -27
  443. data/lib/vellum_ai/types/test_case_variable_value.rb +131 -119
  444. data/lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config.rb +55 -31
  445. data/lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config_data.rb +43 -26
  446. data/lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config_data_request.rb +43 -26
  447. data/lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config_request.rb +55 -31
  448. data/lib/vellum_ai/types/test_suite_run_exec_config.rb +86 -70
  449. data/lib/vellum_ai/types/test_suite_run_exec_config_request.rb +118 -70
  450. data/lib/vellum_ai/types/test_suite_run_execution.rb +51 -37
  451. data/lib/vellum_ai/types/test_suite_run_execution_array_output.rb +83 -0
  452. data/lib/vellum_ai/types/test_suite_run_execution_chat_history_output.rb +60 -30
  453. data/lib/vellum_ai/types/test_suite_run_execution_error_output.rb +59 -30
  454. data/lib/vellum_ai/types/test_suite_run_execution_function_call_output.rb +87 -0
  455. data/lib/vellum_ai/types/test_suite_run_execution_json_output.rb +55 -28
  456. data/lib/vellum_ai/types/test_suite_run_execution_metric_definition.rb +71 -0
  457. data/lib/vellum_ai/types/test_suite_run_execution_metric_result.rb +60 -27
  458. data/lib/vellum_ai/types/test_suite_run_execution_number_output.rb +57 -28
  459. data/lib/vellum_ai/types/test_suite_run_execution_output.rb +131 -119
  460. data/lib/vellum_ai/types/test_suite_run_execution_search_results_output.rb +61 -30
  461. data/lib/vellum_ai/types/test_suite_run_execution_string_output.rb +57 -28
  462. data/lib/vellum_ai/types/test_suite_run_external_exec_config.rb +80 -0
  463. data/lib/vellum_ai/types/test_suite_run_external_exec_config_data.rb +57 -0
  464. data/lib/vellum_ai/types/test_suite_run_external_exec_config_data_request.rb +59 -0
  465. data/lib/vellum_ai/types/test_suite_run_external_exec_config_request.rb +81 -0
  466. data/lib/vellum_ai/types/test_suite_run_metric_array_output.rb +75 -0
  467. data/lib/vellum_ai/types/test_suite_run_metric_error_output.rb +48 -30
  468. data/lib/vellum_ai/types/test_suite_run_metric_json_output.rb +69 -0
  469. data/lib/vellum_ai/types/test_suite_run_metric_number_output.rb +49 -29
  470. data/lib/vellum_ai/types/test_suite_run_metric_output.rb +86 -70
  471. data/lib/vellum_ai/types/test_suite_run_metric_string_output.rb +71 -0
  472. data/lib/vellum_ai/types/test_suite_run_progress.rb +61 -0
  473. data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_exec_config_data_request.rb +65 -0
  474. data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_exec_config_request.rb +81 -0
  475. data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config.rb +82 -0
  476. data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config_data.rb +65 -0
  477. data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config_data_request.rb +65 -0
  478. data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config_request.rb +82 -0
  479. data/lib/vellum_ai/types/test_suite_run_read.rb +89 -60
  480. data/lib/vellum_ai/types/test_suite_run_state.rb +15 -9
  481. data/lib/vellum_ai/types/test_suite_run_test_suite.rb +41 -28
  482. data/lib/vellum_ai/types/test_suite_run_workflow_release_tag_exec_config.rb +55 -31
  483. data/lib/vellum_ai/types/test_suite_run_workflow_release_tag_exec_config_data.rb +43 -26
  484. data/lib/vellum_ai/types/test_suite_run_workflow_release_tag_exec_config_data_request.rb +43 -26
  485. data/lib/vellum_ai/types/test_suite_run_workflow_release_tag_exec_config_request.rb +55 -31
  486. data/lib/vellum_ai/types/test_suite_run_workflow_sandbox_exec_config_data_request.rb +53 -0
  487. data/lib/vellum_ai/types/test_suite_run_workflow_sandbox_exec_config_request.rb +81 -0
  488. data/lib/vellum_ai/types/test_suite_run_workflow_sandbox_history_item_exec_config.rb +82 -0
  489. data/lib/vellum_ai/types/test_suite_run_workflow_sandbox_history_item_exec_config_data.rb +67 -0
  490. data/lib/vellum_ai/types/test_suite_run_workflow_sandbox_history_item_exec_config_data_request.rb +67 -0
  491. data/lib/vellum_ai/types/test_suite_run_workflow_sandbox_history_item_exec_config_request.rb +82 -0
  492. data/lib/vellum_ai/types/test_suite_test_case.rb +63 -40
  493. data/lib/vellum_ai/types/test_suite_test_case_bulk_operation_request.rb +91 -0
  494. data/lib/vellum_ai/types/test_suite_test_case_bulk_result.rb +90 -0
  495. data/lib/vellum_ai/types/test_suite_test_case_create_bulk_operation_request.rb +79 -0
  496. data/lib/vellum_ai/types/test_suite_test_case_created_bulk_result.rb +75 -0
  497. data/lib/vellum_ai/types/test_suite_test_case_created_bulk_result_data.rb +53 -0
  498. data/lib/vellum_ai/types/test_suite_test_case_delete_bulk_operation_data_request.rb +53 -0
  499. data/lib/vellum_ai/types/test_suite_test_case_delete_bulk_operation_request.rb +79 -0
  500. data/lib/vellum_ai/types/test_suite_test_case_deleted_bulk_result.rb +77 -0
  501. data/lib/vellum_ai/types/test_suite_test_case_deleted_bulk_result_data.rb +53 -0
  502. data/lib/vellum_ai/types/test_suite_test_case_rejected_bulk_result.rb +73 -0
  503. data/lib/vellum_ai/types/test_suite_test_case_replace_bulk_operation_request.rb +79 -0
  504. data/lib/vellum_ai/types/test_suite_test_case_replaced_bulk_result.rb +77 -0
  505. data/lib/vellum_ai/types/test_suite_test_case_replaced_bulk_result_data.rb +54 -0
  506. data/lib/vellum_ai/types/test_suite_test_case_upsert_bulk_operation_request.rb +79 -0
  507. data/lib/vellum_ai/types/token_overlapping_window_chunker_config.rb +64 -0
  508. data/lib/vellum_ai/types/token_overlapping_window_chunker_config_request.rb +66 -0
  509. data/lib/vellum_ai/types/token_overlapping_window_chunking.rb +70 -0
  510. data/lib/vellum_ai/types/token_overlapping_window_chunking_request.rb +71 -0
  511. data/lib/vellum_ai/types/{json_enum.rb → unit_enum.rb} +2 -2
  512. data/lib/vellum_ai/types/upload_document_response.rb +26 -20
  513. data/lib/vellum_ai/types/upsert_test_suite_test_case_request.rb +103 -0
  514. data/lib/vellum_ai/types/variable_prompt_block.rb +85 -0
  515. data/lib/vellum_ai/types/vellum_audio.rb +63 -0
  516. data/lib/vellum_ai/types/vellum_audio_request.rb +63 -0
  517. data/lib/vellum_ai/types/vellum_code_resource_definition.rb +68 -0
  518. data/lib/vellum_ai/types/vellum_document.rb +63 -0
  519. data/lib/vellum_ai/types/vellum_document_request.rb +63 -0
  520. data/lib/vellum_ai/types/vellum_error.rb +36 -25
  521. data/lib/vellum_ai/types/vellum_error_code_enum.rb +17 -8
  522. data/lib/vellum_ai/types/vellum_error_request.rb +36 -25
  523. data/lib/vellum_ai/types/vellum_image.rb +40 -27
  524. data/lib/vellum_ai/types/vellum_image_request.rb +40 -27
  525. data/lib/vellum_ai/types/vellum_node_execution_event.rb +122 -0
  526. data/lib/vellum_ai/types/vellum_sdk_error.rb +62 -0
  527. data/lib/vellum_ai/types/vellum_sdk_error_code_enum.rb +32 -0
  528. data/lib/vellum_ai/types/vellum_secret.rb +51 -0
  529. data/lib/vellum_ai/types/vellum_span.rb +58 -0
  530. data/lib/vellum_ai/types/vellum_value.rb +202 -0
  531. data/lib/vellum_ai/types/vellum_value_logical_condition_group_request.rb +84 -0
  532. data/lib/vellum_ai/types/vellum_value_logical_condition_request.rb +88 -0
  533. data/lib/vellum_ai/types/vellum_value_logical_expression_request.rb +58 -0
  534. data/lib/vellum_ai/types/vellum_value_request.rb +202 -0
  535. data/lib/vellum_ai/types/vellum_variable.rb +77 -29
  536. data/lib/vellum_ai/types/vellum_variable_extensions.rb +54 -0
  537. data/lib/vellum_ai/types/vellum_variable_type.rb +29 -13
  538. data/lib/vellum_ai/types/vellum_workflow_execution_event.rb +138 -0
  539. data/lib/vellum_ai/types/workflow_deployment_event_executions_response.rb +67 -0
  540. data/lib/vellum_ai/types/workflow_deployment_history_item.rb +117 -0
  541. data/lib/vellum_ai/types/workflow_deployment_parent_context.rb +143 -0
  542. data/lib/vellum_ai/types/workflow_deployment_read.rb +120 -77
  543. data/lib/vellum_ai/types/workflow_deployment_release.rb +149 -0
  544. data/lib/vellum_ai/types/workflow_deployment_release_workflow_deployment.rb +53 -0
  545. data/lib/vellum_ai/types/workflow_deployment_release_workflow_version.rb +77 -0
  546. data/lib/vellum_ai/types/workflow_error.rb +58 -0
  547. data/lib/vellum_ai/types/workflow_event_error.rb +36 -25
  548. data/lib/vellum_ai/types/workflow_event_execution_read.rb +173 -0
  549. data/lib/vellum_ai/types/workflow_execution_actual.rb +88 -0
  550. data/lib/vellum_ai/types/workflow_execution_actual_chat_history_request.rb +87 -50
  551. data/lib/vellum_ai/types/workflow_execution_actual_json_request.rb +83 -48
  552. data/lib/vellum_ai/types/workflow_execution_actual_string_request.rb +82 -47
  553. data/lib/vellum_ai/types/workflow_execution_event_error_code.rb +25 -12
  554. data/lib/vellum_ai/types/workflow_execution_event_type.rb +9 -3
  555. data/lib/vellum_ai/types/workflow_execution_fulfilled_body.rb +67 -0
  556. data/lib/vellum_ai/types/workflow_execution_fulfilled_event.rb +134 -0
  557. data/lib/vellum_ai/types/workflow_execution_initiated_body.rb +67 -0
  558. data/lib/vellum_ai/types/workflow_execution_initiated_event.rb +134 -0
  559. data/lib/vellum_ai/types/workflow_execution_node_result_event.rb +62 -39
  560. data/lib/vellum_ai/types/workflow_execution_paused_body.rb +71 -0
  561. data/lib/vellum_ai/types/workflow_execution_paused_event.rb +134 -0
  562. data/lib/vellum_ai/types/workflow_execution_rejected_body.rb +73 -0
  563. data/lib/vellum_ai/types/workflow_execution_rejected_event.rb +134 -0
  564. data/lib/vellum_ai/types/workflow_execution_resumed_body.rb +57 -0
  565. data/lib/vellum_ai/types/workflow_execution_resumed_event.rb +134 -0
  566. data/lib/vellum_ai/types/workflow_execution_snapshotted_body.rb +67 -0
  567. data/lib/vellum_ai/types/workflow_execution_snapshotted_event.rb +134 -0
  568. data/lib/vellum_ai/types/workflow_execution_span.rb +118 -0
  569. data/lib/vellum_ai/types/workflow_execution_span_attributes.rb +51 -0
  570. data/lib/vellum_ai/types/workflow_execution_streaming_body.rb +73 -0
  571. data/lib/vellum_ai/types/workflow_execution_streaming_event.rb +134 -0
  572. data/lib/vellum_ai/types/workflow_execution_usage_calculation_error.rb +63 -0
  573. data/lib/vellum_ai/types/workflow_execution_usage_calculation_error_code_enum.rb +16 -0
  574. data/lib/vellum_ai/types/workflow_execution_usage_result.rb +84 -0
  575. data/lib/vellum_ai/types/workflow_execution_view_online_eval_metric_result.rb +74 -0
  576. data/lib/vellum_ai/types/workflow_execution_workflow_result_event.rb +62 -39
  577. data/lib/vellum_ai/types/workflow_expand_meta_request.rb +74 -0
  578. data/lib/vellum_ai/types/workflow_initialization_error.rb +62 -0
  579. data/lib/vellum_ai/types/workflow_node_result_data.rb +177 -143
  580. data/lib/vellum_ai/types/workflow_node_result_event.rb +68 -94
  581. data/lib/vellum_ai/types/workflow_node_result_event_state.rb +13 -8
  582. data/lib/vellum_ai/types/workflow_output.rb +144 -155
  583. data/lib/vellum_ai/types/workflow_output_array.rb +55 -33
  584. data/lib/vellum_ai/types/workflow_output_chat_history.rb +54 -32
  585. data/lib/vellum_ai/types/workflow_output_error.rb +55 -33
  586. data/lib/vellum_ai/types/workflow_output_function_call.rb +55 -33
  587. data/lib/vellum_ai/types/workflow_output_image.rb +55 -33
  588. data/lib/vellum_ai/types/workflow_output_json.rb +50 -30
  589. data/lib/vellum_ai/types/workflow_output_number.rb +52 -30
  590. data/lib/vellum_ai/types/workflow_output_search_results.rb +54 -32
  591. data/lib/vellum_ai/types/workflow_output_string.rb +52 -30
  592. data/lib/vellum_ai/types/workflow_parent_context.rb +100 -0
  593. data/lib/vellum_ai/types/workflow_push_deployment_config_request.rb +77 -0
  594. data/lib/vellum_ai/types/workflow_push_response.rb +70 -0
  595. data/lib/vellum_ai/types/workflow_release_tag_read.rb +92 -0
  596. data/lib/vellum_ai/types/workflow_release_tag_workflow_deployment_history_item.rb +68 -0
  597. data/lib/vellum_ai/types/workflow_request_chat_history_input_request.rb +47 -28
  598. data/lib/vellum_ai/types/workflow_request_input_request.rb +68 -94
  599. data/lib/vellum_ai/types/workflow_request_json_input_request.rb +45 -27
  600. data/lib/vellum_ai/types/workflow_request_number_input_request.rb +44 -26
  601. data/lib/vellum_ai/types/workflow_request_string_input_request.rb +44 -26
  602. data/lib/vellum_ai/types/workflow_result_event.rb +86 -68
  603. data/lib/vellum_ai/types/workflow_result_event_output_data.rb +129 -143
  604. data/lib/vellum_ai/types/workflow_result_event_output_data_array.rb +76 -53
  605. data/lib/vellum_ai/types/workflow_result_event_output_data_chat_history.rb +77 -52
  606. data/lib/vellum_ai/types/workflow_result_event_output_data_error.rb +76 -53
  607. data/lib/vellum_ai/types/workflow_result_event_output_data_function_call.rb +78 -53
  608. data/lib/vellum_ai/types/workflow_result_event_output_data_json.rb +72 -49
  609. data/lib/vellum_ai/types/workflow_result_event_output_data_number.rb +72 -49
  610. data/lib/vellum_ai/types/workflow_result_event_output_data_search_results.rb +77 -52
  611. data/lib/vellum_ai/types/workflow_result_event_output_data_string.rb +71 -48
  612. data/lib/vellum_ai/types/workflow_sandbox_example.rb +77 -0
  613. data/lib/vellum_ai/types/workflow_sandbox_parent_context.rb +108 -0
  614. data/lib/vellum_ai/types/workflow_stream_event.rb +38 -70
  615. data/lib/vellum_ai/types/workspace_read.rb +80 -0
  616. data/lib/vellum_ai/types/workspace_secret_read.rb +88 -0
  617. data/lib/vellum_ai/workflow_deployments/client.rb +534 -66
  618. data/lib/vellum_ai/workflow_deployments/types/list_workflow_release_tags_request_source.rb +12 -0
  619. data/lib/vellum_ai/workflow_deployments/types/workflow_deployments_list_request_status.rb +7 -3
  620. data/lib/vellum_ai/workflow_sandboxes/client.rb +183 -0
  621. data/lib/vellum_ai/workflow_sandboxes/types/list_workflow_sandbox_examples_request_tag.rb +12 -0
  622. data/lib/vellum_ai/workflows/client.rb +169 -0
  623. data/lib/vellum_ai/workspace_secrets/client.rb +159 -0
  624. data/lib/vellum_ai/workspaces/client.rb +92 -0
  625. data/lib/vellum_ai.rb +786 -392
  626. metadata +438 -95
  627. data/lib/vellum_ai/model_versions/client.rb +0 -61
  628. data/lib/vellum_ai/registered_prompts/client.rb +0 -154
  629. data/lib/vellum_ai/types/array_enum.rb +0 -5
  630. data/lib/vellum_ai/types/array_variable_value_item.rb +0 -168
  631. data/lib/vellum_ai/types/block_type_enum.rb +0 -11
  632. data/lib/vellum_ai/types/chat_history_variable_value.rb +0 -49
  633. data/lib/vellum_ai/types/error_enum.rb +0 -5
  634. data/lib/vellum_ai/types/error_variable_value.rb +0 -51
  635. data/lib/vellum_ai/types/execute_prompt_api_error_response.rb +0 -45
  636. data/lib/vellum_ai/types/execute_workflow_error_response.rb +0 -45
  637. data/lib/vellum_ai/types/execute_workflow_stream_error_response.rb +0 -45
  638. data/lib/vellum_ai/types/fulfilled_enum.rb +0 -5
  639. data/lib/vellum_ai/types/fulfilled_function_call.rb +0 -56
  640. data/lib/vellum_ai/types/function_call_enum.rb +0 -5
  641. data/lib/vellum_ai/types/function_call_variable_value.rb +0 -51
  642. data/lib/vellum_ai/types/generate_error_response.rb +0 -45
  643. data/lib/vellum_ai/types/image_variable_value.rb +0 -52
  644. data/lib/vellum_ai/types/initiated_enum.rb +0 -5
  645. data/lib/vellum_ai/types/json_variable_value.rb +0 -45
  646. data/lib/vellum_ai/types/model_version_build_config.rb +0 -66
  647. data/lib/vellum_ai/types/model_version_exec_config.rb +0 -90
  648. data/lib/vellum_ai/types/model_version_exec_config_parameters.rb +0 -98
  649. data/lib/vellum_ai/types/model_version_read.rb +0 -133
  650. data/lib/vellum_ai/types/model_version_read_status_enum.rb +0 -11
  651. data/lib/vellum_ai/types/model_version_sandbox_snapshot.rb +0 -61
  652. data/lib/vellum_ai/types/node_output_compiled_function_value.rb +0 -56
  653. data/lib/vellum_ai/types/number_enum.rb +0 -5
  654. data/lib/vellum_ai/types/number_variable_value.rb +0 -45
  655. data/lib/vellum_ai/types/processing_state_enum.rb +0 -11
  656. data/lib/vellum_ai/types/prompt_deployment_expand_meta_request_request.rb +0 -74
  657. data/lib/vellum_ai/types/prompt_template_block.rb +0 -62
  658. data/lib/vellum_ai/types/prompt_template_block_data.rb +0 -54
  659. data/lib/vellum_ai/types/prompt_template_block_data_request.rb +0 -54
  660. data/lib/vellum_ai/types/prompt_template_block_properties.rb +0 -110
  661. data/lib/vellum_ai/types/prompt_template_block_properties_request.rb +0 -110
  662. data/lib/vellum_ai/types/prompt_template_block_request.rb +0 -62
  663. data/lib/vellum_ai/types/provider_enum.rb +0 -20
  664. data/lib/vellum_ai/types/register_prompt_error_response.rb +0 -45
  665. data/lib/vellum_ai/types/register_prompt_model_parameters_request.rb +0 -98
  666. data/lib/vellum_ai/types/register_prompt_prompt.rb +0 -50
  667. data/lib/vellum_ai/types/register_prompt_prompt_info_request.rb +0 -60
  668. data/lib/vellum_ai/types/register_prompt_response.rb +0 -110
  669. data/lib/vellum_ai/types/registered_prompt_deployment.rb +0 -55
  670. data/lib/vellum_ai/types/registered_prompt_input_variable_request.rb +0 -56
  671. data/lib/vellum_ai/types/registered_prompt_model_version.rb +0 -50
  672. data/lib/vellum_ai/types/registered_prompt_sandbox.rb +0 -50
  673. data/lib/vellum_ai/types/registered_prompt_sandbox_snapshot.rb +0 -45
  674. data/lib/vellum_ai/types/rejected_enum.rb +0 -5
  675. data/lib/vellum_ai/types/rejected_function_call.rb +0 -62
  676. data/lib/vellum_ai/types/scenario_input_request.rb +0 -70
  677. data/lib/vellum_ai/types/scenario_input_type_enum.rb +0 -6
  678. data/lib/vellum_ai/types/search_error_response.rb +0 -45
  679. data/lib/vellum_ai/types/search_results_enum.rb +0 -5
  680. data/lib/vellum_ai/types/search_results_variable_value.rb +0 -49
  681. data/lib/vellum_ai/types/streaming_enum.rb +0 -5
  682. data/lib/vellum_ai/types/string_enum.rb +0 -5
  683. data/lib/vellum_ai/types/string_variable_value.rb +0 -45
  684. data/lib/vellum_ai/types/submit_completion_actuals_error_response.rb +0 -45
  685. data/lib/vellum_ai/types/subworkflow_enum.rb +0 -5
  686. data/lib/vellum_ai/types/test_suite_run_deployment_release_tag_exec_config_type_enum.rb +0 -5
  687. data/lib/vellum_ai/types/test_suite_run_metric_error_output_type_enum.rb +0 -5
  688. data/lib/vellum_ai/types/test_suite_run_metric_number_output_type_enum.rb +0 -5
  689. data/lib/vellum_ai/types/test_suite_run_workflow_release_tag_exec_config_type_enum.rb +0 -5
  690. data/lib/vellum_ai/types/upload_document_error_response.rb +0 -45
@@ -1,66 +1,198 @@
1
1
  # frozen_string_literal: true
2
-
3
2
  require_relative "../../requests"
3
+ require_relative "types/folder_entities_list_request_entity_status"
4
+ require_relative "../types/paginated_folder_entity_list"
5
+ require "async"
4
6
  require "async"
7
+ require_relative "../../requests"
5
8
 
6
9
  module Vellum
7
10
  class FolderEntitiesClient
11
+ # @return [Vellum::RequestClient]
8
12
  attr_reader :request_client
9
13
 
10
- # @param request_client [RequestClient]
11
- # @return [FolderEntitiesClient]
14
+
15
+ # @param request_client [Vellum::RequestClient]
16
+ # @return [Vellum::FolderEntitiesClient]
12
17
  def initialize(request_client:)
13
- # @type [RequestClient]
14
18
  @request_client = request_client
15
19
  end
16
-
17
- # Add an entity to a specific folder or root directory.
20
+ # List all folder entities within a specified folder.
18
21
  #
19
- # Adding an entity to a folder will remove it from any other folders it might have been a member of.
22
+ # @param entity_status [Vellum::FolderEntities::FolderEntitiesListRequestEntityStatus] Filter down to only those objects whose entities have a status matching the
23
+ # status specified.
24
+ # * `ACTIVE` - Active
25
+ # * `ARCHIVED` - Archived
26
+ # @param limit [Integer] Number of results to return per page.
27
+ # @param offset [Integer] The initial index from which to return the results.
28
+ # @param ordering [String] Which field to use when ordering the results.
29
+ # @param parent_folder_id [String] Filter down to only those entities whose parent folder has the specified ID.
30
+ # To filter by an entity's parent folder, provide the ID of the parent folder. To
31
+ # filter by the root directory, provide
32
+ # a string representing the entity type of the root directory. Supported root
33
+ # directories include:
34
+ # - PROMPT_SANDBOX
35
+ # - WORKFLOW_SANDBOX
36
+ # - DOCUMENT_INDEX
37
+ # - TEST_SUITE
38
+ # @param request_options [Vellum::RequestOptions]
39
+ # @return [Vellum::PaginatedFolderEntityList]
40
+ # @example
41
+ # api = Vellum::Client.new(
42
+ # base_url: "https://api.example.com",
43
+ # environment: Vellum::Environment::PRODUCTION,
44
+ # api_key: "YOUR_API_KEY"
45
+ # )
46
+ # api.folder_entities.list(parent_folder_id: "parent_folder_id")
47
+ def list(entity_status: nil, limit: nil, offset: nil, ordering: nil, parent_folder_id:, request_options: nil)
48
+ response = @request_client.conn.get do | req |
49
+ unless request_options&.timeout_in_seconds.nil?
50
+ req.options.timeout = request_options.timeout_in_seconds
51
+ end
52
+ unless request_options&.api_key.nil?
53
+ req.headers["X-API-KEY"] = request_options.api_key
54
+ end
55
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
56
+ req.params = { **(request_options&.additional_query_parameters || {}), "entity_status": entity_status, "limit": limit, "offset": offset, "ordering": ordering, "parent_folder_id": parent_folder_id }.compact
57
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
58
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
59
+ end
60
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/folder-entities"
61
+ end
62
+ Vellum::PaginatedFolderEntityList.from_json(json_object: response.body)
63
+ end
64
+ # Add an entity to a specific folder or root directory.
65
+ # Adding an entity to a folder will remove it from any other folders it might have
66
+ # been a member of.
20
67
  #
21
- # @param folder_id [String] The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root directory (e.g. "PROMPT_SANDBOX").
68
+ # @param folder_id [String] The ID of the folder to which the entity should be added. This can be a UUID of
69
+ # a folder, or the name of a root
70
+ # directory. Supported root directories include:
71
+ # - PROMPT_SANDBOX
72
+ # - WORKFLOW_SANDBOX
73
+ # - DOCUMENT_INDEX
74
+ # - TEST_SUITE
22
75
  # @param entity_id [String] The ID of the entity you would like to move.
23
- # @param request_options [RequestOptions]
76
+ # @param request_options [Vellum::RequestOptions]
24
77
  # @return [Void]
78
+ # @example
79
+ # api = Vellum::Client.new(
80
+ # base_url: "https://api.example.com",
81
+ # environment: Vellum::Environment::PRODUCTION,
82
+ # api_key: "YOUR_API_KEY"
83
+ # )
84
+ # api.folder_entities.add_entity_to_folder(folder_id: "folder_id", entity_id: "entity_id")
25
85
  def add_entity_to_folder(folder_id:, entity_id:, request_options: nil)
26
- @request_client.conn.post do |req|
27
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
28
- req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
29
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
30
- req.body = { **(request_options&.additional_body_parameters || {}), entity_id: entity_id }.compact
31
- req.url "#{@request_client.default_environment[:Default]}/v1/folders/#{folder_id}/add-entity"
32
- end
86
+ response = @request_client.conn.post do | req |
87
+ unless request_options&.timeout_in_seconds.nil?
88
+ req.options.timeout = request_options.timeout_in_seconds
89
+ end
90
+ unless request_options&.api_key.nil?
91
+ req.headers["X-API-KEY"] = request_options.api_key
92
+ end
93
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
94
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
95
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
96
+ end
97
+ req.body = { **(request_options&.additional_body_parameters || {}), entity_id: entity_id }.compact
98
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/folders/#{folder_id}/add-entity"
99
+ end
33
100
  end
34
101
  end
35
-
36
102
  class AsyncFolderEntitiesClient
103
+ # @return [Vellum::AsyncRequestClient]
37
104
  attr_reader :request_client
38
105
 
39
- # @param request_client [AsyncRequestClient]
40
- # @return [AsyncFolderEntitiesClient]
106
+
107
+ # @param request_client [Vellum::RequestClient]
108
+ # @return [Vellum::AsyncFolderEntitiesClient]
41
109
  def initialize(request_client:)
42
- # @type [AsyncRequestClient]
43
110
  @request_client = request_client
44
111
  end
45
-
46
- # Add an entity to a specific folder or root directory.
112
+ # List all folder entities within a specified folder.
47
113
  #
48
- # Adding an entity to a folder will remove it from any other folders it might have been a member of.
114
+ # @param entity_status [Vellum::FolderEntities::FolderEntitiesListRequestEntityStatus] Filter down to only those objects whose entities have a status matching the
115
+ # status specified.
116
+ # * `ACTIVE` - Active
117
+ # * `ARCHIVED` - Archived
118
+ # @param limit [Integer] Number of results to return per page.
119
+ # @param offset [Integer] The initial index from which to return the results.
120
+ # @param ordering [String] Which field to use when ordering the results.
121
+ # @param parent_folder_id [String] Filter down to only those entities whose parent folder has the specified ID.
122
+ # To filter by an entity's parent folder, provide the ID of the parent folder. To
123
+ # filter by the root directory, provide
124
+ # a string representing the entity type of the root directory. Supported root
125
+ # directories include:
126
+ # - PROMPT_SANDBOX
127
+ # - WORKFLOW_SANDBOX
128
+ # - DOCUMENT_INDEX
129
+ # - TEST_SUITE
130
+ # @param request_options [Vellum::RequestOptions]
131
+ # @return [Vellum::PaginatedFolderEntityList]
132
+ # @example
133
+ # api = Vellum::Client.new(
134
+ # base_url: "https://api.example.com",
135
+ # environment: Vellum::Environment::PRODUCTION,
136
+ # api_key: "YOUR_API_KEY"
137
+ # )
138
+ # api.folder_entities.list(parent_folder_id: "parent_folder_id")
139
+ def list(entity_status: nil, limit: nil, offset: nil, ordering: nil, parent_folder_id:, request_options: nil)
140
+ Async do
141
+ response = @request_client.conn.get do | req |
142
+ unless request_options&.timeout_in_seconds.nil?
143
+ req.options.timeout = request_options.timeout_in_seconds
144
+ end
145
+ unless request_options&.api_key.nil?
146
+ req.headers["X-API-KEY"] = request_options.api_key
147
+ end
148
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
149
+ req.params = { **(request_options&.additional_query_parameters || {}), "entity_status": entity_status, "limit": limit, "offset": offset, "ordering": ordering, "parent_folder_id": parent_folder_id }.compact
150
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
151
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
152
+ end
153
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/folder-entities"
154
+ end
155
+ Vellum::PaginatedFolderEntityList.from_json(json_object: response.body)
156
+ end
157
+ end
158
+ # Add an entity to a specific folder or root directory.
159
+ # Adding an entity to a folder will remove it from any other folders it might have
160
+ # been a member of.
49
161
  #
50
- # @param folder_id [String] The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root directory (e.g. "PROMPT_SANDBOX").
162
+ # @param folder_id [String] The ID of the folder to which the entity should be added. This can be a UUID of
163
+ # a folder, or the name of a root
164
+ # directory. Supported root directories include:
165
+ # - PROMPT_SANDBOX
166
+ # - WORKFLOW_SANDBOX
167
+ # - DOCUMENT_INDEX
168
+ # - TEST_SUITE
51
169
  # @param entity_id [String] The ID of the entity you would like to move.
52
- # @param request_options [RequestOptions]
170
+ # @param request_options [Vellum::RequestOptions]
53
171
  # @return [Void]
172
+ # @example
173
+ # api = Vellum::Client.new(
174
+ # base_url: "https://api.example.com",
175
+ # environment: Vellum::Environment::PRODUCTION,
176
+ # api_key: "YOUR_API_KEY"
177
+ # )
178
+ # api.folder_entities.add_entity_to_folder(folder_id: "folder_id", entity_id: "entity_id")
54
179
  def add_entity_to_folder(folder_id:, entity_id:, request_options: nil)
55
180
  Async do
56
- @request_client.conn.post do |req|
57
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
58
- req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
59
- req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
60
- req.body = { **(request_options&.additional_body_parameters || {}), entity_id: entity_id }.compact
61
- req.url "#{@request_client.default_environment[:Default]}/v1/folders/#{folder_id}/add-entity"
62
- end
181
+ response = @request_client.conn.post do | req |
182
+ unless request_options&.timeout_in_seconds.nil?
183
+ req.options.timeout = request_options.timeout_in_seconds
184
+ end
185
+ unless request_options&.api_key.nil?
186
+ req.headers["X-API-KEY"] = request_options.api_key
187
+ end
188
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
189
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
190
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
191
+ end
192
+ req.body = { **(request_options&.additional_body_parameters || {}), entity_id: entity_id }.compact
193
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/folders/#{folder_id}/add-entity"
194
+ end
63
195
  end
64
196
  end
65
197
  end
66
- end
198
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Vellum
4
+ module FolderEntities
5
+ class FolderEntitiesListRequestEntityStatus
6
+
7
+ ACTIVE = "ACTIVE"
8
+ ARCHIVED = "ARCHIVED"
9
+
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,159 @@
1
+ # frozen_string_literal: true
2
+ require_relative "../../requests"
3
+ require_relative "../types/metric_definition_input"
4
+ require_relative "../types/metric_definition_execution"
5
+ require_relative "../types/metric_definition_history_item"
6
+ require "async"
7
+ require "async"
8
+ require_relative "../../requests"
9
+
10
+ module Vellum
11
+ class MetricDefinitionsClient
12
+ # @return [Vellum::RequestClient]
13
+ attr_reader :request_client
14
+
15
+
16
+ # @param request_client [Vellum::RequestClient]
17
+ # @return [Vellum::MetricDefinitionsClient]
18
+ def initialize(request_client:)
19
+ @request_client = request_client
20
+ end
21
+ # @param id [String] Either the Metric Definition's ID or its unique name
22
+ # @param inputs [Array<Hash>] Request of type Array<Vellum::MetricDefinitionInput>, as a Hash
23
+ # @param release_tag [String]
24
+ # @param request_options [Vellum::RequestOptions]
25
+ # @return [Vellum::MetricDefinitionExecution]
26
+ # @example
27
+ # api = Vellum::Client.new(
28
+ # base_url: "https://api.example.com",
29
+ # environment: Vellum::Environment::PRODUCTION,
30
+ # api_key: "YOUR_API_KEY"
31
+ # )
32
+ # api.metric_definitions.execute_metric_definition(id: "id", inputs: [{ name: "name", type: "STRING", value: "value" }])
33
+ def execute_metric_definition(id:, inputs:, release_tag: nil, request_options: nil)
34
+ response = @request_client.conn.post do | req |
35
+ unless request_options&.timeout_in_seconds.nil?
36
+ req.options.timeout = request_options.timeout_in_seconds
37
+ end
38
+ unless request_options&.api_key.nil?
39
+ req.headers["X-API-KEY"] = request_options.api_key
40
+ end
41
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
42
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
43
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
44
+ end
45
+ req.body = { **(request_options&.additional_body_parameters || {}), inputs: inputs, release_tag: release_tag }.compact
46
+ req.url "#{@request_client.get_url(environment: Predict, request_options: request_options)}/v1/metric-definitions/#{id}/execute"
47
+ end
48
+ Vellum::MetricDefinitionExecution.from_json(json_object: response.body)
49
+ end
50
+ # @param history_id_or_release_tag [String] Either the UUID of Metric Definition History Item you'd like to retrieve, or the
51
+ # name of a Release Tag that's pointing to the Metric Definition History Item
52
+ # you'd like to retrieve.
53
+ # @param id [String] A UUID string identifying this metric definition.
54
+ # @param request_options [Vellum::RequestOptions]
55
+ # @return [Vellum::MetricDefinitionHistoryItem]
56
+ # @example
57
+ # api = Vellum::Client.new(
58
+ # base_url: "https://api.example.com",
59
+ # environment: Vellum::Environment::PRODUCTION,
60
+ # api_key: "YOUR_API_KEY"
61
+ # )
62
+ # api.metric_definitions.metric_definition_history_item_retrieve(history_id_or_release_tag: "history_id_or_release_tag", id: "id")
63
+ def metric_definition_history_item_retrieve(history_id_or_release_tag:, id:, request_options: nil)
64
+ response = @request_client.conn.get do | req |
65
+ unless request_options&.timeout_in_seconds.nil?
66
+ req.options.timeout = request_options.timeout_in_seconds
67
+ end
68
+ unless request_options&.api_key.nil?
69
+ req.headers["X-API-KEY"] = request_options.api_key
70
+ end
71
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
72
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
73
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
74
+ end
75
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
76
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
77
+ end
78
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/metric-definitions/#{history_id_or_release_tag}/history/#{id}"
79
+ end
80
+ Vellum::MetricDefinitionHistoryItem.from_json(json_object: response.body)
81
+ end
82
+ end
83
+ class AsyncMetricDefinitionsClient
84
+ # @return [Vellum::AsyncRequestClient]
85
+ attr_reader :request_client
86
+
87
+
88
+ # @param request_client [Vellum::RequestClient]
89
+ # @return [Vellum::AsyncMetricDefinitionsClient]
90
+ def initialize(request_client:)
91
+ @request_client = request_client
92
+ end
93
+ # @param id [String] Either the Metric Definition's ID or its unique name
94
+ # @param inputs [Array<Hash>] Request of type Array<Vellum::MetricDefinitionInput>, as a Hash
95
+ # @param release_tag [String]
96
+ # @param request_options [Vellum::RequestOptions]
97
+ # @return [Vellum::MetricDefinitionExecution]
98
+ # @example
99
+ # api = Vellum::Client.new(
100
+ # base_url: "https://api.example.com",
101
+ # environment: Vellum::Environment::PRODUCTION,
102
+ # api_key: "YOUR_API_KEY"
103
+ # )
104
+ # api.metric_definitions.execute_metric_definition(id: "id", inputs: [{ name: "name", type: "STRING", value: "value" }])
105
+ def execute_metric_definition(id:, inputs:, release_tag: nil, request_options: nil)
106
+ Async do
107
+ response = @request_client.conn.post do | req |
108
+ unless request_options&.timeout_in_seconds.nil?
109
+ req.options.timeout = request_options.timeout_in_seconds
110
+ end
111
+ unless request_options&.api_key.nil?
112
+ req.headers["X-API-KEY"] = request_options.api_key
113
+ end
114
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
115
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
116
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
117
+ end
118
+ req.body = { **(request_options&.additional_body_parameters || {}), inputs: inputs, release_tag: release_tag }.compact
119
+ req.url "#{@request_client.get_url(environment: Predict, request_options: request_options)}/v1/metric-definitions/#{id}/execute"
120
+ end
121
+ Vellum::MetricDefinitionExecution.from_json(json_object: response.body)
122
+ end
123
+ end
124
+ # @param history_id_or_release_tag [String] Either the UUID of Metric Definition History Item you'd like to retrieve, or the
125
+ # name of a Release Tag that's pointing to the Metric Definition History Item
126
+ # you'd like to retrieve.
127
+ # @param id [String] A UUID string identifying this metric definition.
128
+ # @param request_options [Vellum::RequestOptions]
129
+ # @return [Vellum::MetricDefinitionHistoryItem]
130
+ # @example
131
+ # api = Vellum::Client.new(
132
+ # base_url: "https://api.example.com",
133
+ # environment: Vellum::Environment::PRODUCTION,
134
+ # api_key: "YOUR_API_KEY"
135
+ # )
136
+ # api.metric_definitions.metric_definition_history_item_retrieve(history_id_or_release_tag: "history_id_or_release_tag", id: "id")
137
+ def metric_definition_history_item_retrieve(history_id_or_release_tag:, id:, request_options: nil)
138
+ Async do
139
+ response = @request_client.conn.get do | req |
140
+ unless request_options&.timeout_in_seconds.nil?
141
+ req.options.timeout = request_options.timeout_in_seconds
142
+ end
143
+ unless request_options&.api_key.nil?
144
+ req.headers["X-API-KEY"] = request_options.api_key
145
+ end
146
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
147
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
148
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
149
+ end
150
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
151
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
152
+ end
153
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/metric-definitions/#{history_id_or_release_tag}/history/#{id}"
154
+ end
155
+ Vellum::MetricDefinitionHistoryItem.from_json(json_object: response.body)
156
+ end
157
+ end
158
+ end
159
+ end
@@ -0,0 +1,94 @@
1
+ # frozen_string_literal: true
2
+ require_relative "../../requests"
3
+ require_relative "../types/ml_model_read"
4
+ require "async"
5
+ require_relative "../../requests"
6
+
7
+ module Vellum
8
+ class MlModelsClient
9
+ # @return [Vellum::RequestClient]
10
+ attr_reader :request_client
11
+
12
+
13
+ # @param request_client [Vellum::RequestClient]
14
+ # @return [Vellum::MlModelsClient]
15
+ def initialize(request_client:)
16
+ @request_client = request_client
17
+ end
18
+ # Retrieve details about an ML Model
19
+ #
20
+ # @param id [String] Either the ML Model's ID, its unique name, or its ID in the workspace.
21
+ # @param request_options [Vellum::RequestOptions]
22
+ # @return [Vellum::MlModelRead]
23
+ # @example
24
+ # api = Vellum::Client.new(
25
+ # base_url: "https://api.example.com",
26
+ # environment: Vellum::Environment::PRODUCTION,
27
+ # api_key: "YOUR_API_KEY"
28
+ # )
29
+ # api.ml_models.retrieve(id: "id")
30
+ def retrieve(id:, request_options: nil)
31
+ response = @request_client.conn.get do | req |
32
+ unless request_options&.timeout_in_seconds.nil?
33
+ req.options.timeout = request_options.timeout_in_seconds
34
+ end
35
+ unless request_options&.api_key.nil?
36
+ req.headers["X-API-KEY"] = request_options.api_key
37
+ end
38
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
39
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
40
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
41
+ end
42
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
43
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
44
+ end
45
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/ml-models/#{id}"
46
+ end
47
+ Vellum::MlModelRead.from_json(json_object: response.body)
48
+ end
49
+ end
50
+ class AsyncMlModelsClient
51
+ # @return [Vellum::AsyncRequestClient]
52
+ attr_reader :request_client
53
+
54
+
55
+ # @param request_client [Vellum::RequestClient]
56
+ # @return [Vellum::AsyncMlModelsClient]
57
+ def initialize(request_client:)
58
+ @request_client = request_client
59
+ end
60
+ # Retrieve details about an ML Model
61
+ #
62
+ # @param id [String] Either the ML Model's ID, its unique name, or its ID in the workspace.
63
+ # @param request_options [Vellum::RequestOptions]
64
+ # @return [Vellum::MlModelRead]
65
+ # @example
66
+ # api = Vellum::Client.new(
67
+ # base_url: "https://api.example.com",
68
+ # environment: Vellum::Environment::PRODUCTION,
69
+ # api_key: "YOUR_API_KEY"
70
+ # )
71
+ # api.ml_models.retrieve(id: "id")
72
+ def retrieve(id:, request_options: nil)
73
+ Async do
74
+ response = @request_client.conn.get do | req |
75
+ unless request_options&.timeout_in_seconds.nil?
76
+ req.options.timeout = request_options.timeout_in_seconds
77
+ end
78
+ unless request_options&.api_key.nil?
79
+ req.headers["X-API-KEY"] = request_options.api_key
80
+ end
81
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
82
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
83
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
84
+ end
85
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
86
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
87
+ end
88
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/ml-models/#{id}"
89
+ end
90
+ Vellum::MlModelRead.from_json(json_object: response.body)
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,92 @@
1
+ # frozen_string_literal: true
2
+ require_relative "../../requests"
3
+ require_relative "../types/organization_read"
4
+ require "async"
5
+ require_relative "../../requests"
6
+
7
+ module Vellum
8
+ class OrganizationsClient
9
+ # @return [Vellum::RequestClient]
10
+ attr_reader :request_client
11
+
12
+
13
+ # @param request_client [Vellum::RequestClient]
14
+ # @return [Vellum::OrganizationsClient]
15
+ def initialize(request_client:)
16
+ @request_client = request_client
17
+ end
18
+ # Retrieves information about the active Organization
19
+ #
20
+ # @param request_options [Vellum::RequestOptions]
21
+ # @return [Vellum::OrganizationRead]
22
+ # @example
23
+ # api = Vellum::Client.new(
24
+ # base_url: "https://api.example.com",
25
+ # environment: Vellum::Environment::PRODUCTION,
26
+ # api_key: "YOUR_API_KEY"
27
+ # )
28
+ # api.organizations.organization_identity
29
+ def organization_identity(request_options: nil)
30
+ response = @request_client.conn.get do | req |
31
+ unless request_options&.timeout_in_seconds.nil?
32
+ req.options.timeout = request_options.timeout_in_seconds
33
+ end
34
+ unless request_options&.api_key.nil?
35
+ req.headers["X-API-KEY"] = request_options.api_key
36
+ end
37
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
38
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
39
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
40
+ end
41
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
42
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
43
+ end
44
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/organizations/identity"
45
+ end
46
+ Vellum::OrganizationRead.from_json(json_object: response.body)
47
+ end
48
+ end
49
+ class AsyncOrganizationsClient
50
+ # @return [Vellum::AsyncRequestClient]
51
+ attr_reader :request_client
52
+
53
+
54
+ # @param request_client [Vellum::RequestClient]
55
+ # @return [Vellum::AsyncOrganizationsClient]
56
+ def initialize(request_client:)
57
+ @request_client = request_client
58
+ end
59
+ # Retrieves information about the active Organization
60
+ #
61
+ # @param request_options [Vellum::RequestOptions]
62
+ # @return [Vellum::OrganizationRead]
63
+ # @example
64
+ # api = Vellum::Client.new(
65
+ # base_url: "https://api.example.com",
66
+ # environment: Vellum::Environment::PRODUCTION,
67
+ # api_key: "YOUR_API_KEY"
68
+ # )
69
+ # api.organizations.organization_identity
70
+ def organization_identity(request_options: nil)
71
+ Async do
72
+ response = @request_client.conn.get do | req |
73
+ unless request_options&.timeout_in_seconds.nil?
74
+ req.options.timeout = request_options.timeout_in_seconds
75
+ end
76
+ unless request_options&.api_key.nil?
77
+ req.headers["X-API-KEY"] = request_options.api_key
78
+ end
79
+ req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
80
+ unless request_options.nil? || request_options&.additional_query_parameters.nil?
81
+ req.params = { **(request_options&.additional_query_parameters || {}) }.compact
82
+ end
83
+ unless request_options.nil? || request_options&.additional_body_parameters.nil?
84
+ req.body = { **(request_options&.additional_body_parameters || {}) }.compact
85
+ end
86
+ req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/organizations/identity"
87
+ end
88
+ Vellum::OrganizationRead.from_json(json_object: response.body)
89
+ end
90
+ end
91
+ end
92
+ end