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