vellum-ai 0.14.63__py3-none-any.whl → 1.11.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of vellum-ai might be problematic. Click here for more details.
- vellum/__init__.py +269 -4
- vellum/client/README.md +68 -15
- vellum/client/__init__.py +598 -1437
- vellum/client/core/__init__.py +5 -0
- vellum/client/core/api_error.py +13 -5
- vellum/client/core/client_wrapper.py +30 -4
- vellum/client/core/force_multipart.py +16 -0
- vellum/client/core/http_client.py +70 -26
- vellum/client/core/http_response.py +55 -0
- vellum/client/core/jsonable_encoder.py +0 -1
- vellum/client/core/pydantic_utilities.py +87 -117
- vellum/client/core/serialization.py +7 -3
- vellum/client/errors/__init__.py +14 -1
- vellum/client/errors/bad_request_error.py +4 -3
- vellum/client/errors/forbidden_error.py +4 -3
- vellum/client/errors/internal_server_error.py +4 -3
- vellum/client/errors/misdirected_request_error.py +11 -0
- vellum/client/errors/not_found_error.py +4 -3
- vellum/client/errors/too_many_requests_error.py +11 -0
- vellum/client/errors/unauthorized_error.py +11 -0
- vellum/client/raw_client.py +2725 -0
- vellum/client/reference.md +1980 -638
- vellum/client/resources/__init__.py +16 -2
- vellum/client/resources/ad_hoc/__init__.py +2 -0
- vellum/client/resources/ad_hoc/client.py +173 -377
- vellum/client/resources/ad_hoc/raw_client.py +569 -0
- vellum/client/resources/container_images/__init__.py +2 -0
- vellum/client/resources/container_images/client.py +72 -191
- vellum/client/resources/container_images/raw_client.py +407 -0
- vellum/client/resources/deployments/__init__.py +2 -0
- vellum/client/resources/deployments/client.py +119 -463
- vellum/client/resources/deployments/raw_client.py +1002 -0
- vellum/client/resources/deployments/types/__init__.py +2 -0
- vellum/client/resources/document_indexes/__init__.py +2 -0
- vellum/client/resources/document_indexes/client.py +131 -383
- vellum/client/resources/document_indexes/raw_client.py +866 -0
- vellum/client/resources/document_indexes/types/__init__.py +2 -0
- vellum/client/resources/documents/__init__.py +2 -0
- vellum/client/resources/documents/client.py +93 -325
- vellum/client/resources/documents/raw_client.py +662 -0
- vellum/client/resources/{release_reviews → environments}/__init__.py +2 -0
- vellum/client/resources/environments/client.py +106 -0
- vellum/client/resources/environments/raw_client.py +95 -0
- vellum/client/resources/events/__init__.py +4 -0
- vellum/client/resources/events/client.py +201 -0
- vellum/client/resources/events/raw_client.py +211 -0
- vellum/client/resources/folder_entities/__init__.py +2 -0
- vellum/client/resources/folder_entities/client.py +56 -95
- vellum/client/resources/folder_entities/raw_client.py +276 -0
- vellum/client/resources/folder_entities/types/__init__.py +2 -0
- vellum/client/resources/integration_auth_configs/__init__.py +4 -0
- vellum/client/resources/integration_auth_configs/client.py +186 -0
- vellum/client/resources/integration_auth_configs/raw_client.py +171 -0
- vellum/client/resources/integration_providers/__init__.py +4 -0
- vellum/client/resources/integration_providers/client.py +299 -0
- vellum/client/resources/integration_providers/raw_client.py +275 -0
- vellum/client/resources/integrations/__init__.py +4 -0
- vellum/client/resources/integrations/client.py +466 -0
- vellum/client/resources/integrations/raw_client.py +557 -0
- vellum/client/resources/metric_definitions/__init__.py +2 -0
- vellum/client/resources/metric_definitions/client.py +60 -106
- vellum/client/resources/metric_definitions/raw_client.py +224 -0
- vellum/client/resources/ml_models/__init__.py +2 -0
- vellum/client/resources/ml_models/client.py +37 -46
- vellum/client/resources/ml_models/raw_client.py +102 -0
- vellum/client/resources/organizations/__init__.py +2 -0
- vellum/client/resources/organizations/client.py +37 -45
- vellum/client/resources/organizations/raw_client.py +95 -0
- vellum/client/resources/prompts/__init__.py +2 -0
- vellum/client/resources/prompts/client.py +84 -202
- vellum/client/resources/prompts/raw_client.py +353 -0
- vellum/client/resources/sandboxes/__init__.py +2 -0
- vellum/client/resources/sandboxes/client.py +69 -159
- vellum/client/resources/sandboxes/raw_client.py +392 -0
- vellum/client/resources/test_suite_runs/__init__.py +2 -0
- vellum/client/resources/test_suite_runs/client.py +65 -157
- vellum/client/resources/test_suite_runs/raw_client.py +354 -0
- vellum/client/resources/test_suites/__init__.py +2 -0
- vellum/client/resources/test_suites/client.py +162 -266
- vellum/client/resources/test_suites/raw_client.py +530 -0
- vellum/client/resources/uploaded_files/__init__.py +4 -0
- vellum/client/resources/uploaded_files/client.py +230 -0
- vellum/client/resources/uploaded_files/raw_client.py +316 -0
- vellum/client/resources/workflow_deployments/__init__.py +2 -0
- vellum/client/resources/workflow_deployments/client.py +302 -353
- vellum/client/resources/workflow_deployments/raw_client.py +1059 -0
- vellum/client/resources/workflow_deployments/types/__init__.py +2 -0
- vellum/client/resources/workflow_executions/__init__.py +4 -0
- vellum/client/resources/workflow_executions/client.py +140 -0
- vellum/client/resources/workflow_executions/raw_client.py +173 -0
- vellum/client/resources/workflow_sandboxes/__init__.py +2 -0
- vellum/client/resources/workflow_sandboxes/client.py +58 -123
- vellum/client/resources/workflow_sandboxes/raw_client.py +291 -0
- vellum/client/resources/workflow_sandboxes/types/__init__.py +2 -0
- vellum/client/resources/workflows/__init__.py +2 -0
- vellum/client/resources/workflows/client.py +256 -141
- vellum/client/resources/workflows/raw_client.py +547 -0
- vellum/client/resources/workspace_secrets/__init__.py +2 -0
- vellum/client/resources/workspace_secrets/client.py +43 -100
- vellum/client/resources/workspace_secrets/raw_client.py +219 -0
- vellum/client/resources/workspaces/__init__.py +2 -0
- vellum/client/resources/workspaces/client.py +37 -45
- vellum/client/resources/workspaces/raw_client.py +95 -0
- vellum/client/tests/__init__.py +0 -0
- vellum/client/tests/test_utils.py +34 -0
- vellum/client/types/__init__.py +242 -0
- vellum/client/types/ad_hoc_execute_prompt_event.py +3 -2
- vellum/client/types/ad_hoc_expand_meta.py +2 -2
- vellum/client/types/ad_hoc_fulfilled_prompt_execution_meta.py +3 -3
- vellum/client/types/ad_hoc_initiated_prompt_execution_meta.py +2 -2
- vellum/client/types/ad_hoc_rejected_prompt_execution_meta.py +3 -3
- vellum/client/types/ad_hoc_streaming_prompt_execution_meta.py +2 -2
- vellum/client/types/api_actor_type_enum.py +7 -0
- vellum/client/types/api_node_result.py +3 -3
- vellum/client/types/api_node_result_data.py +4 -4
- vellum/client/types/api_request_parent_context.py +17 -10
- vellum/client/types/api_version_enum.py +1 -1
- vellum/client/types/array_chat_message_content.py +3 -3
- vellum/client/types/array_chat_message_content_item.py +7 -4
- vellum/client/types/array_chat_message_content_item_request.py +7 -4
- vellum/client/types/array_chat_message_content_request.py +3 -3
- vellum/client/types/array_input.py +12 -6
- vellum/client/types/array_vellum_value.py +4 -4
- vellum/client/types/array_vellum_value_request.py +4 -4
- vellum/client/types/audio_chat_message_content.py +3 -3
- vellum/client/types/audio_chat_message_content_request.py +3 -3
- vellum/client/types/audio_input.py +30 -0
- vellum/client/types/audio_input_request.py +30 -0
- vellum/client/types/audio_prompt_block.py +4 -4
- vellum/client/types/audio_vellum_value.py +3 -3
- vellum/client/types/audio_vellum_value_request.py +3 -3
- vellum/client/types/auth_type_enum.py +5 -0
- vellum/client/types/base_output.py +4 -4
- vellum/client/types/basic_vectorizer_intfloat_multilingual_e_5_large.py +2 -2
- vellum/client/types/basic_vectorizer_intfloat_multilingual_e_5_large_request.py +2 -2
- vellum/client/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_cos_v_1.py +2 -2
- vellum/client/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_cos_v_1_request.py +2 -2
- vellum/client/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_dot_v_1.py +2 -2
- vellum/client/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_dot_v_1_request.py +2 -2
- vellum/client/types/build_status_enum.py +5 -0
- vellum/client/types/chat_history_input.py +3 -3
- vellum/client/types/chat_history_input_request.py +3 -3
- vellum/client/types/chat_history_vellum_value.py +3 -3
- vellum/client/types/chat_history_vellum_value_request.py +3 -3
- vellum/client/types/chat_message.py +4 -4
- vellum/client/types/chat_message_content.py +7 -4
- vellum/client/types/chat_message_content_request.py +7 -4
- vellum/client/types/chat_message_prompt_block.py +7 -7
- vellum/client/types/chat_message_request.py +4 -4
- vellum/client/types/code_execution_node_array_result.py +11 -5
- vellum/client/types/code_execution_node_chat_history_result.py +3 -3
- vellum/client/types/code_execution_node_error_result.py +3 -3
- vellum/client/types/code_execution_node_function_call_result.py +3 -3
- vellum/client/types/code_execution_node_json_result.py +2 -2
- vellum/client/types/code_execution_node_number_result.py +2 -2
- vellum/client/types/code_execution_node_result.py +10 -4
- vellum/client/types/code_execution_node_result_data.py +10 -4
- vellum/client/types/code_execution_node_result_output.py +6 -5
- vellum/client/types/code_execution_node_search_results_result.py +3 -3
- vellum/client/types/code_execution_node_string_result.py +2 -2
- vellum/client/types/code_execution_package.py +3 -2
- vellum/client/types/code_executor_input.py +15 -6
- vellum/client/types/code_executor_response.py +11 -5
- vellum/client/types/code_executor_secret_input.py +3 -3
- vellum/client/types/code_resource_definition.py +3 -3
- vellum/client/types/compile_prompt_deployment_expand_meta_request.py +2 -2
- vellum/client/types/compile_prompt_meta.py +2 -2
- vellum/client/types/components_schemas_composio_execute_tool_request.py +5 -0
- vellum/client/types/components_schemas_composio_execute_tool_response.py +5 -0
- vellum/client/types/components_schemas_composio_integration_exec_config.py +5 -0
- vellum/client/types/components_schemas_composio_tool_definition.py +5 -0
- vellum/client/types/components_schemas_slim_composio_tool_definition.py +5 -0
- vellum/client/types/composio_execute_tool_request.py +24 -0
- vellum/client/types/composio_execute_tool_response.py +24 -0
- vellum/client/types/composio_integration_exec_config.py +21 -0
- vellum/client/types/composio_tool_definition.py +30 -0
- vellum/client/types/conditional_node_result.py +3 -3
- vellum/client/types/conditional_node_result_data.py +2 -2
- vellum/client/types/container_image_build_config.py +21 -0
- vellum/client/types/container_image_container_image_tag.py +2 -2
- vellum/client/types/container_image_read.py +8 -4
- vellum/client/types/create_test_suite_test_case_request.py +9 -3
- vellum/client/types/create_workflow_event_request.py +7 -0
- vellum/client/types/dataset_row_push_request.py +20 -0
- vellum/client/types/delimiter_chunker_config.py +20 -0
- vellum/client/types/delimiter_chunker_config_request.py +20 -0
- vellum/client/types/delimiter_chunking.py +21 -0
- vellum/client/types/delimiter_chunking_request.py +21 -0
- vellum/client/types/deployment_history_item.py +10 -4
- vellum/client/types/deployment_provider_payload_response.py +4 -4
- vellum/client/types/deployment_read.py +15 -9
- vellum/client/types/deployment_release_tag_deployment_history_item.py +2 -2
- vellum/client/types/deployment_release_tag_read.py +4 -4
- vellum/client/types/deprecated_prompt_request_input.py +8 -0
- vellum/client/types/docker_service_token.py +2 -2
- vellum/client/types/document_chat_message_content.py +3 -3
- vellum/client/types/document_chat_message_content_request.py +3 -3
- vellum/client/types/document_document_to_document_index.py +4 -4
- vellum/client/types/document_index_chunking.py +5 -1
- vellum/client/types/document_index_chunking_request.py +3 -1
- vellum/client/types/document_index_indexing_config.py +4 -4
- vellum/client/types/document_index_indexing_config_request.py +4 -4
- vellum/client/types/document_index_read.py +4 -4
- vellum/client/types/document_input.py +30 -0
- vellum/client/types/document_input_request.py +30 -0
- vellum/client/types/document_prompt_block.py +4 -4
- vellum/client/types/document_read.py +9 -5
- vellum/client/types/document_vellum_value.py +3 -3
- vellum/client/types/document_vellum_value_request.py +3 -3
- vellum/client/types/enriched_normalized_completion.py +3 -3
- vellum/client/types/environment_display_config.py +19 -0
- vellum/client/types/environment_read.py +23 -0
- vellum/client/types/ephemeral_prompt_cache_config.py +3 -3
- vellum/client/types/error_detail_response.py +22 -0
- vellum/client/types/error_input.py +3 -3
- vellum/client/types/error_vellum_value.py +3 -3
- vellum/client/types/error_vellum_value_request.py +3 -3
- vellum/client/types/event_create_response.py +31 -0
- vellum/client/types/execute_api_request_bearer_token.py +1 -0
- vellum/client/types/execute_api_request_headers_value.py +1 -0
- vellum/client/types/execute_api_response.py +6 -6
- vellum/client/types/execute_prompt_event.py +3 -2
- vellum/client/types/execute_prompt_response.py +1 -0
- vellum/client/types/execute_workflow_async_response.py +26 -0
- vellum/client/types/execute_workflow_response.py +10 -4
- vellum/client/types/execute_workflow_workflow_result_event.py +1 -0
- vellum/client/types/execution_array_vellum_value.py +12 -6
- vellum/client/types/execution_audio_vellum_value.py +31 -0
- vellum/client/types/execution_chat_history_vellum_value.py +3 -3
- vellum/client/types/execution_document_vellum_value.py +31 -0
- vellum/client/types/execution_error_vellum_value.py +3 -3
- vellum/client/types/execution_function_call_vellum_value.py +3 -3
- vellum/client/types/execution_image_vellum_value.py +31 -0
- vellum/client/types/execution_json_vellum_value.py +3 -3
- vellum/client/types/execution_number_vellum_value.py +3 -3
- vellum/client/types/execution_search_results_vellum_value.py +3 -3
- vellum/client/types/execution_string_vellum_value.py +3 -3
- vellum/client/types/execution_thinking_vellum_value.py +31 -0
- vellum/client/types/execution_vellum_value.py +16 -5
- vellum/client/types/execution_video_vellum_value.py +31 -0
- vellum/client/types/external_input_descriptor.py +3 -3
- vellum/client/types/external_parent_context.py +38 -0
- vellum/client/types/external_test_case_execution.py +10 -4
- vellum/client/types/external_test_case_execution_request.py +10 -4
- vellum/client/types/fast_embed_vectorizer_baai_bge_small_en_v_15.py +23 -0
- vellum/client/types/fast_embed_vectorizer_baai_bge_small_en_v_15_request.py +23 -0
- vellum/client/types/folder_entity.py +5 -2
- vellum/client/types/folder_entity_dataset.py +26 -0
- vellum/client/types/folder_entity_dataset_data.py +25 -0
- vellum/client/types/folder_entity_document_index.py +3 -3
- vellum/client/types/folder_entity_document_index_data.py +5 -3
- vellum/client/types/folder_entity_folder.py +3 -3
- vellum/client/types/folder_entity_folder_data.py +2 -2
- vellum/client/types/folder_entity_prompt_sandbox.py +3 -3
- vellum/client/types/folder_entity_prompt_sandbox_data.py +4 -3
- vellum/client/types/folder_entity_test_suite.py +3 -3
- vellum/client/types/folder_entity_test_suite_data.py +3 -3
- vellum/client/types/folder_entity_workflow_sandbox.py +3 -3
- vellum/client/types/folder_entity_workflow_sandbox_data.py +6 -3
- vellum/client/types/fulfilled_ad_hoc_execute_prompt_event.py +4 -4
- vellum/client/types/fulfilled_execute_prompt_event.py +4 -4
- vellum/client/types/fulfilled_execute_prompt_response.py +3 -3
- vellum/client/types/fulfilled_execute_workflow_workflow_result_event.py +11 -5
- vellum/client/types/fulfilled_prompt_execution_meta.py +3 -3
- vellum/client/types/fulfilled_workflow_node_result_event.py +12 -6
- vellum/client/types/function_call.py +2 -2
- vellum/client/types/function_call_chat_message_content.py +3 -3
- vellum/client/types/function_call_chat_message_content_request.py +3 -3
- vellum/client/types/function_call_chat_message_content_value.py +2 -2
- vellum/client/types/function_call_chat_message_content_value_request.py +2 -2
- vellum/client/types/function_call_input.py +3 -3
- vellum/client/types/function_call_prompt_block.py +4 -4
- vellum/client/types/function_call_request.py +2 -2
- vellum/client/types/function_call_vellum_value.py +3 -3
- vellum/client/types/function_call_vellum_value_request.py +3 -3
- vellum/client/types/function_definition.py +9 -4
- vellum/client/types/generate_options_request.py +3 -3
- vellum/client/types/generate_request.py +2 -2
- vellum/client/types/generate_response.py +3 -3
- vellum/client/types/generate_result.py +3 -3
- vellum/client/types/generate_result_data.py +3 -3
- vellum/client/types/generate_result_error.py +3 -3
- vellum/client/types/generate_stream_response.py +3 -3
- vellum/client/types/generate_stream_result.py +4 -4
- vellum/client/types/generate_stream_result_data.py +3 -3
- vellum/client/types/google_vertex_ai_vectorizer_config.py +2 -2
- vellum/client/types/google_vertex_ai_vectorizer_config_request.py +2 -2
- vellum/client/types/google_vertex_ai_vectorizer_gemini_embedding_001.py +21 -0
- vellum/client/types/google_vertex_ai_vectorizer_gemini_embedding_001_request.py +21 -0
- vellum/client/types/google_vertex_ai_vectorizer_text_embedding_004.py +3 -3
- vellum/client/types/google_vertex_ai_vectorizer_text_embedding_004_request.py +3 -3
- vellum/client/types/google_vertex_ai_vectorizer_text_multilingual_embedding_002.py +3 -3
- vellum/client/types/google_vertex_ai_vectorizer_text_multilingual_embedding_002_request.py +3 -3
- vellum/client/types/hkunlp_instructor_xl_vectorizer.py +3 -3
- vellum/client/types/hkunlp_instructor_xl_vectorizer_request.py +3 -3
- vellum/client/types/image_chat_message_content.py +3 -3
- vellum/client/types/image_chat_message_content_request.py +3 -3
- vellum/client/types/image_input.py +30 -0
- vellum/client/types/image_input_request.py +30 -0
- vellum/client/types/image_prompt_block.py +4 -4
- vellum/client/types/image_vellum_value.py +3 -3
- vellum/client/types/image_vellum_value_request.py +3 -3
- vellum/client/types/indexing_config_vectorizer.py +11 -4
- vellum/client/types/indexing_config_vectorizer_request.py +11 -4
- vellum/client/types/initiated_ad_hoc_execute_prompt_event.py +3 -3
- vellum/client/types/initiated_execute_prompt_event.py +3 -3
- vellum/client/types/initiated_prompt_execution_meta.py +2 -2
- vellum/client/types/initiated_workflow_node_result_event.py +12 -6
- vellum/client/types/instructor_vectorizer_config.py +2 -2
- vellum/client/types/instructor_vectorizer_config_request.py +2 -2
- vellum/client/types/integration.py +27 -0
- vellum/client/types/integration_auth_config_integration.py +23 -0
- vellum/client/types/integration_auth_config_integration_credential.py +19 -0
- vellum/client/types/integration_credential_access_type.py +5 -0
- vellum/client/types/integration_name.py +85 -0
- vellum/client/types/integration_provider.py +5 -0
- vellum/client/types/integration_read.py +30 -0
- vellum/client/types/integration_trigger_context.py +39 -0
- vellum/client/types/invoked_port.py +2 -2
- vellum/client/types/jinja_prompt_block.py +4 -4
- vellum/client/types/json_input.py +3 -3
- vellum/client/types/json_input_request.py +3 -3
- vellum/client/types/json_vellum_value.py +2 -2
- vellum/client/types/json_vellum_value_request.py +2 -2
- vellum/client/types/logical_operator.py +4 -0
- vellum/client/types/map_node_result.py +3 -3
- vellum/client/types/map_node_result_data.py +3 -3
- vellum/client/types/merge_node_result.py +3 -3
- vellum/client/types/merge_node_result_data.py +2 -2
- vellum/client/types/metadata_filter_config_request.py +12 -6
- vellum/client/types/metadata_filter_rule_request.py +5 -5
- vellum/client/types/metadata_filters_request.py +1 -0
- vellum/client/types/metric_definition_execution.py +10 -4
- vellum/client/types/metric_definition_history_item.py +10 -4
- vellum/client/types/metric_definition_input.py +3 -2
- vellum/client/types/metric_node_result.py +2 -2
- vellum/client/types/ml_model_read.py +6 -3
- vellum/client/types/ml_model_usage.py +2 -2
- vellum/client/types/ml_model_usage_wrapper.py +3 -3
- vellum/client/types/named_scenario_input_audio_variable_value_request.py +22 -0
- vellum/client/types/named_scenario_input_chat_history_variable_value_request.py +3 -3
- vellum/client/types/named_scenario_input_document_variable_value_request.py +22 -0
- vellum/client/types/named_scenario_input_image_variable_value_request.py +22 -0
- vellum/client/types/named_scenario_input_json_variable_value_request.py +2 -2
- vellum/client/types/named_scenario_input_request.py +11 -2
- vellum/client/types/named_scenario_input_string_variable_value_request.py +2 -2
- vellum/client/types/named_scenario_input_video_variable_value_request.py +22 -0
- vellum/client/types/named_test_case_array_variable_value.py +11 -5
- vellum/client/types/named_test_case_array_variable_value_request.py +11 -5
- vellum/client/types/named_test_case_audio_variable_value.py +26 -0
- vellum/client/types/named_test_case_audio_variable_value_request.py +26 -0
- vellum/client/types/named_test_case_chat_history_variable_value.py +3 -3
- vellum/client/types/named_test_case_chat_history_variable_value_request.py +3 -3
- vellum/client/types/named_test_case_document_variable_value.py +22 -0
- vellum/client/types/named_test_case_document_variable_value_request.py +22 -0
- vellum/client/types/named_test_case_error_variable_value.py +3 -3
- vellum/client/types/named_test_case_error_variable_value_request.py +3 -3
- vellum/client/types/named_test_case_function_call_variable_value.py +3 -3
- vellum/client/types/named_test_case_function_call_variable_value_request.py +3 -3
- vellum/client/types/named_test_case_image_variable_value.py +22 -0
- vellum/client/types/named_test_case_image_variable_value_request.py +22 -0
- vellum/client/types/named_test_case_json_variable_value.py +2 -2
- vellum/client/types/named_test_case_json_variable_value_request.py +2 -2
- vellum/client/types/named_test_case_number_variable_value.py +2 -2
- vellum/client/types/named_test_case_number_variable_value_request.py +2 -2
- vellum/client/types/named_test_case_search_results_variable_value.py +3 -3
- vellum/client/types/named_test_case_search_results_variable_value_request.py +3 -3
- vellum/client/types/named_test_case_string_variable_value.py +2 -2
- vellum/client/types/named_test_case_string_variable_value_request.py +2 -2
- vellum/client/types/named_test_case_variable_value.py +14 -5
- vellum/client/types/named_test_case_variable_value_request.py +14 -5
- vellum/client/types/named_test_case_video_variable_value.py +22 -0
- vellum/client/types/named_test_case_video_variable_value_request.py +22 -0
- vellum/client/types/node_execution_fulfilled_body.py +4 -4
- vellum/client/types/node_execution_fulfilled_event.py +24 -15
- vellum/client/types/node_execution_initiated_body.py +3 -3
- vellum/client/types/node_execution_initiated_event.py +24 -15
- vellum/client/types/node_execution_paused_body.py +3 -3
- vellum/client/types/node_execution_paused_event.py +24 -15
- vellum/client/types/node_execution_rejected_body.py +5 -4
- vellum/client/types/node_execution_rejected_event.py +24 -15
- vellum/client/types/node_execution_resumed_body.py +3 -3
- vellum/client/types/node_execution_resumed_event.py +24 -15
- vellum/client/types/node_execution_span.py +23 -12
- vellum/client/types/node_execution_span_attributes.py +4 -2
- vellum/client/types/node_execution_streaming_body.py +4 -4
- vellum/client/types/node_execution_streaming_event.py +24 -15
- vellum/client/types/node_input_compiled_array_value.py +11 -5
- vellum/client/types/node_input_compiled_audio_value.py +23 -0
- vellum/client/types/node_input_compiled_chat_history_value.py +3 -3
- vellum/client/types/node_input_compiled_document_value.py +23 -0
- vellum/client/types/node_input_compiled_error_value.py +3 -3
- vellum/client/types/node_input_compiled_function_call_value.py +3 -3
- vellum/client/types/node_input_compiled_image_value.py +23 -0
- vellum/client/types/node_input_compiled_json_value.py +2 -2
- vellum/client/types/node_input_compiled_number_value.py +2 -2
- vellum/client/types/node_input_compiled_search_results_value.py +3 -3
- vellum/client/types/node_input_compiled_secret_value.py +3 -3
- vellum/client/types/node_input_compiled_string_value.py +2 -2
- vellum/client/types/node_input_compiled_video_value.py +23 -0
- vellum/client/types/node_input_variable_compiled_value.py +14 -5
- vellum/client/types/node_output_compiled_array_value.py +12 -6
- vellum/client/types/node_output_compiled_chat_history_value.py +3 -3
- vellum/client/types/node_output_compiled_error_value.py +3 -3
- vellum/client/types/node_output_compiled_function_call_value.py +3 -3
- vellum/client/types/node_output_compiled_json_value.py +3 -3
- vellum/client/types/node_output_compiled_number_value.py +3 -3
- vellum/client/types/node_output_compiled_search_results_value.py +3 -3
- vellum/client/types/node_output_compiled_string_value.py +3 -3
- vellum/client/types/node_output_compiled_thinking_value.py +28 -0
- vellum/client/types/node_output_compiled_value.py +8 -5
- vellum/client/types/node_parent_context.py +14 -11
- vellum/client/types/normalized_log_probs.py +3 -3
- vellum/client/types/normalized_token_log_probs.py +2 -2
- vellum/client/types/number_input.py +3 -3
- vellum/client/types/number_vellum_value.py +2 -2
- vellum/client/types/number_vellum_value_request.py +2 -2
- vellum/client/types/open_ai_vectorizer_config.py +3 -3
- vellum/client/types/open_ai_vectorizer_config_request.py +3 -3
- vellum/client/types/open_ai_vectorizer_text_embedding_3_large.py +3 -3
- vellum/client/types/open_ai_vectorizer_text_embedding_3_large_request.py +3 -3
- vellum/client/types/open_ai_vectorizer_text_embedding_3_small.py +3 -3
- vellum/client/types/open_ai_vectorizer_text_embedding_3_small_request.py +3 -3
- vellum/client/types/open_ai_vectorizer_text_embedding_ada_002.py +3 -3
- vellum/client/types/open_ai_vectorizer_text_embedding_ada_002_request.py +3 -3
- vellum/client/types/organization_read.py +6 -3
- vellum/client/types/paginated_container_image_read_list.py +3 -3
- vellum/client/types/paginated_deployment_release_tag_read_list.py +3 -3
- vellum/client/types/paginated_document_index_read_list.py +3 -3
- vellum/client/types/paginated_folder_entity_list.py +3 -3
- vellum/client/types/paginated_slim_deployment_read_list.py +10 -4
- vellum/client/types/paginated_slim_document_list.py +3 -3
- vellum/client/types/paginated_slim_integration_auth_config_read_list.py +23 -0
- vellum/client/types/paginated_slim_integration_read_list.py +23 -0
- vellum/client/types/paginated_slim_tool_definition_list.py +23 -0
- vellum/client/types/paginated_slim_workflow_deployment_list.py +10 -4
- vellum/client/types/paginated_test_suite_run_execution_list.py +10 -4
- vellum/client/types/paginated_test_suite_test_case_list.py +10 -4
- vellum/client/types/paginated_workflow_deployment_release_list.py +30 -0
- vellum/client/types/paginated_workflow_release_tag_read_list.py +3 -3
- vellum/client/types/paginated_workflow_sandbox_example_list.py +3 -3
- vellum/client/types/parent_context.py +21 -11
- vellum/client/types/pdf_search_result_meta_source.py +2 -2
- vellum/client/types/pdf_search_result_meta_source_request.py +2 -2
- vellum/client/types/plain_text_prompt_block.py +4 -4
- vellum/client/types/price.py +3 -3
- vellum/client/types/private_vectorizer.py +23 -0
- vellum/client/types/private_vectorizer_request.py +23 -0
- vellum/client/types/processing_failure_reason_enum.py +3 -1
- vellum/client/types/prompt_block.py +9 -6
- vellum/client/types/prompt_deployment_expand_meta_request.py +2 -2
- vellum/client/types/prompt_deployment_input_request.py +16 -3
- vellum/client/types/prompt_deployment_parent_context.py +13 -10
- vellum/client/types/prompt_deployment_release.py +6 -6
- vellum/client/types/prompt_deployment_release_prompt_deployment.py +2 -2
- vellum/client/types/prompt_deployment_release_prompt_version.py +4 -4
- vellum/client/types/prompt_exec_config.py +15 -9
- vellum/client/types/prompt_execution_meta.py +3 -3
- vellum/client/types/prompt_node_execution_meta.py +3 -3
- vellum/client/types/prompt_node_result.py +3 -3
- vellum/client/types/prompt_node_result_data.py +3 -3
- vellum/client/types/prompt_output.py +7 -3
- vellum/client/types/prompt_parameters.py +2 -2
- vellum/client/types/prompt_push_response.py +2 -2
- vellum/client/types/prompt_request_audio_input.py +26 -0
- vellum/client/types/prompt_request_chat_history_input.py +3 -3
- vellum/client/types/prompt_request_document_input.py +26 -0
- vellum/client/types/prompt_request_image_input.py +26 -0
- vellum/client/types/prompt_request_input.py +16 -3
- vellum/client/types/prompt_request_json_input.py +3 -3
- vellum/client/types/prompt_request_string_input.py +3 -3
- vellum/client/types/prompt_request_video_input.py +26 -0
- vellum/client/types/prompt_settings.py +2 -2
- vellum/client/types/prompt_version_build_config_sandbox.py +2 -2
- vellum/client/types/raw_prompt_execution_overrides_request.py +2 -2
- vellum/client/types/reducto_chunker_config.py +2 -2
- vellum/client/types/reducto_chunker_config_request.py +2 -2
- vellum/client/types/reducto_chunking.py +3 -3
- vellum/client/types/reducto_chunking_request.py +3 -3
- vellum/client/types/rejected_ad_hoc_execute_prompt_event.py +4 -4
- vellum/client/types/rejected_execute_prompt_event.py +4 -4
- vellum/client/types/rejected_execute_prompt_response.py +3 -3
- vellum/client/types/rejected_execute_workflow_workflow_result_event.py +4 -4
- vellum/client/types/rejected_prompt_execution_meta.py +3 -3
- vellum/client/types/rejected_workflow_node_result_event.py +12 -6
- vellum/client/types/release_created_by.py +2 -2
- vellum/client/types/release_environment.py +2 -2
- vellum/client/types/release_release_tag.py +3 -3
- vellum/client/types/release_review_reviewer.py +2 -2
- vellum/client/types/release_tag_release.py +2 -2
- vellum/client/types/replace_test_suite_test_case_request.py +9 -3
- vellum/client/types/rich_text_child_block.py +2 -1
- vellum/client/types/rich_text_prompt_block.py +4 -4
- vellum/client/types/sandbox_scenario.py +3 -3
- vellum/client/types/scenario_input.py +14 -3
- vellum/client/types/scenario_input_audio_variable_value.py +22 -0
- vellum/client/types/scenario_input_chat_history_variable_value.py +3 -3
- vellum/client/types/scenario_input_document_variable_value.py +22 -0
- vellum/client/types/scenario_input_image_variable_value.py +22 -0
- vellum/client/types/scenario_input_json_variable_value.py +2 -2
- vellum/client/types/scenario_input_string_variable_value.py +2 -2
- vellum/client/types/scenario_input_video_variable_value.py +22 -0
- vellum/client/types/scheduled_trigger_context.py +39 -0
- vellum/client/types/search_filters_request.py +11 -5
- vellum/client/types/search_node_result.py +3 -3
- vellum/client/types/search_node_result_data.py +3 -3
- vellum/client/types/search_request_options_request.py +13 -7
- vellum/client/types/search_response.py +3 -3
- vellum/client/types/search_result.py +3 -3
- vellum/client/types/search_result_document.py +2 -2
- vellum/client/types/search_result_document_request.py +2 -2
- vellum/client/types/search_result_merging_request.py +2 -2
- vellum/client/types/search_result_meta.py +3 -3
- vellum/client/types/search_result_meta_request.py +3 -3
- vellum/client/types/search_result_request.py +3 -3
- vellum/client/types/search_results_input.py +3 -3
- vellum/client/types/search_results_vellum_value.py +3 -3
- vellum/client/types/search_results_vellum_value_request.py +3 -3
- vellum/client/types/search_weights_request.py +2 -2
- vellum/client/types/secret_type_enum.py +3 -1
- vellum/client/types/sentence_chunker_config.py +2 -2
- vellum/client/types/sentence_chunker_config_request.py +2 -2
- vellum/client/types/sentence_chunking.py +3 -3
- vellum/client/types/sentence_chunking_request.py +3 -3
- vellum/client/types/slim_composio_tool_definition.py +24 -0
- vellum/client/types/slim_deployment_read.py +15 -9
- vellum/client/types/slim_document.py +6 -5
- vellum/client/types/slim_document_document_to_document_index.py +4 -4
- vellum/client/types/slim_integration_auth_config_read.py +36 -0
- vellum/client/types/slim_integration_read.py +25 -0
- vellum/client/types/slim_release_review.py +4 -4
- vellum/client/types/slim_workflow_deployment.py +16 -10
- vellum/client/types/slim_workflow_execution_read.py +24 -15
- vellum/client/types/span_link.py +15 -12
- vellum/client/types/span_link_type_enum.py +1 -1
- vellum/client/types/streaming_ad_hoc_execute_prompt_event.py +4 -4
- vellum/client/types/streaming_execute_prompt_event.py +3 -3
- vellum/client/types/streaming_prompt_execution_meta.py +2 -2
- vellum/client/types/streaming_workflow_node_result_event.py +12 -6
- vellum/client/types/string_chat_message_content.py +2 -2
- vellum/client/types/string_chat_message_content_request.py +2 -2
- vellum/client/types/string_input.py +3 -3
- vellum/client/types/string_input_request.py +3 -3
- vellum/client/types/string_vellum_value.py +2 -2
- vellum/client/types/string_vellum_value_request.py +2 -2
- vellum/client/types/submit_completion_actual_request.py +3 -3
- vellum/client/types/submit_workflow_execution_actual_request.py +3 -2
- vellum/client/types/subworkflow_node_result.py +3 -3
- vellum/client/types/subworkflow_node_result_data.py +2 -2
- vellum/client/types/templating_node_array_result.py +11 -5
- vellum/client/types/templating_node_chat_history_result.py +3 -3
- vellum/client/types/templating_node_error_result.py +3 -3
- vellum/client/types/templating_node_function_call_result.py +3 -3
- vellum/client/types/templating_node_json_result.py +2 -2
- vellum/client/types/templating_node_number_result.py +2 -2
- vellum/client/types/templating_node_result.py +10 -4
- vellum/client/types/templating_node_result_data.py +10 -4
- vellum/client/types/templating_node_result_output.py +6 -5
- vellum/client/types/templating_node_search_results_result.py +3 -3
- vellum/client/types/templating_node_string_result.py +2 -2
- vellum/client/types/terminal_node_array_result.py +11 -5
- vellum/client/types/terminal_node_chat_history_result.py +2 -2
- vellum/client/types/terminal_node_error_result.py +2 -2
- vellum/client/types/terminal_node_function_call_result.py +2 -2
- vellum/client/types/terminal_node_json_result.py +2 -2
- vellum/client/types/terminal_node_number_result.py +2 -2
- vellum/client/types/terminal_node_result.py +10 -4
- vellum/client/types/terminal_node_result_data.py +10 -4
- vellum/client/types/terminal_node_result_output.py +6 -5
- vellum/client/types/terminal_node_search_results_result.py +2 -2
- vellum/client/types/terminal_node_string_result.py +2 -2
- vellum/client/types/test_case_array_variable_value.py +11 -5
- vellum/client/types/test_case_audio_variable_value.py +27 -0
- vellum/client/types/test_case_chat_history_variable_value.py +3 -3
- vellum/client/types/test_case_document_variable_value.py +27 -0
- vellum/client/types/test_case_error_variable_value.py +3 -3
- vellum/client/types/test_case_function_call_variable_value.py +3 -3
- vellum/client/types/test_case_image_variable_value.py +27 -0
- vellum/client/types/test_case_json_variable_value.py +2 -2
- vellum/client/types/test_case_number_variable_value.py +2 -2
- vellum/client/types/test_case_search_results_variable_value.py +3 -3
- vellum/client/types/test_case_string_variable_value.py +2 -2
- vellum/client/types/test_case_variable_value.py +14 -5
- vellum/client/types/test_case_video_variable_value.py +27 -0
- vellum/client/types/test_suite_run_deployment_release_tag_exec_config.py +3 -3
- vellum/client/types/test_suite_run_deployment_release_tag_exec_config_data.py +3 -3
- vellum/client/types/test_suite_run_deployment_release_tag_exec_config_data_request.py +3 -3
- vellum/client/types/test_suite_run_deployment_release_tag_exec_config_request.py +3 -3
- vellum/client/types/test_suite_run_exec_config.py +2 -1
- vellum/client/types/test_suite_run_exec_config_request.py +2 -1
- vellum/client/types/test_suite_run_execution.py +11 -5
- vellum/client/types/test_suite_run_execution_array_output.py +11 -5
- vellum/client/types/test_suite_run_execution_chat_history_output.py +3 -3
- vellum/client/types/test_suite_run_execution_error_output.py +3 -3
- vellum/client/types/test_suite_run_execution_function_call_output.py +3 -3
- vellum/client/types/test_suite_run_execution_json_output.py +2 -2
- vellum/client/types/test_suite_run_execution_metric_definition.py +2 -2
- vellum/client/types/test_suite_run_execution_metric_result.py +11 -5
- vellum/client/types/test_suite_run_execution_number_output.py +2 -2
- vellum/client/types/test_suite_run_execution_output.py +6 -5
- vellum/client/types/test_suite_run_execution_search_results_output.py +3 -3
- vellum/client/types/test_suite_run_execution_string_output.py +2 -2
- vellum/client/types/test_suite_run_external_exec_config.py +10 -4
- vellum/client/types/test_suite_run_external_exec_config_data.py +10 -4
- vellum/client/types/test_suite_run_external_exec_config_data_request.py +10 -4
- vellum/client/types/test_suite_run_external_exec_config_request.py +10 -4
- vellum/client/types/test_suite_run_metric_array_output.py +11 -5
- vellum/client/types/test_suite_run_metric_error_output.py +3 -3
- vellum/client/types/test_suite_run_metric_json_output.py +2 -2
- vellum/client/types/test_suite_run_metric_number_output.py +2 -2
- vellum/client/types/test_suite_run_metric_output.py +5 -4
- vellum/client/types/test_suite_run_metric_string_output.py +2 -2
- vellum/client/types/test_suite_run_progress.py +2 -2
- vellum/client/types/test_suite_run_prompt_sandbox_exec_config_data_request.py +3 -3
- vellum/client/types/test_suite_run_prompt_sandbox_exec_config_request.py +3 -3
- vellum/client/types/test_suite_run_prompt_sandbox_history_item_exec_config.py +3 -3
- vellum/client/types/test_suite_run_prompt_sandbox_history_item_exec_config_data.py +3 -3
- vellum/client/types/test_suite_run_prompt_sandbox_history_item_exec_config_data_request.py +3 -3
- vellum/client/types/test_suite_run_prompt_sandbox_history_item_exec_config_request.py +3 -3
- vellum/client/types/test_suite_run_read.py +12 -6
- vellum/client/types/test_suite_run_test_suite.py +2 -2
- vellum/client/types/test_suite_run_workflow_release_tag_exec_config.py +3 -3
- vellum/client/types/test_suite_run_workflow_release_tag_exec_config_data.py +3 -3
- vellum/client/types/test_suite_run_workflow_release_tag_exec_config_data_request.py +3 -3
- vellum/client/types/test_suite_run_workflow_release_tag_exec_config_request.py +3 -3
- vellum/client/types/test_suite_run_workflow_sandbox_exec_config_data_request.py +3 -3
- vellum/client/types/test_suite_run_workflow_sandbox_exec_config_request.py +3 -3
- vellum/client/types/test_suite_run_workflow_sandbox_history_item_exec_config.py +3 -3
- vellum/client/types/test_suite_run_workflow_sandbox_history_item_exec_config_data.py +3 -3
- vellum/client/types/test_suite_run_workflow_sandbox_history_item_exec_config_data_request.py +3 -3
- vellum/client/types/test_suite_run_workflow_sandbox_history_item_exec_config_request.py +3 -3
- vellum/client/types/test_suite_test_case.py +10 -4
- vellum/client/types/test_suite_test_case_bulk_operation_request.py +2 -1
- vellum/client/types/test_suite_test_case_bulk_result.py +2 -1
- vellum/client/types/test_suite_test_case_create_bulk_operation_request.py +10 -4
- vellum/client/types/test_suite_test_case_created_bulk_result.py +3 -3
- vellum/client/types/test_suite_test_case_created_bulk_result_data.py +2 -2
- vellum/client/types/test_suite_test_case_delete_bulk_operation_data_request.py +2 -2
- vellum/client/types/test_suite_test_case_delete_bulk_operation_request.py +3 -3
- vellum/client/types/test_suite_test_case_deleted_bulk_result.py +3 -3
- vellum/client/types/test_suite_test_case_deleted_bulk_result_data.py +2 -2
- vellum/client/types/test_suite_test_case_rejected_bulk_result.py +2 -2
- vellum/client/types/test_suite_test_case_replace_bulk_operation_request.py +10 -4
- vellum/client/types/test_suite_test_case_replaced_bulk_result.py +3 -3
- vellum/client/types/test_suite_test_case_replaced_bulk_result_data.py +2 -2
- vellum/client/types/test_suite_test_case_upsert_bulk_operation_request.py +10 -4
- vellum/client/types/thinking_vellum_value.py +25 -0
- vellum/client/types/thinking_vellum_value_request.py +25 -0
- vellum/client/types/token_overlapping_window_chunker_config.py +2 -2
- vellum/client/types/token_overlapping_window_chunker_config_request.py +2 -2
- vellum/client/types/token_overlapping_window_chunking.py +3 -3
- vellum/client/types/token_overlapping_window_chunking_request.py +3 -3
- vellum/client/types/update_active_workspace_response.py +32 -0
- vellum/client/types/upload_document_response.py +3 -3
- vellum/client/types/uploaded_file_read.py +27 -0
- vellum/client/types/upsert_test_suite_test_case_request.py +9 -3
- vellum/client/types/variable_prompt_block.py +11 -4
- vellum/client/types/vellum_audio.py +5 -4
- vellum/client/types/vellum_audio_request.py +3 -3
- vellum/client/types/vellum_code_resource_definition.py +7 -2
- vellum/client/types/vellum_document.py +9 -4
- vellum/client/types/vellum_document_request.py +7 -3
- vellum/client/types/vellum_error.py +5 -4
- vellum/client/types/vellum_error_code_enum.py +6 -0
- vellum/client/types/vellum_error_request.py +5 -4
- vellum/client/types/vellum_image.py +9 -4
- vellum/client/types/vellum_image_request.py +7 -3
- vellum/client/types/vellum_node_execution_event.py +4 -3
- vellum/client/types/vellum_sdk_error.py +4 -3
- vellum/client/types/vellum_sdk_error_code_enum.py +5 -0
- vellum/client/types/vellum_secret.py +2 -2
- vellum/client/types/vellum_span.py +2 -1
- vellum/client/types/vellum_value.py +13 -8
- vellum/client/types/vellum_value_logical_condition_group_request.py +6 -6
- vellum/client/types/vellum_value_logical_condition_request.py +13 -7
- vellum/client/types/vellum_value_logical_expression_request.py +2 -1
- vellum/client/types/vellum_value_request.py +13 -8
- vellum/client/types/vellum_variable.py +13 -7
- vellum/client/types/vellum_variable_extensions.py +3 -2
- vellum/client/types/vellum_variable_type.py +3 -1
- vellum/client/types/vellum_video.py +25 -0
- vellum/client/types/vellum_video_request.py +24 -0
- vellum/client/types/vellum_workflow_execution_event.py +4 -3
- vellum/client/types/video_chat_message_content.py +25 -0
- vellum/client/types/video_chat_message_content_request.py +25 -0
- vellum/client/types/video_input.py +30 -0
- vellum/client/types/video_input_request.py +30 -0
- vellum/client/types/video_prompt_block.py +29 -0
- vellum/client/types/video_vellum_value.py +25 -0
- vellum/client/types/video_vellum_value_request.py +25 -0
- vellum/client/types/workflow_deployment_display_data.py +27 -0
- vellum/client/types/workflow_deployment_event_executions_response.py +20 -11
- vellum/client/types/workflow_deployment_history_item.py +10 -4
- vellum/client/types/workflow_deployment_parent_context.py +13 -10
- vellum/client/types/workflow_deployment_read.py +22 -10
- vellum/client/types/workflow_deployment_release.py +13 -7
- vellum/client/types/workflow_deployment_release_workflow_deployment.py +2 -2
- vellum/client/types/workflow_deployment_release_workflow_version.py +10 -4
- vellum/client/types/workflow_display_icon.py +24 -0
- vellum/client/types/workflow_error.py +1 -0
- vellum/client/types/workflow_event.py +37 -0
- vellum/client/types/workflow_event_error.py +5 -3
- vellum/client/types/workflow_event_execution_read.py +26 -16
- vellum/client/types/workflow_execution_actual.py +11 -5
- vellum/client/types/workflow_execution_actual_chat_history_request.py +2 -2
- vellum/client/types/workflow_execution_actual_json_request.py +2 -2
- vellum/client/types/workflow_execution_actual_string_request.py +2 -2
- vellum/client/types/workflow_execution_detail.py +51 -0
- vellum/client/types/workflow_execution_event_error_code.py +5 -0
- vellum/client/types/workflow_execution_fulfilled_body.py +5 -3
- vellum/client/types/workflow_execution_fulfilled_event.py +24 -15
- vellum/client/types/workflow_execution_initiated_body.py +3 -3
- vellum/client/types/workflow_execution_initiated_event.py +24 -15
- vellum/client/types/workflow_execution_node_result_event.py +10 -4
- vellum/client/types/workflow_execution_paused_body.py +4 -4
- vellum/client/types/workflow_execution_paused_event.py +24 -15
- vellum/client/types/workflow_execution_rejected_body.py +5 -4
- vellum/client/types/workflow_execution_rejected_event.py +24 -15
- vellum/client/types/workflow_execution_resumed_body.py +3 -3
- vellum/client/types/workflow_execution_resumed_event.py +24 -15
- vellum/client/types/workflow_execution_snapshotted_body.py +4 -3
- vellum/client/types/workflow_execution_snapshotted_event.py +24 -15
- vellum/client/types/workflow_execution_span.py +22 -11
- vellum/client/types/workflow_execution_span_attributes.py +3 -2
- vellum/client/types/workflow_execution_streaming_body.py +4 -4
- vellum/client/types/workflow_execution_streaming_event.py +24 -15
- vellum/client/types/workflow_execution_usage_calculation_error.py +3 -3
- vellum/client/types/workflow_execution_usage_calculation_fulfilled_body.py +22 -0
- vellum/client/types/workflow_execution_usage_result.py +3 -3
- vellum/client/types/workflow_execution_view_online_eval_metric_result.py +10 -4
- vellum/client/types/workflow_execution_workflow_result_event.py +10 -4
- vellum/client/types/workflow_expand_meta_request.py +2 -2
- vellum/client/types/workflow_initialization_error.py +2 -2
- vellum/client/types/workflow_input.py +31 -0
- vellum/client/types/workflow_node_result_data.py +8 -7
- vellum/client/types/workflow_node_result_event.py +3 -2
- vellum/client/types/workflow_output.py +12 -5
- vellum/client/types/workflow_output_array.py +12 -6
- vellum/client/types/workflow_output_audio.py +31 -0
- vellum/client/types/workflow_output_chat_history.py +3 -3
- vellum/client/types/workflow_output_document.py +31 -0
- vellum/client/types/workflow_output_error.py +3 -3
- vellum/client/types/workflow_output_function_call.py +3 -3
- vellum/client/types/workflow_output_image.py +3 -3
- vellum/client/types/workflow_output_json.py +3 -3
- vellum/client/types/workflow_output_number.py +3 -3
- vellum/client/types/workflow_output_search_results.py +3 -3
- vellum/client/types/workflow_output_string.py +3 -3
- vellum/client/types/workflow_output_video.py +31 -0
- vellum/client/types/workflow_parent_context.py +14 -11
- vellum/client/types/workflow_push_deployment_config_request.py +3 -2
- vellum/client/types/workflow_push_response.py +2 -2
- vellum/client/types/workflow_release_tag_read.py +4 -4
- vellum/client/types/workflow_release_tag_workflow_deployment_history_item.py +2 -2
- vellum/client/types/workflow_request_audio_input_request.py +30 -0
- vellum/client/types/workflow_request_chat_history_input_request.py +3 -3
- vellum/client/types/workflow_request_document_input_request.py +30 -0
- vellum/client/types/workflow_request_image_input_request.py +30 -0
- vellum/client/types/workflow_request_input_request.py +11 -2
- vellum/client/types/workflow_request_json_input_request.py +3 -3
- vellum/client/types/workflow_request_number_input_request.py +3 -3
- vellum/client/types/workflow_request_string_input_request.py +3 -3
- vellum/client/types/workflow_request_video_input_request.py +30 -0
- vellum/client/types/workflow_resolved_state.py +31 -0
- vellum/client/types/workflow_result_event.py +14 -8
- vellum/client/types/workflow_result_event_output_data.py +7 -6
- vellum/client/types/workflow_result_event_output_data_array.py +12 -6
- vellum/client/types/workflow_result_event_output_data_chat_history.py +3 -3
- vellum/client/types/workflow_result_event_output_data_error.py +3 -3
- vellum/client/types/workflow_result_event_output_data_function_call.py +3 -3
- vellum/client/types/workflow_result_event_output_data_json.py +3 -3
- vellum/client/types/workflow_result_event_output_data_number.py +3 -3
- vellum/client/types/workflow_result_event_output_data_search_results.py +3 -3
- vellum/client/types/workflow_result_event_output_data_string.py +3 -3
- vellum/client/types/workflow_result_event_state.py +7 -0
- vellum/client/types/workflow_sandbox_display_data.py +27 -0
- vellum/client/types/workflow_sandbox_example.py +4 -2
- vellum/client/types/workflow_sandbox_parent_context.py +13 -10
- vellum/client/types/workflow_stream_event.py +2 -1
- vellum/client/types/workspace_display_config.py +19 -0
- vellum/client/types/workspace_read.py +5 -3
- vellum/client/types/workspace_secret_read.py +3 -3
- vellum/client/utils.py +24 -0
- vellum/core/force_multipart.py +3 -0
- vellum/core/http_response.py +3 -0
- vellum/errors/misdirected_request_error.py +3 -0
- vellum/errors/too_many_requests_error.py +3 -0
- vellum/errors/unauthorized_error.py +3 -0
- vellum/evaluations/resources.py +5 -5
- vellum/plugins/pydantic.py +14 -3
- vellum/plugins/tests/__init__.py +0 -0
- vellum/plugins/tests/test_pydantic.py +30 -0
- vellum/plugins/vellum_mypy.py +31 -23
- vellum/prompts/__init__.py +3 -0
- vellum/prompts/blocks/__init__.py +3 -0
- vellum/prompts/blocks/compilation.py +29 -11
- vellum/prompts/blocks/helpers.py +31 -0
- vellum/prompts/blocks/tests/test_compilation.py +64 -0
- vellum/raw_client.py +3 -0
- vellum/resources/ad_hoc/raw_client.py +3 -0
- vellum/resources/container_images/raw_client.py +3 -0
- vellum/resources/deployments/raw_client.py +3 -0
- vellum/resources/document_indexes/raw_client.py +3 -0
- vellum/resources/documents/raw_client.py +3 -0
- vellum/resources/{release_reviews → environments}/__init__.py +1 -1
- vellum/resources/{release_reviews → environments}/client.py +1 -1
- vellum/resources/environments/raw_client.py +3 -0
- vellum/resources/events/__init__.py +3 -0
- vellum/resources/events/client.py +3 -0
- vellum/resources/events/raw_client.py +3 -0
- vellum/resources/folder_entities/raw_client.py +3 -0
- vellum/resources/integration_auth_configs/__init__.py +3 -0
- vellum/resources/integration_auth_configs/client.py +3 -0
- vellum/resources/integration_auth_configs/raw_client.py +3 -0
- vellum/resources/integration_providers/__init__.py +3 -0
- vellum/resources/integration_providers/client.py +3 -0
- vellum/resources/integration_providers/raw_client.py +3 -0
- vellum/resources/integrations/__init__.py +3 -0
- vellum/resources/integrations/client.py +3 -0
- vellum/resources/integrations/raw_client.py +3 -0
- vellum/resources/metric_definitions/raw_client.py +3 -0
- vellum/resources/ml_models/raw_client.py +3 -0
- vellum/resources/organizations/raw_client.py +3 -0
- vellum/resources/prompts/raw_client.py +3 -0
- vellum/resources/sandboxes/raw_client.py +3 -0
- vellum/resources/test_suite_runs/raw_client.py +3 -0
- vellum/resources/test_suites/raw_client.py +3 -0
- vellum/resources/uploaded_files/__init__.py +3 -0
- vellum/resources/uploaded_files/client.py +3 -0
- vellum/resources/uploaded_files/raw_client.py +3 -0
- vellum/resources/workflow_deployments/raw_client.py +3 -0
- vellum/resources/workflow_executions/__init__.py +3 -0
- vellum/resources/workflow_executions/client.py +3 -0
- vellum/resources/workflow_executions/raw_client.py +3 -0
- vellum/resources/workflow_sandboxes/raw_client.py +3 -0
- vellum/resources/workflows/raw_client.py +3 -0
- vellum/resources/workspace_secrets/raw_client.py +3 -0
- vellum/resources/workspaces/raw_client.py +3 -0
- vellum/types/api_actor_type_enum.py +3 -0
- vellum/types/audio_input.py +3 -0
- vellum/types/audio_input_request.py +3 -0
- vellum/types/auth_type_enum.py +3 -0
- vellum/types/build_status_enum.py +3 -0
- vellum/types/components_schemas_composio_execute_tool_request.py +3 -0
- vellum/types/components_schemas_composio_execute_tool_response.py +3 -0
- vellum/types/components_schemas_composio_integration_exec_config.py +3 -0
- vellum/types/components_schemas_composio_tool_definition.py +3 -0
- vellum/types/components_schemas_slim_composio_tool_definition.py +3 -0
- vellum/types/composio_execute_tool_request.py +3 -0
- vellum/types/composio_execute_tool_response.py +3 -0
- vellum/types/composio_integration_exec_config.py +3 -0
- vellum/types/composio_tool_definition.py +3 -0
- vellum/types/container_image_build_config.py +3 -0
- vellum/types/create_workflow_event_request.py +3 -0
- vellum/types/dataset_row_push_request.py +3 -0
- vellum/types/delimiter_chunker_config.py +3 -0
- vellum/types/delimiter_chunker_config_request.py +3 -0
- vellum/types/delimiter_chunking.py +3 -0
- vellum/types/delimiter_chunking_request.py +3 -0
- vellum/types/deprecated_prompt_request_input.py +3 -0
- vellum/types/document_input.py +3 -0
- vellum/types/document_input_request.py +3 -0
- vellum/types/environment_display_config.py +3 -0
- vellum/types/environment_read.py +3 -0
- vellum/types/error_detail_response.py +3 -0
- vellum/types/event_create_response.py +3 -0
- vellum/types/execute_workflow_async_response.py +3 -0
- vellum/types/execution_audio_vellum_value.py +3 -0
- vellum/types/execution_document_vellum_value.py +3 -0
- vellum/types/execution_image_vellum_value.py +3 -0
- vellum/types/execution_thinking_vellum_value.py +3 -0
- vellum/types/execution_video_vellum_value.py +3 -0
- vellum/types/external_parent_context.py +3 -0
- vellum/types/fast_embed_vectorizer_baai_bge_small_en_v_15.py +3 -0
- vellum/types/fast_embed_vectorizer_baai_bge_small_en_v_15_request.py +3 -0
- vellum/types/folder_entity_dataset.py +3 -0
- vellum/types/folder_entity_dataset_data.py +3 -0
- vellum/types/google_vertex_ai_vectorizer_gemini_embedding_001.py +3 -0
- vellum/types/google_vertex_ai_vectorizer_gemini_embedding_001_request.py +3 -0
- vellum/types/image_input.py +3 -0
- vellum/types/image_input_request.py +3 -0
- vellum/types/integration.py +3 -0
- vellum/types/integration_auth_config_integration.py +3 -0
- vellum/types/integration_auth_config_integration_credential.py +3 -0
- vellum/types/integration_credential_access_type.py +3 -0
- vellum/types/integration_name.py +3 -0
- vellum/types/integration_provider.py +3 -0
- vellum/types/integration_read.py +3 -0
- vellum/types/integration_trigger_context.py +3 -0
- vellum/types/named_scenario_input_audio_variable_value_request.py +3 -0
- vellum/types/named_scenario_input_document_variable_value_request.py +3 -0
- vellum/types/named_scenario_input_image_variable_value_request.py +3 -0
- vellum/types/named_scenario_input_video_variable_value_request.py +3 -0
- vellum/types/named_test_case_audio_variable_value.py +3 -0
- vellum/types/named_test_case_audio_variable_value_request.py +3 -0
- vellum/types/named_test_case_document_variable_value.py +3 -0
- vellum/types/named_test_case_document_variable_value_request.py +3 -0
- vellum/types/named_test_case_image_variable_value.py +3 -0
- vellum/types/named_test_case_image_variable_value_request.py +3 -0
- vellum/types/named_test_case_video_variable_value.py +3 -0
- vellum/types/named_test_case_video_variable_value_request.py +3 -0
- vellum/types/node_input_compiled_audio_value.py +3 -0
- vellum/types/node_input_compiled_document_value.py +3 -0
- vellum/types/node_input_compiled_image_value.py +3 -0
- vellum/types/node_input_compiled_video_value.py +3 -0
- vellum/types/node_output_compiled_thinking_value.py +3 -0
- vellum/types/paginated_slim_integration_auth_config_read_list.py +3 -0
- vellum/types/paginated_slim_integration_read_list.py +3 -0
- vellum/types/paginated_slim_tool_definition_list.py +3 -0
- vellum/types/paginated_workflow_deployment_release_list.py +3 -0
- vellum/types/private_vectorizer.py +3 -0
- vellum/types/private_vectorizer_request.py +3 -0
- vellum/types/prompt_request_audio_input.py +3 -0
- vellum/types/prompt_request_document_input.py +3 -0
- vellum/types/prompt_request_image_input.py +3 -0
- vellum/types/prompt_request_video_input.py +3 -0
- vellum/types/scenario_input_audio_variable_value.py +3 -0
- vellum/types/scenario_input_document_variable_value.py +3 -0
- vellum/types/scenario_input_image_variable_value.py +3 -0
- vellum/types/scenario_input_video_variable_value.py +3 -0
- vellum/types/scheduled_trigger_context.py +3 -0
- vellum/types/slim_composio_tool_definition.py +3 -0
- vellum/types/slim_integration_auth_config_read.py +3 -0
- vellum/types/slim_integration_read.py +3 -0
- vellum/types/test_case_audio_variable_value.py +3 -0
- vellum/types/test_case_document_variable_value.py +3 -0
- vellum/types/test_case_image_variable_value.py +3 -0
- vellum/types/test_case_video_variable_value.py +3 -0
- vellum/types/thinking_vellum_value.py +3 -0
- vellum/types/thinking_vellum_value_request.py +3 -0
- vellum/types/update_active_workspace_response.py +3 -0
- vellum/types/uploaded_file_read.py +3 -0
- vellum/types/vellum_video.py +3 -0
- vellum/types/vellum_video_request.py +3 -0
- vellum/types/video_chat_message_content.py +3 -0
- vellum/types/video_chat_message_content_request.py +3 -0
- vellum/types/video_input.py +3 -0
- vellum/types/video_input_request.py +3 -0
- vellum/types/video_prompt_block.py +3 -0
- vellum/types/video_vellum_value.py +3 -0
- vellum/types/video_vellum_value_request.py +3 -0
- vellum/types/workflow_deployment_display_data.py +3 -0
- vellum/types/workflow_display_icon.py +3 -0
- vellum/types/workflow_event.py +3 -0
- vellum/types/workflow_execution_detail.py +3 -0
- vellum/types/workflow_execution_usage_calculation_fulfilled_body.py +3 -0
- vellum/types/workflow_input.py +3 -0
- vellum/types/workflow_output_audio.py +3 -0
- vellum/types/workflow_output_document.py +3 -0
- vellum/types/workflow_output_video.py +3 -0
- vellum/types/workflow_request_audio_input_request.py +3 -0
- vellum/types/workflow_request_document_input_request.py +3 -0
- vellum/types/workflow_request_image_input_request.py +3 -0
- vellum/types/workflow_request_video_input_request.py +3 -0
- vellum/types/workflow_resolved_state.py +3 -0
- vellum/types/workflow_result_event_state.py +3 -0
- vellum/types/workflow_sandbox_display_data.py +3 -0
- vellum/types/workspace_display_config.py +3 -0
- vellum/utils/files/__init__.py +18 -0
- vellum/utils/files/constants.py +47 -0
- vellum/utils/files/exceptions.py +25 -0
- vellum/utils/files/extensions.py +59 -0
- vellum/utils/files/mixin.py +109 -0
- vellum/utils/files/read.py +41 -0
- vellum/utils/files/stream.py +135 -0
- vellum/utils/files/tests/__init__.py +0 -0
- vellum/utils/files/tests/test_extensions.py +54 -0
- vellum/utils/files/tests/test_mixin.py +205 -0
- vellum/utils/files/tests/test_read.py +204 -0
- vellum/utils/files/tests/test_stream.py +199 -0
- vellum/utils/files/tests/test_upload.py +309 -0
- vellum/utils/files/tests/test_urls.py +252 -0
- vellum/utils/files/types.py +8 -0
- vellum/utils/files/upload.py +151 -0
- vellum/utils/files/urls.py +71 -0
- vellum/utils/json_encoder.py +95 -0
- vellum/utils/templating/custom_filters.py +4 -4
- vellum/utils/templating/render.py +4 -4
- vellum/utils/tests/__init__.py +0 -0
- vellum/utils/tests/test_json_encoder.py +92 -0
- vellum/utils/vellum_client.py +40 -0
- vellum/workflows/__init__.py +78 -0
- vellum/workflows/constants.py +7 -0
- vellum/workflows/context.py +27 -9
- vellum/workflows/descriptors/base.py +83 -2
- vellum/workflows/descriptors/exceptions.py +18 -1
- vellum/workflows/descriptors/tests/test_utils.py +57 -0
- vellum/workflows/descriptors/utils.py +27 -3
- vellum/workflows/edges/__init__.py +2 -0
- vellum/workflows/edges/trigger_edge.py +67 -0
- vellum/workflows/emitters/__init__.py +2 -0
- vellum/workflows/emitters/base.py +25 -0
- vellum/workflows/emitters/vellum_emitter.py +150 -0
- vellum/workflows/environment/__init__.py +2 -1
- vellum/workflows/environment/environment.py +10 -3
- vellum/workflows/errors/types.py +18 -1
- vellum/workflows/events/__init__.py +2 -0
- vellum/workflows/events/context.py +90 -0
- vellum/workflows/events/exception_handling.py +58 -0
- vellum/workflows/events/node.py +27 -11
- vellum/workflows/events/relational_threads.py +41 -0
- vellum/workflows/events/stream.py +28 -0
- vellum/workflows/events/tests/test_basic_workflow.py +50 -0
- vellum/workflows/events/tests/test_event.py +145 -20
- vellum/workflows/events/types.py +32 -4
- vellum/workflows/events/workflow.py +111 -8
- vellum/workflows/exceptions.py +46 -7
- vellum/workflows/executable.py +9 -0
- vellum/workflows/expressions/accessor.py +65 -11
- vellum/workflows/expressions/add.py +41 -0
- vellum/workflows/expressions/comparison_utils.py +38 -0
- vellum/workflows/expressions/concat.py +35 -0
- vellum/workflows/expressions/contains.py +7 -0
- vellum/workflows/expressions/greater_than.py +8 -1
- vellum/workflows/expressions/greater_than_or_equal_to.py +8 -1
- vellum/workflows/expressions/is_error.py +23 -0
- vellum/workflows/expressions/length.py +46 -0
- vellum/workflows/expressions/less_than.py +8 -1
- vellum/workflows/expressions/less_than_or_equal_to.py +8 -1
- vellum/workflows/expressions/minus.py +41 -0
- vellum/workflows/expressions/tests/test_accessor.py +248 -0
- vellum/workflows/expressions/tests/test_add.py +72 -0
- vellum/workflows/expressions/tests/test_concat.py +108 -0
- vellum/workflows/expressions/tests/test_contains.py +175 -0
- vellum/workflows/expressions/tests/test_expressions.py +145 -32
- vellum/workflows/expressions/tests/test_length.py +38 -0
- vellum/workflows/expressions/tests/test_minus.py +109 -0
- vellum/workflows/graph/graph.py +255 -8
- vellum/workflows/graph/tests/test_graph.py +300 -0
- vellum/workflows/inputs/__init__.py +2 -0
- vellum/workflows/inputs/base.py +49 -15
- vellum/workflows/inputs/dataset_row.py +81 -0
- vellum/workflows/inputs/tests/test_inputs.py +181 -1
- vellum/workflows/integrations/__init__.py +5 -0
- vellum/workflows/integrations/composio_service.py +158 -0
- vellum/workflows/integrations/mcp_service.py +282 -0
- vellum/workflows/integrations/tests/__init__.py +0 -0
- vellum/workflows/integrations/tests/test_mcp_service.py +273 -0
- vellum/workflows/integrations/tests/test_vellum_integration_service.py +299 -0
- vellum/workflows/integrations/vellum_integration_service.py +136 -0
- vellum/workflows/loaders/__init__.py +3 -0
- vellum/workflows/loaders/base.py +36 -0
- vellum/workflows/nodes/__init__.py +2 -0
- vellum/workflows/nodes/bases/base.py +142 -80
- vellum/workflows/nodes/bases/base_adornment_node.py +55 -1
- vellum/workflows/nodes/bases/tests/test_base_node.py +50 -4
- vellum/workflows/nodes/core/error_node/node.py +11 -2
- vellum/workflows/nodes/core/inline_subworkflow_node/node.py +29 -3
- vellum/workflows/nodes/core/inline_subworkflow_node/tests/test_node.py +35 -0
- vellum/workflows/nodes/core/map_node/node.py +26 -1
- vellum/workflows/nodes/core/map_node/tests/test_node.py +73 -0
- vellum/workflows/nodes/core/retry_node/tests/test_node.py +2 -3
- vellum/workflows/nodes/core/templating_node/node.py +7 -2
- vellum/workflows/nodes/core/templating_node/tests/test_templating_node.py +194 -1
- vellum/workflows/nodes/displayable/__init__.py +6 -0
- vellum/workflows/nodes/displayable/api_node/node.py +10 -1
- vellum/workflows/nodes/displayable/api_node/tests/test_api_node.py +113 -2
- vellum/workflows/nodes/displayable/bases/api_node/node.py +70 -16
- vellum/workflows/nodes/displayable/bases/api_node/tests/__init__.py +0 -0
- vellum/workflows/nodes/displayable/bases/api_node/tests/test_node.py +150 -0
- vellum/workflows/nodes/displayable/bases/base_prompt_node/node.py +68 -7
- vellum/workflows/nodes/displayable/bases/inline_prompt_node/node.py +215 -17
- vellum/workflows/nodes/displayable/bases/inline_prompt_node/tests/test_inline_prompt_node.py +352 -32
- vellum/workflows/nodes/displayable/bases/prompt_deployment_node.py +73 -1
- vellum/workflows/nodes/displayable/bases/search_node.py +26 -3
- vellum/workflows/nodes/displayable/bases/tests/test_prompt_deployment_node.py +90 -0
- vellum/workflows/nodes/displayable/bases/utils.py +82 -5
- vellum/workflows/nodes/displayable/code_execution_node/node.py +35 -9
- vellum/workflows/nodes/displayable/code_execution_node/tests/test_node.py +242 -13
- vellum/workflows/nodes/displayable/code_execution_node/utils.py +5 -21
- vellum/workflows/nodes/displayable/conditional_node/node.py +8 -4
- vellum/workflows/nodes/displayable/final_output_node/node.py +80 -1
- vellum/workflows/nodes/displayable/final_output_node/tests/test_node.py +96 -1
- vellum/workflows/nodes/displayable/guardrail_node/node.py +13 -4
- vellum/workflows/nodes/displayable/inline_prompt_node/node.py +9 -36
- vellum/workflows/nodes/displayable/inline_prompt_node/tests/test_node.py +3 -0
- vellum/workflows/nodes/displayable/merge_node/node.py +8 -1
- vellum/workflows/nodes/displayable/note_node/node.py +8 -1
- vellum/workflows/nodes/displayable/prompt_deployment_node/node.py +7 -23
- vellum/workflows/nodes/displayable/search_node/node.py +15 -2
- vellum/workflows/nodes/displayable/search_node/tests/test_node.py +33 -0
- vellum/workflows/nodes/displayable/set_state_node/__init__.py +5 -0
- vellum/workflows/nodes/displayable/set_state_node/node.py +71 -0
- vellum/workflows/nodes/displayable/set_state_node/tests/__init__.py +0 -0
- vellum/workflows/nodes/displayable/set_state_node/tests/test_node.py +212 -0
- vellum/workflows/nodes/displayable/subworkflow_deployment_node/node.py +220 -59
- vellum/workflows/nodes/displayable/subworkflow_deployment_node/tests/test_node.py +1 -1
- vellum/workflows/nodes/displayable/tests/test_inline_text_prompt_node.py +4 -1
- vellum/workflows/nodes/displayable/tests/test_search_node_error_handling.py +329 -0
- vellum/workflows/nodes/displayable/tests/test_text_prompt_deployment_node.py +10 -15
- vellum/workflows/nodes/displayable/tool_calling_node/__init__.py +3 -0
- vellum/workflows/nodes/displayable/tool_calling_node/node.py +225 -0
- vellum/workflows/nodes/displayable/tool_calling_node/state.py +11 -0
- vellum/workflows/nodes/displayable/tool_calling_node/tests/__init__.py +0 -0
- vellum/workflows/nodes/displayable/tool_calling_node/tests/test_composio_service.py +219 -0
- vellum/workflows/nodes/displayable/tool_calling_node/tests/test_node.py +802 -0
- vellum/workflows/nodes/displayable/tool_calling_node/tests/test_utils.py +316 -0
- vellum/workflows/nodes/displayable/tool_calling_node/utils.py +633 -0
- vellum/workflows/nodes/displayable/web_search_node/__init__.py +3 -0
- vellum/workflows/nodes/displayable/web_search_node/node.py +136 -0
- vellum/workflows/nodes/displayable/web_search_node/tests/__init__.py +0 -0
- vellum/workflows/nodes/displayable/web_search_node/tests/test_node.py +246 -0
- vellum/workflows/nodes/experimental/__init__.py +1 -3
- vellum/workflows/nodes/mocks.py +40 -9
- vellum/workflows/nodes/tests/test_mocks.py +2 -2
- vellum/workflows/nodes/tests/test_utils.py +34 -5
- vellum/workflows/nodes/utils.py +45 -6
- vellum/workflows/outputs/base.py +53 -12
- vellum/workflows/ports/node_ports.py +3 -0
- vellum/workflows/ports/port.py +27 -12
- vellum/workflows/ports/tests/test_port.py +45 -0
- vellum/workflows/ports/utils.py +26 -6
- vellum/workflows/references/__init__.py +2 -0
- vellum/workflows/references/constant.py +4 -1
- vellum/workflows/references/environment_variable.py +27 -9
- vellum/workflows/references/output.py +4 -6
- vellum/workflows/references/trigger.py +77 -0
- vellum/workflows/resolvers/base.py +19 -1
- vellum/workflows/resolvers/resolver.py +71 -0
- vellum/workflows/resolvers/tests/test_resolver.py +168 -0
- vellum/workflows/resolvers/types.py +11 -0
- vellum/workflows/runner/runner.py +642 -160
- vellum/workflows/sandbox.py +55 -9
- vellum/workflows/state/base.py +164 -40
- vellum/workflows/state/context.py +225 -6
- vellum/workflows/state/delta.py +20 -0
- vellum/workflows/state/encoder.py +2 -77
- vellum/workflows/state/tests/test_state.py +24 -9
- vellum/workflows/tests/test_dataset_row.py +190 -0
- vellum/workflows/tests/test_sandbox.py +137 -0
- vellum/workflows/tests/triggers/test_integration_trigger.py +156 -0
- vellum/workflows/triggers/__init__.py +6 -0
- vellum/workflows/triggers/base.py +391 -0
- vellum/workflows/triggers/integration.py +186 -0
- vellum/workflows/triggers/manual.py +37 -0
- vellum/workflows/triggers/schedule.py +18 -0
- vellum/workflows/triggers/tests/__init__.py +1 -0
- vellum/workflows/triggers/tests/test_base_trigger_display.py +147 -0
- vellum/workflows/triggers/tests/test_integration.py +155 -0
- vellum/workflows/types/__init__.py +2 -1
- vellum/workflows/types/code_execution_node_wrappers.py +5 -1
- vellum/workflows/types/core.py +5 -0
- vellum/workflows/types/definition.py +168 -2
- vellum/workflows/types/generics.py +5 -0
- vellum/workflows/types/tests/test_definition.py +183 -0
- vellum/workflows/types/tests/test_utils.py +11 -0
- vellum/workflows/types/utils.py +33 -3
- vellum/workflows/utils/files.py +28 -0
- vellum/workflows/utils/functions.py +244 -19
- vellum/workflows/utils/hmac.py +44 -0
- vellum/workflows/utils/names.py +32 -4
- vellum/workflows/utils/pydantic_schema.py +38 -0
- vellum/workflows/utils/tests/test_functions.py +357 -15
- vellum/workflows/utils/tests/test_names.py +9 -0
- vellum/workflows/utils/tests/test_vellum_variables.py +32 -2
- vellum/workflows/utils/uuids.py +35 -0
- vellum/workflows/utils/vellum_variables.py +131 -7
- vellum/workflows/utils/zip.py +46 -0
- vellum/workflows/vellum_client.py +3 -33
- vellum/workflows/workflows/base.py +350 -39
- vellum/workflows/workflows/event_filters.py +13 -0
- vellum/workflows/workflows/tests/test_base_workflow.py +118 -6
- vellum/workflows/workflows/tests/test_event_filters.py +126 -0
- {vellum_ai-0.14.63.dist-info → vellum_ai-1.11.2.dist-info}/METADATA +12 -13
- vellum_ai-1.11.2.dist-info/RECORD +2177 -0
- vellum_ai-1.11.2.dist-info/entry_points.txt +4 -0
- vellum_cli/__init__.py +34 -4
- vellum_cli/config.py +5 -3
- vellum_cli/image_push.py +106 -8
- vellum_cli/move.py +56 -0
- vellum_cli/ping.py +6 -0
- vellum_cli/pull.py +48 -14
- vellum_cli/push.py +103 -26
- vellum_cli/tests/conftest.py +6 -0
- vellum_cli/tests/test_image_push.py +190 -12
- vellum_cli/tests/test_image_push_error_handling.py +258 -0
- vellum_cli/tests/test_init.py +7 -24
- vellum_cli/tests/test_move.py +154 -0
- vellum_cli/tests/test_ping.py +15 -0
- vellum_cli/tests/test_pull.py +42 -61
- vellum_cli/tests/test_push.py +443 -11
- vellum_ee/assets/node-definitions.json +1135 -0
- vellum_ee/scripts/generate_node_definitions.py +89 -0
- vellum_ee/workflows/display/base.py +29 -55
- vellum_ee/workflows/display/editor/types.py +3 -0
- vellum_ee/workflows/display/exceptions.py +3 -0
- vellum_ee/workflows/display/nodes/base_node_display.py +164 -56
- vellum_ee/workflows/display/nodes/tests/test_base_node_display.py +149 -3
- vellum_ee/workflows/display/nodes/vellum/__init__.py +2 -0
- vellum_ee/workflows/display/nodes/vellum/api_node.py +26 -13
- vellum_ee/workflows/display/nodes/vellum/base_adornment_node.py +3 -3
- vellum_ee/workflows/display/nodes/vellum/code_execution_node.py +23 -7
- vellum_ee/workflows/display/nodes/vellum/conditional_node.py +18 -7
- vellum_ee/workflows/display/nodes/vellum/error_node.py +2 -4
- vellum_ee/workflows/display/nodes/vellum/final_output_node.py +3 -14
- vellum_ee/workflows/display/nodes/vellum/function_node.py +14 -0
- vellum_ee/workflows/display/nodes/vellum/guardrail_node.py +2 -5
- vellum_ee/workflows/display/nodes/vellum/inline_prompt_node.py +77 -44
- vellum_ee/workflows/display/nodes/vellum/inline_subworkflow_node.py +33 -10
- vellum_ee/workflows/display/nodes/vellum/map_node.py +29 -15
- vellum_ee/workflows/display/nodes/vellum/merge_node.py +2 -5
- vellum_ee/workflows/display/nodes/vellum/note_node.py +2 -3
- vellum_ee/workflows/display/nodes/vellum/prompt_deployment_node.py +13 -9
- vellum_ee/workflows/display/nodes/vellum/retry_node.py +5 -6
- vellum_ee/workflows/display/nodes/vellum/search_node.py +76 -19
- vellum_ee/workflows/display/nodes/vellum/subworkflow_deployment_node.py +21 -10
- vellum_ee/workflows/display/nodes/vellum/templating_node.py +3 -6
- vellum_ee/workflows/display/nodes/vellum/tests/test_api_node.py +65 -0
- vellum_ee/workflows/display/nodes/vellum/tests/test_code_execution_node.py +176 -3
- vellum_ee/workflows/display/nodes/vellum/tests/test_final_output_node.py +80 -0
- vellum_ee/workflows/display/nodes/vellum/tests/test_inline_subworkflow_node.py +88 -0
- vellum_ee/workflows/display/nodes/vellum/tests/test_prompt_deployment_node.py +71 -1
- vellum_ee/workflows/display/nodes/vellum/tests/test_prompt_node.py +115 -13
- vellum_ee/workflows/display/nodes/vellum/tests/test_retry_node.py +1 -1
- vellum_ee/workflows/display/nodes/vellum/tests/test_search_node.py +104 -0
- vellum_ee/workflows/display/nodes/vellum/tests/test_subworkflow_deployment_node.py +1 -1
- vellum_ee/workflows/display/nodes/vellum/tests/test_templating_node.py +2 -2
- vellum_ee/workflows/display/nodes/vellum/tests/test_tool_calling_node.py +526 -49
- vellum_ee/workflows/display/nodes/vellum/tests/test_try_node.py +2 -2
- vellum_ee/workflows/display/nodes/vellum/tests/test_utils.py +8 -9
- vellum_ee/workflows/display/nodes/vellum/try_node.py +5 -6
- vellum_ee/workflows/display/tests/test_base_workflow_display.py +383 -9
- vellum_ee/workflows/display/tests/workflow_serialization/generic_nodes/conftest.py +2 -2
- vellum_ee/workflows/display/tests/workflow_serialization/generic_nodes/test_adornments_serialization.py +102 -39
- vellum_ee/workflows/display/tests/workflow_serialization/generic_nodes/test_attributes_serialization.py +233 -90
- vellum_ee/workflows/display/tests/workflow_serialization/generic_nodes/test_outputs_serialization.py +21 -17
- vellum_ee/workflows/display/tests/workflow_serialization/generic_nodes/test_ports_serialization.py +76 -64
- vellum_ee/workflows/display/tests/workflow_serialization/generic_nodes/test_trigger_serialization.py +69 -12
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_api_node_serialization.py +68 -46
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_code_execution_node_serialization.py +92 -80
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_conditional_node_serialization.py +193 -177
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_default_state_serialization.py +14 -14
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_error_node_serialization.py +14 -9
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_generic_node_serialization.py +28 -17
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_guardrail_node_serialization.py +20 -16
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_inline_prompt_node_serialization.py +386 -31
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_inline_subworkflow_serialization.py +59 -46
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_map_node_serialization.py +41 -32
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_merge_node_serialization.py +37 -33
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_prompt_deployment_serialization.py +73 -61
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_search_node_serialization.py +40 -36
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_set_state_node_serialization.py +86 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_subworkflow_deployment_serialization.py +25 -21
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_templating_node_serialization.py +22 -18
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_terminal_node_serialization.py +13 -8
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_composio_serialization.py +87 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_inline_workflow_serialization.py +313 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_mcp_serialization.py +65 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_parent_input.py +89 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_serialization.py +57 -23
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_vellum_integration_serialization.py +68 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_workflow_deployment_serialization.py +107 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_basic_try_node_serialization.py +2 -2
- vellum_ee/workflows/display/tests/workflow_serialization/test_chat_message_dict_reference_serialization.py +108 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_complex_terminal_node_serialization.py +15 -10
- vellum_ee/workflows/display/tests/workflow_serialization/test_final_output_node_map_reference_serialization.py +88 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_integration_trigger_serialization.py +306 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_integration_trigger_with_entrypoint_node_id.py +88 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_list_vellum_document_serialization.py +65 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_manual_trigger_serialization.py +110 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_map_node_with_terminal_nodes_serialization.py +62 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_multi_trigger_same_node_serialization.py +99 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_scheduled_trigger_serialization.py +267 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_terminal_node_any_serialization.py +49 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_trigger_display_from_display_class.py +153 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_web_search_node_serialization.py +72 -0
- vellum_ee/workflows/display/tests/workflow_serialization/test_workflow_input_parameterization_error.py +37 -0
- vellum_ee/workflows/display/types.py +29 -2
- vellum_ee/workflows/display/utils/auto_layout.py +130 -0
- vellum_ee/workflows/display/utils/events.py +57 -0
- vellum_ee/workflows/display/utils/exceptions.py +19 -0
- vellum_ee/workflows/display/utils/expressions.py +231 -28
- vellum_ee/workflows/display/utils/metadata.py +146 -0
- vellum_ee/workflows/display/utils/registry.py +46 -0
- vellum_ee/workflows/display/utils/tests/__init__.py +0 -0
- vellum_ee/workflows/display/utils/tests/test_auto_layout.py +56 -0
- vellum_ee/workflows/display/utils/tests/test_events.py +185 -0
- vellum_ee/workflows/display/utils/tests/test_expressions.py +92 -0
- vellum_ee/workflows/display/utils/vellum.py +39 -4
- vellum_ee/workflows/display/vellum.py +2 -128
- vellum_ee/workflows/display/workflows/__init__.py +0 -1
- vellum_ee/workflows/display/workflows/base_workflow_display.py +727 -95
- vellum_ee/workflows/display/workflows/tests/test_workflow_display.py +318 -28
- vellum_ee/workflows/server/virtual_file_loader.py +131 -6
- vellum_ee/workflows/tests/local_workflow/display/nodes/final_output.py +1 -1
- vellum_ee/workflows/tests/local_workflow/display/nodes/templating_node.py +1 -1
- vellum_ee/workflows/tests/local_workflow/display/workflow.py +11 -14
- vellum_ee/workflows/tests/test_display_meta.py +41 -0
- vellum_ee/workflows/tests/test_registry.py +169 -0
- vellum_ee/workflows/tests/test_serialize_module.py +265 -0
- vellum_ee/workflows/tests/test_server.py +619 -44
- vellum_ee/workflows/tests/test_virtual_files.py +48 -0
- vellum/client/resources/release_reviews/client.py +0 -137
- vellum/workflows/nodes/experimental/openai_chat_completion_node/__init__.py +0 -5
- vellum/workflows/nodes/experimental/openai_chat_completion_node/node.py +0 -266
- vellum/workflows/nodes/experimental/tool_calling_node/__init__.py +0 -3
- vellum/workflows/nodes/experimental/tool_calling_node/node.py +0 -135
- vellum/workflows/nodes/experimental/tool_calling_node/tests/test_node.py +0 -53
- vellum/workflows/nodes/experimental/tool_calling_node/utils.py +0 -259
- vellum_ai-0.14.63.dist-info/RECORD +0 -1719
- vellum_ai-0.14.63.dist-info/entry_points.txt +0 -3
- vellum_ee/workflows/display/workflows/vellum_workflow_display.py +0 -9
- /vellum/{workflows/nodes/displayable/bases/inline_prompt_node → prompts}/constants.py +0 -0
- {vellum_ai-0.14.63.dist-info → vellum_ai-1.11.2.dist-info}/LICENSE +0 -0
- {vellum_ai-0.14.63.dist-info → vellum_ai-1.11.2.dist-info}/WHEEL +0 -0
vellum/client/reference.md
CHANGED
|
@@ -15,10 +15,11 @@
|
|
|
15
15
|
from vellum import Vellum
|
|
16
16
|
|
|
17
17
|
client = Vellum(
|
|
18
|
+
api_version="YOUR_API_VERSION",
|
|
18
19
|
api_key="YOUR_API_KEY",
|
|
19
20
|
)
|
|
20
21
|
client.execute_api(
|
|
21
|
-
url="
|
|
22
|
+
url="x",
|
|
22
23
|
)
|
|
23
24
|
|
|
24
25
|
```
|
|
@@ -103,22 +104,31 @@ client.execute_api(
|
|
|
103
104
|
from vellum import CodeExecutionPackage, StringInput, Vellum
|
|
104
105
|
|
|
105
106
|
client = Vellum(
|
|
107
|
+
api_version="YOUR_API_VERSION",
|
|
106
108
|
api_key="YOUR_API_KEY",
|
|
107
109
|
)
|
|
108
110
|
client.execute_code(
|
|
109
|
-
code="
|
|
111
|
+
code="x",
|
|
110
112
|
runtime="PYTHON_3_11_6",
|
|
111
113
|
input_values=[
|
|
112
114
|
StringInput(
|
|
113
|
-
name="
|
|
115
|
+
name="x",
|
|
116
|
+
value="value",
|
|
117
|
+
),
|
|
118
|
+
StringInput(
|
|
119
|
+
name="x",
|
|
114
120
|
value="value",
|
|
115
|
-
)
|
|
121
|
+
),
|
|
116
122
|
],
|
|
117
123
|
packages=[
|
|
118
124
|
CodeExecutionPackage(
|
|
119
125
|
version="version",
|
|
120
126
|
name="name",
|
|
121
|
-
)
|
|
127
|
+
),
|
|
128
|
+
CodeExecutionPackage(
|
|
129
|
+
version="version",
|
|
130
|
+
name="name",
|
|
131
|
+
),
|
|
122
132
|
],
|
|
123
133
|
output_type="STRING",
|
|
124
134
|
)
|
|
@@ -219,14 +229,19 @@ Executes a deployed Prompt and returns the result.
|
|
|
219
229
|
from vellum import StringInputRequest, Vellum
|
|
220
230
|
|
|
221
231
|
client = Vellum(
|
|
232
|
+
api_version="YOUR_API_VERSION",
|
|
222
233
|
api_key="YOUR_API_KEY",
|
|
223
234
|
)
|
|
224
235
|
client.execute_prompt(
|
|
225
236
|
inputs=[
|
|
226
237
|
StringInputRequest(
|
|
227
|
-
name="
|
|
238
|
+
name="x",
|
|
239
|
+
value="value",
|
|
240
|
+
),
|
|
241
|
+
StringInputRequest(
|
|
242
|
+
name="x",
|
|
228
243
|
value="value",
|
|
229
|
-
)
|
|
244
|
+
),
|
|
230
245
|
],
|
|
231
246
|
)
|
|
232
247
|
|
|
@@ -358,17 +373,22 @@ Executes a deployed Prompt and streams back the results.
|
|
|
358
373
|
from vellum import StringInputRequest, Vellum
|
|
359
374
|
|
|
360
375
|
client = Vellum(
|
|
376
|
+
api_version="YOUR_API_VERSION",
|
|
361
377
|
api_key="YOUR_API_KEY",
|
|
362
378
|
)
|
|
363
379
|
response = client.execute_prompt_stream(
|
|
364
380
|
inputs=[
|
|
365
381
|
StringInputRequest(
|
|
366
|
-
name="
|
|
382
|
+
name="x",
|
|
367
383
|
value="value",
|
|
368
|
-
)
|
|
384
|
+
),
|
|
385
|
+
StringInputRequest(
|
|
386
|
+
name="x",
|
|
387
|
+
value="value",
|
|
388
|
+
),
|
|
369
389
|
],
|
|
370
390
|
)
|
|
371
|
-
for chunk in response:
|
|
391
|
+
for chunk in response.data:
|
|
372
392
|
yield chunk
|
|
373
393
|
|
|
374
394
|
```
|
|
@@ -499,14 +519,19 @@ Executes a deployed Workflow and returns its outputs.
|
|
|
499
519
|
from vellum import Vellum, WorkflowRequestStringInputRequest
|
|
500
520
|
|
|
501
521
|
client = Vellum(
|
|
522
|
+
api_version="YOUR_API_VERSION",
|
|
502
523
|
api_key="YOUR_API_KEY",
|
|
503
524
|
)
|
|
504
525
|
client.execute_workflow(
|
|
505
526
|
inputs=[
|
|
506
527
|
WorkflowRequestStringInputRequest(
|
|
507
|
-
name="
|
|
528
|
+
name="x",
|
|
529
|
+
value="value",
|
|
530
|
+
),
|
|
531
|
+
WorkflowRequestStringInputRequest(
|
|
532
|
+
name="x",
|
|
508
533
|
value="value",
|
|
509
|
-
)
|
|
534
|
+
),
|
|
510
535
|
],
|
|
511
536
|
)
|
|
512
537
|
|
|
@@ -580,6 +605,142 @@ client.execute_workflow(
|
|
|
580
605
|
<dl>
|
|
581
606
|
<dd>
|
|
582
607
|
|
|
608
|
+
**previous_execution_id:** `typing.Optional[str]` — The ID of a previous Workflow Execution to reference for initial State loading.
|
|
609
|
+
|
|
610
|
+
</dd>
|
|
611
|
+
</dl>
|
|
612
|
+
|
|
613
|
+
<dl>
|
|
614
|
+
<dd>
|
|
615
|
+
|
|
616
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
617
|
+
|
|
618
|
+
</dd>
|
|
619
|
+
</dl>
|
|
620
|
+
</dd>
|
|
621
|
+
</dl>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
</dd>
|
|
625
|
+
</dl>
|
|
626
|
+
</details>
|
|
627
|
+
|
|
628
|
+
<details><summary><code>client.<a href="src/vellum/client.py">execute_workflow_async</a>(...)</code></summary>
|
|
629
|
+
<dl>
|
|
630
|
+
<dd>
|
|
631
|
+
|
|
632
|
+
#### 📝 Description
|
|
633
|
+
|
|
634
|
+
<dl>
|
|
635
|
+
<dd>
|
|
636
|
+
|
|
637
|
+
<dl>
|
|
638
|
+
<dd>
|
|
639
|
+
|
|
640
|
+
Executes a deployed Workflow asynchronously and returns the execution ID.
|
|
641
|
+
</dd>
|
|
642
|
+
</dl>
|
|
643
|
+
</dd>
|
|
644
|
+
</dl>
|
|
645
|
+
|
|
646
|
+
#### 🔌 Usage
|
|
647
|
+
|
|
648
|
+
<dl>
|
|
649
|
+
<dd>
|
|
650
|
+
|
|
651
|
+
<dl>
|
|
652
|
+
<dd>
|
|
653
|
+
|
|
654
|
+
```python
|
|
655
|
+
from vellum import Vellum, WorkflowRequestStringInputRequest
|
|
656
|
+
|
|
657
|
+
client = Vellum(
|
|
658
|
+
api_version="YOUR_API_VERSION",
|
|
659
|
+
api_key="YOUR_API_KEY",
|
|
660
|
+
)
|
|
661
|
+
client.execute_workflow_async(
|
|
662
|
+
inputs=[
|
|
663
|
+
WorkflowRequestStringInputRequest(
|
|
664
|
+
name="x",
|
|
665
|
+
value="value",
|
|
666
|
+
),
|
|
667
|
+
WorkflowRequestStringInputRequest(
|
|
668
|
+
name="x",
|
|
669
|
+
value="value",
|
|
670
|
+
),
|
|
671
|
+
],
|
|
672
|
+
)
|
|
673
|
+
|
|
674
|
+
```
|
|
675
|
+
</dd>
|
|
676
|
+
</dl>
|
|
677
|
+
</dd>
|
|
678
|
+
</dl>
|
|
679
|
+
|
|
680
|
+
#### ⚙️ Parameters
|
|
681
|
+
|
|
682
|
+
<dl>
|
|
683
|
+
<dd>
|
|
684
|
+
|
|
685
|
+
<dl>
|
|
686
|
+
<dd>
|
|
687
|
+
|
|
688
|
+
**inputs:** `typing.Sequence[WorkflowRequestInputRequest]` — The list of inputs defined in the Workflow's Deployment with their corresponding values.
|
|
689
|
+
|
|
690
|
+
</dd>
|
|
691
|
+
</dl>
|
|
692
|
+
|
|
693
|
+
<dl>
|
|
694
|
+
<dd>
|
|
695
|
+
|
|
696
|
+
**workflow_deployment_id:** `typing.Optional[str]` — The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
|
|
697
|
+
|
|
698
|
+
</dd>
|
|
699
|
+
</dl>
|
|
700
|
+
|
|
701
|
+
<dl>
|
|
702
|
+
<dd>
|
|
703
|
+
|
|
704
|
+
**workflow_deployment_name:** `typing.Optional[str]` — The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
|
|
705
|
+
|
|
706
|
+
</dd>
|
|
707
|
+
</dl>
|
|
708
|
+
|
|
709
|
+
<dl>
|
|
710
|
+
<dd>
|
|
711
|
+
|
|
712
|
+
**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
|
|
713
|
+
|
|
714
|
+
</dd>
|
|
715
|
+
</dl>
|
|
716
|
+
|
|
717
|
+
<dl>
|
|
718
|
+
<dd>
|
|
719
|
+
|
|
720
|
+
**external_id:** `typing.Optional[str]` — Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.
|
|
721
|
+
|
|
722
|
+
</dd>
|
|
723
|
+
</dl>
|
|
724
|
+
|
|
725
|
+
<dl>
|
|
726
|
+
<dd>
|
|
727
|
+
|
|
728
|
+
**previous_execution_id:** `typing.Optional[str]` — The ID of a previous Workflow Execution to reference for initial State loading.
|
|
729
|
+
|
|
730
|
+
</dd>
|
|
731
|
+
</dl>
|
|
732
|
+
|
|
733
|
+
<dl>
|
|
734
|
+
<dd>
|
|
735
|
+
|
|
736
|
+
**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
|
|
737
|
+
|
|
738
|
+
</dd>
|
|
739
|
+
</dl>
|
|
740
|
+
|
|
741
|
+
<dl>
|
|
742
|
+
<dd>
|
|
743
|
+
|
|
583
744
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
584
745
|
|
|
585
746
|
</dd>
|
|
@@ -622,17 +783,22 @@ Executes a deployed Workflow and streams back its results.
|
|
|
622
783
|
from vellum import Vellum, WorkflowRequestStringInputRequest
|
|
623
784
|
|
|
624
785
|
client = Vellum(
|
|
786
|
+
api_version="YOUR_API_VERSION",
|
|
625
787
|
api_key="YOUR_API_KEY",
|
|
626
788
|
)
|
|
627
789
|
response = client.execute_workflow_stream(
|
|
628
790
|
inputs=[
|
|
629
791
|
WorkflowRequestStringInputRequest(
|
|
630
|
-
name="
|
|
792
|
+
name="x",
|
|
793
|
+
value="value",
|
|
794
|
+
),
|
|
795
|
+
WorkflowRequestStringInputRequest(
|
|
796
|
+
name="x",
|
|
631
797
|
value="value",
|
|
632
|
-
)
|
|
798
|
+
),
|
|
633
799
|
],
|
|
634
800
|
)
|
|
635
|
-
for chunk in response:
|
|
801
|
+
for chunk in response.data:
|
|
636
802
|
yield chunk
|
|
637
803
|
|
|
638
804
|
```
|
|
@@ -713,6 +879,14 @@ for chunk in response:
|
|
|
713
879
|
<dl>
|
|
714
880
|
<dd>
|
|
715
881
|
|
|
882
|
+
**previous_execution_id:** `typing.Optional[str]` — The ID of a previous Workflow Execution to reference for initial State loading.
|
|
883
|
+
|
|
884
|
+
</dd>
|
|
885
|
+
</dl>
|
|
886
|
+
|
|
887
|
+
<dl>
|
|
888
|
+
<dd>
|
|
889
|
+
|
|
716
890
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
717
891
|
|
|
718
892
|
</dd>
|
|
@@ -758,13 +932,17 @@ Important: This endpoint is DEPRECATED and has been superseded by
|
|
|
758
932
|
from vellum import GenerateRequest, Vellum
|
|
759
933
|
|
|
760
934
|
client = Vellum(
|
|
935
|
+
api_version="YOUR_API_VERSION",
|
|
761
936
|
api_key="YOUR_API_KEY",
|
|
762
937
|
)
|
|
763
938
|
client.generate(
|
|
764
939
|
requests=[
|
|
765
940
|
GenerateRequest(
|
|
766
|
-
input_values={"key": "value"},
|
|
767
|
-
)
|
|
941
|
+
input_values={"input_values": {"key": "value"}},
|
|
942
|
+
),
|
|
943
|
+
GenerateRequest(
|
|
944
|
+
input_values={"input_values": {"key": "value"}},
|
|
945
|
+
),
|
|
768
946
|
],
|
|
769
947
|
)
|
|
770
948
|
|
|
@@ -859,16 +1037,20 @@ Important: This endpoint is DEPRECATED and has been superseded by
|
|
|
859
1037
|
from vellum import GenerateRequest, Vellum
|
|
860
1038
|
|
|
861
1039
|
client = Vellum(
|
|
1040
|
+
api_version="YOUR_API_VERSION",
|
|
862
1041
|
api_key="YOUR_API_KEY",
|
|
863
1042
|
)
|
|
864
1043
|
response = client.generate_stream(
|
|
865
1044
|
requests=[
|
|
866
1045
|
GenerateRequest(
|
|
867
|
-
input_values={"key": "value"},
|
|
868
|
-
)
|
|
1046
|
+
input_values={"input_values": {"key": "value"}},
|
|
1047
|
+
),
|
|
1048
|
+
GenerateRequest(
|
|
1049
|
+
input_values={"input_values": {"key": "value"}},
|
|
1050
|
+
),
|
|
869
1051
|
],
|
|
870
1052
|
)
|
|
871
|
-
for chunk in response:
|
|
1053
|
+
for chunk in response.data:
|
|
872
1054
|
yield chunk
|
|
873
1055
|
|
|
874
1056
|
```
|
|
@@ -959,10 +1141,11 @@ Perform a search against a document index.
|
|
|
959
1141
|
from vellum import Vellum
|
|
960
1142
|
|
|
961
1143
|
client = Vellum(
|
|
1144
|
+
api_version="YOUR_API_VERSION",
|
|
962
1145
|
api_key="YOUR_API_KEY",
|
|
963
1146
|
)
|
|
964
1147
|
client.search(
|
|
965
|
-
query="
|
|
1148
|
+
query="x",
|
|
966
1149
|
)
|
|
967
1150
|
|
|
968
1151
|
```
|
|
@@ -1061,10 +1244,11 @@ Used to submit feedback regarding the quality of previously generated completion
|
|
|
1061
1244
|
from vellum import SubmitCompletionActualRequest, Vellum
|
|
1062
1245
|
|
|
1063
1246
|
client = Vellum(
|
|
1247
|
+
api_version="YOUR_API_VERSION",
|
|
1064
1248
|
api_key="YOUR_API_KEY",
|
|
1065
1249
|
)
|
|
1066
1250
|
client.submit_completion_actuals(
|
|
1067
|
-
actuals=[SubmitCompletionActualRequest()],
|
|
1251
|
+
actuals=[SubmitCompletionActualRequest(), SubmitCompletionActualRequest()],
|
|
1068
1252
|
)
|
|
1069
1253
|
|
|
1070
1254
|
```
|
|
@@ -1149,10 +1333,14 @@ client.submit_completion_actuals(
|
|
|
1149
1333
|
from vellum import Vellum, WorkflowExecutionActualStringRequest
|
|
1150
1334
|
|
|
1151
1335
|
client = Vellum(
|
|
1336
|
+
api_version="YOUR_API_VERSION",
|
|
1152
1337
|
api_key="YOUR_API_KEY",
|
|
1153
1338
|
)
|
|
1154
1339
|
client.submit_workflow_execution_actuals(
|
|
1155
|
-
actuals=[
|
|
1340
|
+
actuals=[
|
|
1341
|
+
WorkflowExecutionActualStringRequest(),
|
|
1342
|
+
WorkflowExecutionActualStringRequest(),
|
|
1343
|
+
],
|
|
1156
1344
|
)
|
|
1157
1345
|
|
|
1158
1346
|
```
|
|
@@ -1205,8 +1393,8 @@ client.submit_workflow_execution_actuals(
|
|
|
1205
1393
|
</dl>
|
|
1206
1394
|
</details>
|
|
1207
1395
|
|
|
1208
|
-
##
|
|
1209
|
-
<details><summary><code>client.
|
|
1396
|
+
## Integrations
|
|
1397
|
+
<details><summary><code>client.integrations.<a href="src/vellum/resources/integrations/client.py">retrieve_integration_tool_definition</a>(...)</code></summary>
|
|
1210
1398
|
<dl>
|
|
1211
1399
|
<dd>
|
|
1212
1400
|
|
|
@@ -1219,38 +1407,16 @@ client.submit_workflow_execution_actuals(
|
|
|
1219
1407
|
<dd>
|
|
1220
1408
|
|
|
1221
1409
|
```python
|
|
1222
|
-
from vellum import
|
|
1223
|
-
JinjaPromptBlock,
|
|
1224
|
-
PromptParameters,
|
|
1225
|
-
PromptRequestStringInput,
|
|
1226
|
-
Vellum,
|
|
1227
|
-
VellumVariable,
|
|
1228
|
-
)
|
|
1410
|
+
from vellum import Vellum
|
|
1229
1411
|
|
|
1230
1412
|
client = Vellum(
|
|
1413
|
+
api_version="YOUR_API_VERSION",
|
|
1231
1414
|
api_key="YOUR_API_KEY",
|
|
1232
1415
|
)
|
|
1233
|
-
client.
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
key="key",
|
|
1238
|
-
value="value",
|
|
1239
|
-
)
|
|
1240
|
-
],
|
|
1241
|
-
input_variables=[
|
|
1242
|
-
VellumVariable(
|
|
1243
|
-
id="id",
|
|
1244
|
-
key="key",
|
|
1245
|
-
type="STRING",
|
|
1246
|
-
)
|
|
1247
|
-
],
|
|
1248
|
-
parameters=PromptParameters(),
|
|
1249
|
-
blocks=[
|
|
1250
|
-
JinjaPromptBlock(
|
|
1251
|
-
template="template",
|
|
1252
|
-
)
|
|
1253
|
-
],
|
|
1416
|
+
client.integrations.retrieve_integration_tool_definition(
|
|
1417
|
+
integration_name="integration_name",
|
|
1418
|
+
integration_provider="integration_provider",
|
|
1419
|
+
tool_name="tool_name",
|
|
1254
1420
|
)
|
|
1255
1421
|
|
|
1256
1422
|
```
|
|
@@ -1267,7 +1433,7 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1267
1433
|
<dl>
|
|
1268
1434
|
<dd>
|
|
1269
1435
|
|
|
1270
|
-
**
|
|
1436
|
+
**integration_name:** `str` — The integration name
|
|
1271
1437
|
|
|
1272
1438
|
</dd>
|
|
1273
1439
|
</dl>
|
|
@@ -1275,7 +1441,7 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1275
1441
|
<dl>
|
|
1276
1442
|
<dd>
|
|
1277
1443
|
|
|
1278
|
-
**
|
|
1444
|
+
**integration_provider:** `str` — The integration provider name
|
|
1279
1445
|
|
|
1280
1446
|
</dd>
|
|
1281
1447
|
</dl>
|
|
@@ -1283,7 +1449,7 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1283
1449
|
<dl>
|
|
1284
1450
|
<dd>
|
|
1285
1451
|
|
|
1286
|
-
**
|
|
1452
|
+
**tool_name:** `str` — The tool's unique name, as specified by the integration provider
|
|
1287
1453
|
|
|
1288
1454
|
</dd>
|
|
1289
1455
|
</dl>
|
|
@@ -1291,15 +1457,59 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1291
1457
|
<dl>
|
|
1292
1458
|
<dd>
|
|
1293
1459
|
|
|
1294
|
-
**
|
|
1460
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1295
1461
|
|
|
1296
1462
|
</dd>
|
|
1297
1463
|
</dl>
|
|
1464
|
+
</dd>
|
|
1465
|
+
</dl>
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
</dd>
|
|
1469
|
+
</dl>
|
|
1470
|
+
</details>
|
|
1298
1471
|
|
|
1472
|
+
<details><summary><code>client.integrations.<a href="src/vellum/resources/integrations/client.py">execute_integration_tool</a>(...)</code></summary>
|
|
1299
1473
|
<dl>
|
|
1300
1474
|
<dd>
|
|
1301
1475
|
|
|
1302
|
-
|
|
1476
|
+
#### 🔌 Usage
|
|
1477
|
+
|
|
1478
|
+
<dl>
|
|
1479
|
+
<dd>
|
|
1480
|
+
|
|
1481
|
+
<dl>
|
|
1482
|
+
<dd>
|
|
1483
|
+
|
|
1484
|
+
```python
|
|
1485
|
+
from vellum import Vellum
|
|
1486
|
+
|
|
1487
|
+
client = Vellum(
|
|
1488
|
+
api_version="YOUR_API_VERSION",
|
|
1489
|
+
api_key="YOUR_API_KEY",
|
|
1490
|
+
)
|
|
1491
|
+
client.integrations.execute_integration_tool(
|
|
1492
|
+
integration_name="integration_name",
|
|
1493
|
+
integration_provider="integration_provider",
|
|
1494
|
+
tool_name="tool_name",
|
|
1495
|
+
arguments={"arguments": {"key": "value"}},
|
|
1496
|
+
)
|
|
1497
|
+
|
|
1498
|
+
```
|
|
1499
|
+
</dd>
|
|
1500
|
+
</dl>
|
|
1501
|
+
</dd>
|
|
1502
|
+
</dl>
|
|
1503
|
+
|
|
1504
|
+
#### ⚙️ Parameters
|
|
1505
|
+
|
|
1506
|
+
<dl>
|
|
1507
|
+
<dd>
|
|
1508
|
+
|
|
1509
|
+
<dl>
|
|
1510
|
+
<dd>
|
|
1511
|
+
|
|
1512
|
+
**integration_name:** `str` — The integration name
|
|
1303
1513
|
|
|
1304
1514
|
</dd>
|
|
1305
1515
|
</dl>
|
|
@@ -1307,7 +1517,7 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1307
1517
|
<dl>
|
|
1308
1518
|
<dd>
|
|
1309
1519
|
|
|
1310
|
-
**
|
|
1520
|
+
**integration_provider:** `str` — The integration provider name
|
|
1311
1521
|
|
|
1312
1522
|
</dd>
|
|
1313
1523
|
</dl>
|
|
@@ -1315,7 +1525,7 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1315
1525
|
<dl>
|
|
1316
1526
|
<dd>
|
|
1317
1527
|
|
|
1318
|
-
**
|
|
1528
|
+
**tool_name:** `str` — The tool's unique name, as specified by the integration provider
|
|
1319
1529
|
|
|
1320
1530
|
</dd>
|
|
1321
1531
|
</dl>
|
|
@@ -1323,7 +1533,7 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1323
1533
|
<dl>
|
|
1324
1534
|
<dd>
|
|
1325
1535
|
|
|
1326
|
-
**
|
|
1536
|
+
**arguments:** `typing.Dict[str, typing.Optional[typing.Any]]`
|
|
1327
1537
|
|
|
1328
1538
|
</dd>
|
|
1329
1539
|
</dl>
|
|
@@ -1343,7 +1553,300 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1343
1553
|
</dl>
|
|
1344
1554
|
</details>
|
|
1345
1555
|
|
|
1346
|
-
<details><summary><code>client.
|
|
1556
|
+
<details><summary><code>client.integrations.<a href="src/vellum/resources/integrations/client.py">list</a>(...)</code></summary>
|
|
1557
|
+
<dl>
|
|
1558
|
+
<dd>
|
|
1559
|
+
|
|
1560
|
+
#### 📝 Description
|
|
1561
|
+
|
|
1562
|
+
<dl>
|
|
1563
|
+
<dd>
|
|
1564
|
+
|
|
1565
|
+
<dl>
|
|
1566
|
+
<dd>
|
|
1567
|
+
|
|
1568
|
+
List all integrations
|
|
1569
|
+
</dd>
|
|
1570
|
+
</dl>
|
|
1571
|
+
</dd>
|
|
1572
|
+
</dl>
|
|
1573
|
+
|
|
1574
|
+
#### 🔌 Usage
|
|
1575
|
+
|
|
1576
|
+
<dl>
|
|
1577
|
+
<dd>
|
|
1578
|
+
|
|
1579
|
+
<dl>
|
|
1580
|
+
<dd>
|
|
1581
|
+
|
|
1582
|
+
```python
|
|
1583
|
+
from vellum import Vellum
|
|
1584
|
+
|
|
1585
|
+
client = Vellum(
|
|
1586
|
+
api_version="YOUR_API_VERSION",
|
|
1587
|
+
api_key="YOUR_API_KEY",
|
|
1588
|
+
)
|
|
1589
|
+
client.integrations.list()
|
|
1590
|
+
|
|
1591
|
+
```
|
|
1592
|
+
</dd>
|
|
1593
|
+
</dl>
|
|
1594
|
+
</dd>
|
|
1595
|
+
</dl>
|
|
1596
|
+
|
|
1597
|
+
#### ⚙️ Parameters
|
|
1598
|
+
|
|
1599
|
+
<dl>
|
|
1600
|
+
<dd>
|
|
1601
|
+
|
|
1602
|
+
<dl>
|
|
1603
|
+
<dd>
|
|
1604
|
+
|
|
1605
|
+
**integration_provider:** `typing.Optional[typing.Literal["COMPOSIO"]]` — * `COMPOSIO` - Composio
|
|
1606
|
+
|
|
1607
|
+
</dd>
|
|
1608
|
+
</dl>
|
|
1609
|
+
|
|
1610
|
+
<dl>
|
|
1611
|
+
<dd>
|
|
1612
|
+
|
|
1613
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
1614
|
+
|
|
1615
|
+
</dd>
|
|
1616
|
+
</dl>
|
|
1617
|
+
|
|
1618
|
+
<dl>
|
|
1619
|
+
<dd>
|
|
1620
|
+
|
|
1621
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
1622
|
+
|
|
1623
|
+
</dd>
|
|
1624
|
+
</dl>
|
|
1625
|
+
|
|
1626
|
+
<dl>
|
|
1627
|
+
<dd>
|
|
1628
|
+
|
|
1629
|
+
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
1630
|
+
|
|
1631
|
+
</dd>
|
|
1632
|
+
</dl>
|
|
1633
|
+
|
|
1634
|
+
<dl>
|
|
1635
|
+
<dd>
|
|
1636
|
+
|
|
1637
|
+
**search:** `typing.Optional[str]` — A search term.
|
|
1638
|
+
|
|
1639
|
+
</dd>
|
|
1640
|
+
</dl>
|
|
1641
|
+
|
|
1642
|
+
<dl>
|
|
1643
|
+
<dd>
|
|
1644
|
+
|
|
1645
|
+
**supports_integration_triggers:** `typing.Optional[str]`
|
|
1646
|
+
|
|
1647
|
+
</dd>
|
|
1648
|
+
</dl>
|
|
1649
|
+
|
|
1650
|
+
<dl>
|
|
1651
|
+
<dd>
|
|
1652
|
+
|
|
1653
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1654
|
+
|
|
1655
|
+
</dd>
|
|
1656
|
+
</dl>
|
|
1657
|
+
</dd>
|
|
1658
|
+
</dl>
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
</dd>
|
|
1662
|
+
</dl>
|
|
1663
|
+
</details>
|
|
1664
|
+
|
|
1665
|
+
<details><summary><code>client.integrations.<a href="src/vellum/resources/integrations/client.py">retrieve</a>(...)</code></summary>
|
|
1666
|
+
<dl>
|
|
1667
|
+
<dd>
|
|
1668
|
+
|
|
1669
|
+
#### 📝 Description
|
|
1670
|
+
|
|
1671
|
+
<dl>
|
|
1672
|
+
<dd>
|
|
1673
|
+
|
|
1674
|
+
<dl>
|
|
1675
|
+
<dd>
|
|
1676
|
+
|
|
1677
|
+
Retrieve an integration
|
|
1678
|
+
</dd>
|
|
1679
|
+
</dl>
|
|
1680
|
+
</dd>
|
|
1681
|
+
</dl>
|
|
1682
|
+
|
|
1683
|
+
#### 🔌 Usage
|
|
1684
|
+
|
|
1685
|
+
<dl>
|
|
1686
|
+
<dd>
|
|
1687
|
+
|
|
1688
|
+
<dl>
|
|
1689
|
+
<dd>
|
|
1690
|
+
|
|
1691
|
+
```python
|
|
1692
|
+
from vellum import Vellum
|
|
1693
|
+
|
|
1694
|
+
client = Vellum(
|
|
1695
|
+
api_version="YOUR_API_VERSION",
|
|
1696
|
+
api_key="YOUR_API_KEY",
|
|
1697
|
+
)
|
|
1698
|
+
client.integrations.retrieve(
|
|
1699
|
+
id="id",
|
|
1700
|
+
)
|
|
1701
|
+
|
|
1702
|
+
```
|
|
1703
|
+
</dd>
|
|
1704
|
+
</dl>
|
|
1705
|
+
</dd>
|
|
1706
|
+
</dl>
|
|
1707
|
+
|
|
1708
|
+
#### ⚙️ Parameters
|
|
1709
|
+
|
|
1710
|
+
<dl>
|
|
1711
|
+
<dd>
|
|
1712
|
+
|
|
1713
|
+
<dl>
|
|
1714
|
+
<dd>
|
|
1715
|
+
|
|
1716
|
+
**id:** `str` — A UUID string identifying this integration.
|
|
1717
|
+
|
|
1718
|
+
</dd>
|
|
1719
|
+
</dl>
|
|
1720
|
+
|
|
1721
|
+
<dl>
|
|
1722
|
+
<dd>
|
|
1723
|
+
|
|
1724
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1725
|
+
|
|
1726
|
+
</dd>
|
|
1727
|
+
</dl>
|
|
1728
|
+
</dd>
|
|
1729
|
+
</dl>
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
</dd>
|
|
1733
|
+
</dl>
|
|
1734
|
+
</details>
|
|
1735
|
+
|
|
1736
|
+
## Events
|
|
1737
|
+
<details><summary><code>client.events.<a href="src/vellum/resources/events/client.py">create</a>(...)</code></summary>
|
|
1738
|
+
<dl>
|
|
1739
|
+
<dd>
|
|
1740
|
+
|
|
1741
|
+
#### 📝 Description
|
|
1742
|
+
|
|
1743
|
+
<dl>
|
|
1744
|
+
<dd>
|
|
1745
|
+
|
|
1746
|
+
<dl>
|
|
1747
|
+
<dd>
|
|
1748
|
+
|
|
1749
|
+
Accept an event or list of events and publish them to ClickHouse for analytics processing.
|
|
1750
|
+
</dd>
|
|
1751
|
+
</dl>
|
|
1752
|
+
</dd>
|
|
1753
|
+
</dl>
|
|
1754
|
+
|
|
1755
|
+
#### 🔌 Usage
|
|
1756
|
+
|
|
1757
|
+
<dl>
|
|
1758
|
+
<dd>
|
|
1759
|
+
|
|
1760
|
+
<dl>
|
|
1761
|
+
<dd>
|
|
1762
|
+
|
|
1763
|
+
```python
|
|
1764
|
+
import datetime
|
|
1765
|
+
|
|
1766
|
+
from vellum import (
|
|
1767
|
+
NodeExecutionInitiatedBody,
|
|
1768
|
+
NodeExecutionInitiatedEvent,
|
|
1769
|
+
Vellum,
|
|
1770
|
+
VellumCodeResourceDefinition,
|
|
1771
|
+
)
|
|
1772
|
+
|
|
1773
|
+
client = Vellum(
|
|
1774
|
+
api_version="YOUR_API_VERSION",
|
|
1775
|
+
api_key="YOUR_API_KEY",
|
|
1776
|
+
)
|
|
1777
|
+
client.events.create(
|
|
1778
|
+
request=[
|
|
1779
|
+
NodeExecutionInitiatedEvent(
|
|
1780
|
+
body=NodeExecutionInitiatedBody(
|
|
1781
|
+
node_definition=VellumCodeResourceDefinition(
|
|
1782
|
+
name="name",
|
|
1783
|
+
module=["module", "module"],
|
|
1784
|
+
id="id",
|
|
1785
|
+
),
|
|
1786
|
+
inputs={"inputs": {"key": "value"}},
|
|
1787
|
+
),
|
|
1788
|
+
id="id",
|
|
1789
|
+
timestamp=datetime.datetime.fromisoformat(
|
|
1790
|
+
"2024-01-15 09:30:00+00:00",
|
|
1791
|
+
),
|
|
1792
|
+
trace_id="trace_id",
|
|
1793
|
+
span_id="span_id",
|
|
1794
|
+
),
|
|
1795
|
+
NodeExecutionInitiatedEvent(
|
|
1796
|
+
body=NodeExecutionInitiatedBody(
|
|
1797
|
+
node_definition=VellumCodeResourceDefinition(
|
|
1798
|
+
name="name",
|
|
1799
|
+
module=["module", "module"],
|
|
1800
|
+
id="id",
|
|
1801
|
+
),
|
|
1802
|
+
inputs={"inputs": {"key": "value"}},
|
|
1803
|
+
),
|
|
1804
|
+
id="id",
|
|
1805
|
+
timestamp=datetime.datetime.fromisoformat(
|
|
1806
|
+
"2024-01-15 09:30:00+00:00",
|
|
1807
|
+
),
|
|
1808
|
+
trace_id="trace_id",
|
|
1809
|
+
span_id="span_id",
|
|
1810
|
+
),
|
|
1811
|
+
],
|
|
1812
|
+
)
|
|
1813
|
+
|
|
1814
|
+
```
|
|
1815
|
+
</dd>
|
|
1816
|
+
</dl>
|
|
1817
|
+
</dd>
|
|
1818
|
+
</dl>
|
|
1819
|
+
|
|
1820
|
+
#### ⚙️ Parameters
|
|
1821
|
+
|
|
1822
|
+
<dl>
|
|
1823
|
+
<dd>
|
|
1824
|
+
|
|
1825
|
+
<dl>
|
|
1826
|
+
<dd>
|
|
1827
|
+
|
|
1828
|
+
**request:** `CreateWorkflowEventRequest`
|
|
1829
|
+
|
|
1830
|
+
</dd>
|
|
1831
|
+
</dl>
|
|
1832
|
+
|
|
1833
|
+
<dl>
|
|
1834
|
+
<dd>
|
|
1835
|
+
|
|
1836
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1837
|
+
|
|
1838
|
+
</dd>
|
|
1839
|
+
</dl>
|
|
1840
|
+
</dd>
|
|
1841
|
+
</dl>
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
</dd>
|
|
1845
|
+
</dl>
|
|
1846
|
+
</details>
|
|
1847
|
+
|
|
1848
|
+
## AdHoc
|
|
1849
|
+
<details><summary><code>client.ad_hoc.<a href="src/vellum/resources/ad_hoc/client.py">adhoc_execute_prompt</a>(...)</code></summary>
|
|
1347
1850
|
<dl>
|
|
1348
1851
|
<dd>
|
|
1349
1852
|
|
|
@@ -1359,37 +1862,200 @@ client.ad_hoc.adhoc_execute_prompt(
|
|
|
1359
1862
|
from vellum import (
|
|
1360
1863
|
JinjaPromptBlock,
|
|
1361
1864
|
PromptParameters,
|
|
1362
|
-
|
|
1865
|
+
StringInput,
|
|
1363
1866
|
Vellum,
|
|
1364
1867
|
VellumVariable,
|
|
1365
1868
|
)
|
|
1366
1869
|
|
|
1367
1870
|
client = Vellum(
|
|
1871
|
+
api_version="YOUR_API_VERSION",
|
|
1368
1872
|
api_key="YOUR_API_KEY",
|
|
1369
1873
|
)
|
|
1370
|
-
|
|
1371
|
-
ml_model="
|
|
1874
|
+
client.ad_hoc.adhoc_execute_prompt(
|
|
1875
|
+
ml_model="x",
|
|
1372
1876
|
input_values=[
|
|
1373
|
-
|
|
1374
|
-
|
|
1877
|
+
StringInput(
|
|
1878
|
+
name="x",
|
|
1879
|
+
value="value",
|
|
1880
|
+
),
|
|
1881
|
+
StringInput(
|
|
1882
|
+
name="x",
|
|
1375
1883
|
value="value",
|
|
1376
|
-
)
|
|
1884
|
+
),
|
|
1377
1885
|
],
|
|
1378
1886
|
input_variables=[
|
|
1379
1887
|
VellumVariable(
|
|
1380
|
-
id="
|
|
1888
|
+
id="x",
|
|
1889
|
+
key="key",
|
|
1890
|
+
type="STRING",
|
|
1891
|
+
),
|
|
1892
|
+
VellumVariable(
|
|
1893
|
+
id="x",
|
|
1381
1894
|
key="key",
|
|
1382
1895
|
type="STRING",
|
|
1383
|
-
)
|
|
1896
|
+
),
|
|
1384
1897
|
],
|
|
1385
1898
|
parameters=PromptParameters(),
|
|
1386
1899
|
blocks=[
|
|
1387
1900
|
JinjaPromptBlock(
|
|
1388
1901
|
template="template",
|
|
1389
|
-
)
|
|
1902
|
+
),
|
|
1903
|
+
JinjaPromptBlock(
|
|
1904
|
+
template="template",
|
|
1905
|
+
),
|
|
1390
1906
|
],
|
|
1391
1907
|
)
|
|
1392
|
-
|
|
1908
|
+
|
|
1909
|
+
```
|
|
1910
|
+
</dd>
|
|
1911
|
+
</dl>
|
|
1912
|
+
</dd>
|
|
1913
|
+
</dl>
|
|
1914
|
+
|
|
1915
|
+
#### ⚙️ Parameters
|
|
1916
|
+
|
|
1917
|
+
<dl>
|
|
1918
|
+
<dd>
|
|
1919
|
+
|
|
1920
|
+
<dl>
|
|
1921
|
+
<dd>
|
|
1922
|
+
|
|
1923
|
+
**ml_model:** `str`
|
|
1924
|
+
|
|
1925
|
+
</dd>
|
|
1926
|
+
</dl>
|
|
1927
|
+
|
|
1928
|
+
<dl>
|
|
1929
|
+
<dd>
|
|
1930
|
+
|
|
1931
|
+
**input_values:** `typing.Sequence[DeprecatedPromptRequestInput]`
|
|
1932
|
+
|
|
1933
|
+
</dd>
|
|
1934
|
+
</dl>
|
|
1935
|
+
|
|
1936
|
+
<dl>
|
|
1937
|
+
<dd>
|
|
1938
|
+
|
|
1939
|
+
**input_variables:** `typing.Sequence[VellumVariable]`
|
|
1940
|
+
|
|
1941
|
+
</dd>
|
|
1942
|
+
</dl>
|
|
1943
|
+
|
|
1944
|
+
<dl>
|
|
1945
|
+
<dd>
|
|
1946
|
+
|
|
1947
|
+
**parameters:** `PromptParameters`
|
|
1948
|
+
|
|
1949
|
+
</dd>
|
|
1950
|
+
</dl>
|
|
1951
|
+
|
|
1952
|
+
<dl>
|
|
1953
|
+
<dd>
|
|
1954
|
+
|
|
1955
|
+
**blocks:** `typing.Sequence[PromptBlock]`
|
|
1956
|
+
|
|
1957
|
+
</dd>
|
|
1958
|
+
</dl>
|
|
1959
|
+
|
|
1960
|
+
<dl>
|
|
1961
|
+
<dd>
|
|
1962
|
+
|
|
1963
|
+
**settings:** `typing.Optional[PromptSettings]`
|
|
1964
|
+
|
|
1965
|
+
</dd>
|
|
1966
|
+
</dl>
|
|
1967
|
+
|
|
1968
|
+
<dl>
|
|
1969
|
+
<dd>
|
|
1970
|
+
|
|
1971
|
+
**functions:** `typing.Optional[typing.Sequence[FunctionDefinition]]`
|
|
1972
|
+
|
|
1973
|
+
</dd>
|
|
1974
|
+
</dl>
|
|
1975
|
+
|
|
1976
|
+
<dl>
|
|
1977
|
+
<dd>
|
|
1978
|
+
|
|
1979
|
+
**expand_meta:** `typing.Optional[AdHocExpandMeta]`
|
|
1980
|
+
|
|
1981
|
+
</dd>
|
|
1982
|
+
</dl>
|
|
1983
|
+
|
|
1984
|
+
<dl>
|
|
1985
|
+
<dd>
|
|
1986
|
+
|
|
1987
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1988
|
+
|
|
1989
|
+
</dd>
|
|
1990
|
+
</dl>
|
|
1991
|
+
</dd>
|
|
1992
|
+
</dl>
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
</dd>
|
|
1996
|
+
</dl>
|
|
1997
|
+
</details>
|
|
1998
|
+
|
|
1999
|
+
<details><summary><code>client.ad_hoc.<a href="src/vellum/resources/ad_hoc/client.py">adhoc_execute_prompt_stream</a>(...)</code></summary>
|
|
2000
|
+
<dl>
|
|
2001
|
+
<dd>
|
|
2002
|
+
|
|
2003
|
+
#### 🔌 Usage
|
|
2004
|
+
|
|
2005
|
+
<dl>
|
|
2006
|
+
<dd>
|
|
2007
|
+
|
|
2008
|
+
<dl>
|
|
2009
|
+
<dd>
|
|
2010
|
+
|
|
2011
|
+
```python
|
|
2012
|
+
from vellum import (
|
|
2013
|
+
JinjaPromptBlock,
|
|
2014
|
+
PromptParameters,
|
|
2015
|
+
StringInput,
|
|
2016
|
+
Vellum,
|
|
2017
|
+
VellumVariable,
|
|
2018
|
+
)
|
|
2019
|
+
|
|
2020
|
+
client = Vellum(
|
|
2021
|
+
api_version="YOUR_API_VERSION",
|
|
2022
|
+
api_key="YOUR_API_KEY",
|
|
2023
|
+
)
|
|
2024
|
+
response = client.ad_hoc.adhoc_execute_prompt_stream(
|
|
2025
|
+
ml_model="x",
|
|
2026
|
+
input_values=[
|
|
2027
|
+
StringInput(
|
|
2028
|
+
name="x",
|
|
2029
|
+
value="value",
|
|
2030
|
+
),
|
|
2031
|
+
StringInput(
|
|
2032
|
+
name="x",
|
|
2033
|
+
value="value",
|
|
2034
|
+
),
|
|
2035
|
+
],
|
|
2036
|
+
input_variables=[
|
|
2037
|
+
VellumVariable(
|
|
2038
|
+
id="x",
|
|
2039
|
+
key="key",
|
|
2040
|
+
type="STRING",
|
|
2041
|
+
),
|
|
2042
|
+
VellumVariable(
|
|
2043
|
+
id="x",
|
|
2044
|
+
key="key",
|
|
2045
|
+
type="STRING",
|
|
2046
|
+
),
|
|
2047
|
+
],
|
|
2048
|
+
parameters=PromptParameters(),
|
|
2049
|
+
blocks=[
|
|
2050
|
+
JinjaPromptBlock(
|
|
2051
|
+
template="template",
|
|
2052
|
+
),
|
|
2053
|
+
JinjaPromptBlock(
|
|
2054
|
+
template="template",
|
|
2055
|
+
),
|
|
2056
|
+
],
|
|
2057
|
+
)
|
|
2058
|
+
for chunk in response.data:
|
|
1393
2059
|
yield chunk
|
|
1394
2060
|
|
|
1395
2061
|
```
|
|
@@ -1406,39 +2072,326 @@ for chunk in response:
|
|
|
1406
2072
|
<dl>
|
|
1407
2073
|
<dd>
|
|
1408
2074
|
|
|
1409
|
-
**ml_model:** `str`
|
|
2075
|
+
**ml_model:** `str`
|
|
2076
|
+
|
|
2077
|
+
</dd>
|
|
2078
|
+
</dl>
|
|
2079
|
+
|
|
2080
|
+
<dl>
|
|
2081
|
+
<dd>
|
|
2082
|
+
|
|
2083
|
+
**input_values:** `typing.Sequence[DeprecatedPromptRequestInput]`
|
|
2084
|
+
|
|
2085
|
+
</dd>
|
|
2086
|
+
</dl>
|
|
2087
|
+
|
|
2088
|
+
<dl>
|
|
2089
|
+
<dd>
|
|
2090
|
+
|
|
2091
|
+
**input_variables:** `typing.Sequence[VellumVariable]`
|
|
2092
|
+
|
|
2093
|
+
</dd>
|
|
2094
|
+
</dl>
|
|
2095
|
+
|
|
2096
|
+
<dl>
|
|
2097
|
+
<dd>
|
|
2098
|
+
|
|
2099
|
+
**parameters:** `PromptParameters`
|
|
2100
|
+
|
|
2101
|
+
</dd>
|
|
2102
|
+
</dl>
|
|
2103
|
+
|
|
2104
|
+
<dl>
|
|
2105
|
+
<dd>
|
|
2106
|
+
|
|
2107
|
+
**blocks:** `typing.Sequence[PromptBlock]`
|
|
2108
|
+
|
|
2109
|
+
</dd>
|
|
2110
|
+
</dl>
|
|
2111
|
+
|
|
2112
|
+
<dl>
|
|
2113
|
+
<dd>
|
|
2114
|
+
|
|
2115
|
+
**settings:** `typing.Optional[PromptSettings]`
|
|
2116
|
+
|
|
2117
|
+
</dd>
|
|
2118
|
+
</dl>
|
|
2119
|
+
|
|
2120
|
+
<dl>
|
|
2121
|
+
<dd>
|
|
2122
|
+
|
|
2123
|
+
**functions:** `typing.Optional[typing.Sequence[FunctionDefinition]]`
|
|
2124
|
+
|
|
2125
|
+
</dd>
|
|
2126
|
+
</dl>
|
|
2127
|
+
|
|
2128
|
+
<dl>
|
|
2129
|
+
<dd>
|
|
2130
|
+
|
|
2131
|
+
**expand_meta:** `typing.Optional[AdHocExpandMeta]`
|
|
2132
|
+
|
|
2133
|
+
</dd>
|
|
2134
|
+
</dl>
|
|
2135
|
+
|
|
2136
|
+
<dl>
|
|
2137
|
+
<dd>
|
|
2138
|
+
|
|
2139
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2140
|
+
|
|
2141
|
+
</dd>
|
|
2142
|
+
</dl>
|
|
2143
|
+
</dd>
|
|
2144
|
+
</dl>
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
</dd>
|
|
2148
|
+
</dl>
|
|
2149
|
+
</details>
|
|
2150
|
+
|
|
2151
|
+
## ContainerImages
|
|
2152
|
+
<details><summary><code>client.container_images.<a href="src/vellum/resources/container_images/client.py">list</a>(...)</code></summary>
|
|
2153
|
+
<dl>
|
|
2154
|
+
<dd>
|
|
2155
|
+
|
|
2156
|
+
#### 📝 Description
|
|
2157
|
+
|
|
2158
|
+
<dl>
|
|
2159
|
+
<dd>
|
|
2160
|
+
|
|
2161
|
+
<dl>
|
|
2162
|
+
<dd>
|
|
2163
|
+
|
|
2164
|
+
Retrieve a list of container images for the organization.
|
|
2165
|
+
</dd>
|
|
2166
|
+
</dl>
|
|
2167
|
+
</dd>
|
|
2168
|
+
</dl>
|
|
2169
|
+
|
|
2170
|
+
#### 🔌 Usage
|
|
2171
|
+
|
|
2172
|
+
<dl>
|
|
2173
|
+
<dd>
|
|
2174
|
+
|
|
2175
|
+
<dl>
|
|
2176
|
+
<dd>
|
|
2177
|
+
|
|
2178
|
+
```python
|
|
2179
|
+
from vellum import Vellum
|
|
2180
|
+
|
|
2181
|
+
client = Vellum(
|
|
2182
|
+
api_version="YOUR_API_VERSION",
|
|
2183
|
+
api_key="YOUR_API_KEY",
|
|
2184
|
+
)
|
|
2185
|
+
client.container_images.list()
|
|
2186
|
+
|
|
2187
|
+
```
|
|
2188
|
+
</dd>
|
|
2189
|
+
</dl>
|
|
2190
|
+
</dd>
|
|
2191
|
+
</dl>
|
|
2192
|
+
|
|
2193
|
+
#### ⚙️ Parameters
|
|
2194
|
+
|
|
2195
|
+
<dl>
|
|
2196
|
+
<dd>
|
|
2197
|
+
|
|
2198
|
+
<dl>
|
|
2199
|
+
<dd>
|
|
2200
|
+
|
|
2201
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
2202
|
+
|
|
2203
|
+
</dd>
|
|
2204
|
+
</dl>
|
|
2205
|
+
|
|
2206
|
+
<dl>
|
|
2207
|
+
<dd>
|
|
2208
|
+
|
|
2209
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
2210
|
+
|
|
2211
|
+
</dd>
|
|
2212
|
+
</dl>
|
|
2213
|
+
|
|
2214
|
+
<dl>
|
|
2215
|
+
<dd>
|
|
2216
|
+
|
|
2217
|
+
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
2218
|
+
|
|
2219
|
+
</dd>
|
|
2220
|
+
</dl>
|
|
2221
|
+
|
|
2222
|
+
<dl>
|
|
2223
|
+
<dd>
|
|
2224
|
+
|
|
2225
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2226
|
+
|
|
2227
|
+
</dd>
|
|
2228
|
+
</dl>
|
|
2229
|
+
</dd>
|
|
2230
|
+
</dl>
|
|
2231
|
+
|
|
2232
|
+
|
|
2233
|
+
</dd>
|
|
2234
|
+
</dl>
|
|
2235
|
+
</details>
|
|
2236
|
+
|
|
2237
|
+
<details><summary><code>client.container_images.<a href="src/vellum/resources/container_images/client.py">retrieve</a>(...)</code></summary>
|
|
2238
|
+
<dl>
|
|
2239
|
+
<dd>
|
|
2240
|
+
|
|
2241
|
+
#### 📝 Description
|
|
2242
|
+
|
|
2243
|
+
<dl>
|
|
2244
|
+
<dd>
|
|
2245
|
+
|
|
2246
|
+
<dl>
|
|
2247
|
+
<dd>
|
|
2248
|
+
|
|
2249
|
+
Retrieve a Container Image by its ID or name.
|
|
2250
|
+
</dd>
|
|
2251
|
+
</dl>
|
|
2252
|
+
</dd>
|
|
2253
|
+
</dl>
|
|
2254
|
+
|
|
2255
|
+
#### 🔌 Usage
|
|
2256
|
+
|
|
2257
|
+
<dl>
|
|
2258
|
+
<dd>
|
|
2259
|
+
|
|
2260
|
+
<dl>
|
|
2261
|
+
<dd>
|
|
2262
|
+
|
|
2263
|
+
```python
|
|
2264
|
+
from vellum import Vellum
|
|
2265
|
+
|
|
2266
|
+
client = Vellum(
|
|
2267
|
+
api_version="YOUR_API_VERSION",
|
|
2268
|
+
api_key="YOUR_API_KEY",
|
|
2269
|
+
)
|
|
2270
|
+
client.container_images.retrieve(
|
|
2271
|
+
id="id",
|
|
2272
|
+
)
|
|
2273
|
+
|
|
2274
|
+
```
|
|
2275
|
+
</dd>
|
|
2276
|
+
</dl>
|
|
2277
|
+
</dd>
|
|
2278
|
+
</dl>
|
|
2279
|
+
|
|
2280
|
+
#### ⚙️ Parameters
|
|
2281
|
+
|
|
2282
|
+
<dl>
|
|
2283
|
+
<dd>
|
|
2284
|
+
|
|
2285
|
+
<dl>
|
|
2286
|
+
<dd>
|
|
2287
|
+
|
|
2288
|
+
**id:** `str` — Either the Container Image's ID or its unique name
|
|
2289
|
+
|
|
2290
|
+
</dd>
|
|
2291
|
+
</dl>
|
|
2292
|
+
|
|
2293
|
+
<dl>
|
|
2294
|
+
<dd>
|
|
2295
|
+
|
|
2296
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
2297
|
+
|
|
2298
|
+
</dd>
|
|
2299
|
+
</dl>
|
|
2300
|
+
</dd>
|
|
2301
|
+
</dl>
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
</dd>
|
|
2305
|
+
</dl>
|
|
2306
|
+
</details>
|
|
2307
|
+
|
|
2308
|
+
<details><summary><code>client.container_images.<a href="src/vellum/resources/container_images/client.py">docker_service_token</a>()</code></summary>
|
|
2309
|
+
<dl>
|
|
2310
|
+
<dd>
|
|
2311
|
+
|
|
2312
|
+
#### 🔌 Usage
|
|
2313
|
+
|
|
2314
|
+
<dl>
|
|
2315
|
+
<dd>
|
|
2316
|
+
|
|
2317
|
+
<dl>
|
|
2318
|
+
<dd>
|
|
2319
|
+
|
|
2320
|
+
```python
|
|
2321
|
+
from vellum import Vellum
|
|
2322
|
+
|
|
2323
|
+
client = Vellum(
|
|
2324
|
+
api_version="YOUR_API_VERSION",
|
|
2325
|
+
api_key="YOUR_API_KEY",
|
|
2326
|
+
)
|
|
2327
|
+
client.container_images.docker_service_token()
|
|
2328
|
+
|
|
2329
|
+
```
|
|
2330
|
+
</dd>
|
|
2331
|
+
</dl>
|
|
2332
|
+
</dd>
|
|
2333
|
+
</dl>
|
|
2334
|
+
|
|
2335
|
+
#### ⚙️ Parameters
|
|
2336
|
+
|
|
2337
|
+
<dl>
|
|
2338
|
+
<dd>
|
|
2339
|
+
|
|
2340
|
+
<dl>
|
|
2341
|
+
<dd>
|
|
2342
|
+
|
|
2343
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1410
2344
|
|
|
1411
2345
|
</dd>
|
|
1412
2346
|
</dl>
|
|
2347
|
+
</dd>
|
|
2348
|
+
</dl>
|
|
1413
2349
|
|
|
1414
|
-
<dl>
|
|
1415
|
-
<dd>
|
|
1416
2350
|
|
|
1417
|
-
**input_values:** `typing.Sequence[PromptRequestInput]`
|
|
1418
|
-
|
|
1419
2351
|
</dd>
|
|
1420
2352
|
</dl>
|
|
2353
|
+
</details>
|
|
1421
2354
|
|
|
2355
|
+
<details><summary><code>client.container_images.<a href="src/vellum/resources/container_images/client.py">push_container_image</a>(...)</code></summary>
|
|
1422
2356
|
<dl>
|
|
1423
2357
|
<dd>
|
|
1424
2358
|
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
</dd>
|
|
1428
|
-
</dl>
|
|
2359
|
+
#### 🔌 Usage
|
|
1429
2360
|
|
|
1430
2361
|
<dl>
|
|
1431
2362
|
<dd>
|
|
1432
2363
|
|
|
1433
|
-
|
|
1434
|
-
|
|
2364
|
+
<dl>
|
|
2365
|
+
<dd>
|
|
2366
|
+
|
|
2367
|
+
```python
|
|
2368
|
+
from vellum import Vellum
|
|
2369
|
+
|
|
2370
|
+
client = Vellum(
|
|
2371
|
+
api_version="YOUR_API_VERSION",
|
|
2372
|
+
api_key="YOUR_API_KEY",
|
|
2373
|
+
)
|
|
2374
|
+
client.container_images.push_container_image(
|
|
2375
|
+
name="x",
|
|
2376
|
+
sha="x",
|
|
2377
|
+
tags=["tags", "tags"],
|
|
2378
|
+
)
|
|
2379
|
+
|
|
2380
|
+
```
|
|
2381
|
+
</dd>
|
|
2382
|
+
</dl>
|
|
1435
2383
|
</dd>
|
|
1436
2384
|
</dl>
|
|
1437
2385
|
|
|
2386
|
+
#### ⚙️ Parameters
|
|
2387
|
+
|
|
1438
2388
|
<dl>
|
|
1439
2389
|
<dd>
|
|
1440
2390
|
|
|
1441
|
-
|
|
2391
|
+
<dl>
|
|
2392
|
+
<dd>
|
|
2393
|
+
|
|
2394
|
+
**name:** `str`
|
|
1442
2395
|
|
|
1443
2396
|
</dd>
|
|
1444
2397
|
</dl>
|
|
@@ -1446,7 +2399,7 @@ for chunk in response:
|
|
|
1446
2399
|
<dl>
|
|
1447
2400
|
<dd>
|
|
1448
2401
|
|
|
1449
|
-
**
|
|
2402
|
+
**sha:** `str`
|
|
1450
2403
|
|
|
1451
2404
|
</dd>
|
|
1452
2405
|
</dl>
|
|
@@ -1454,7 +2407,7 @@ for chunk in response:
|
|
|
1454
2407
|
<dl>
|
|
1455
2408
|
<dd>
|
|
1456
2409
|
|
|
1457
|
-
**
|
|
2410
|
+
**tags:** `typing.Sequence[str]`
|
|
1458
2411
|
|
|
1459
2412
|
</dd>
|
|
1460
2413
|
</dl>
|
|
@@ -1462,7 +2415,7 @@ for chunk in response:
|
|
|
1462
2415
|
<dl>
|
|
1463
2416
|
<dd>
|
|
1464
2417
|
|
|
1465
|
-
**
|
|
2418
|
+
**force:** `typing.Optional[bool]`
|
|
1466
2419
|
|
|
1467
2420
|
</dd>
|
|
1468
2421
|
</dl>
|
|
@@ -1482,8 +2435,8 @@ for chunk in response:
|
|
|
1482
2435
|
</dl>
|
|
1483
2436
|
</details>
|
|
1484
2437
|
|
|
1485
|
-
##
|
|
1486
|
-
<details><summary><code>client.
|
|
2438
|
+
## Deployments
|
|
2439
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">list</a>(...)</code></summary>
|
|
1487
2440
|
<dl>
|
|
1488
2441
|
<dd>
|
|
1489
2442
|
|
|
@@ -1495,7 +2448,7 @@ for chunk in response:
|
|
|
1495
2448
|
<dl>
|
|
1496
2449
|
<dd>
|
|
1497
2450
|
|
|
1498
|
-
|
|
2451
|
+
Used to list all Prompt Deployments.
|
|
1499
2452
|
</dd>
|
|
1500
2453
|
</dl>
|
|
1501
2454
|
</dd>
|
|
@@ -1513,9 +2466,10 @@ Retrieve a list of container images for the organization.
|
|
|
1513
2466
|
from vellum import Vellum
|
|
1514
2467
|
|
|
1515
2468
|
client = Vellum(
|
|
2469
|
+
api_version="YOUR_API_VERSION",
|
|
1516
2470
|
api_key="YOUR_API_KEY",
|
|
1517
2471
|
)
|
|
1518
|
-
client.
|
|
2472
|
+
client.deployments.list()
|
|
1519
2473
|
|
|
1520
2474
|
```
|
|
1521
2475
|
</dd>
|
|
@@ -1555,6 +2509,14 @@ client.container_images.list()
|
|
|
1555
2509
|
<dl>
|
|
1556
2510
|
<dd>
|
|
1557
2511
|
|
|
2512
|
+
**status:** `typing.Optional[DeploymentsListRequestStatus]` — status
|
|
2513
|
+
|
|
2514
|
+
</dd>
|
|
2515
|
+
</dl>
|
|
2516
|
+
|
|
2517
|
+
<dl>
|
|
2518
|
+
<dd>
|
|
2519
|
+
|
|
1558
2520
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1559
2521
|
|
|
1560
2522
|
</dd>
|
|
@@ -1567,7 +2529,7 @@ client.container_images.list()
|
|
|
1567
2529
|
</dl>
|
|
1568
2530
|
</details>
|
|
1569
2531
|
|
|
1570
|
-
<details><summary><code>client.
|
|
2532
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve</a>(...)</code></summary>
|
|
1571
2533
|
<dl>
|
|
1572
2534
|
<dd>
|
|
1573
2535
|
|
|
@@ -1579,7 +2541,7 @@ client.container_images.list()
|
|
|
1579
2541
|
<dl>
|
|
1580
2542
|
<dd>
|
|
1581
2543
|
|
|
1582
|
-
|
|
2544
|
+
Used to retrieve a Prompt Deployment given its ID or name.
|
|
1583
2545
|
</dd>
|
|
1584
2546
|
</dl>
|
|
1585
2547
|
</dd>
|
|
@@ -1597,9 +2559,10 @@ Retrieve a Container Image by its ID or name.
|
|
|
1597
2559
|
from vellum import Vellum
|
|
1598
2560
|
|
|
1599
2561
|
client = Vellum(
|
|
2562
|
+
api_version="YOUR_API_VERSION",
|
|
1600
2563
|
api_key="YOUR_API_KEY",
|
|
1601
2564
|
)
|
|
1602
|
-
client.
|
|
2565
|
+
client.deployments.retrieve(
|
|
1603
2566
|
id="id",
|
|
1604
2567
|
)
|
|
1605
2568
|
|
|
@@ -1617,7 +2580,7 @@ client.container_images.retrieve(
|
|
|
1617
2580
|
<dl>
|
|
1618
2581
|
<dd>
|
|
1619
2582
|
|
|
1620
|
-
**id:** `str` — Either the
|
|
2583
|
+
**id:** `str` — Either the Prompt Deployment's ID or its unique name
|
|
1621
2584
|
|
|
1622
2585
|
</dd>
|
|
1623
2586
|
</dl>
|
|
@@ -1637,33 +2600,11 @@ client.container_images.retrieve(
|
|
|
1637
2600
|
</dl>
|
|
1638
2601
|
</details>
|
|
1639
2602
|
|
|
1640
|
-
<details><summary><code>client.
|
|
1641
|
-
<dl>
|
|
1642
|
-
<dd>
|
|
1643
|
-
|
|
1644
|
-
#### 🔌 Usage
|
|
1645
|
-
|
|
1646
|
-
<dl>
|
|
1647
|
-
<dd>
|
|
1648
|
-
|
|
2603
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">deployment_history_item_retrieve</a>(...)</code></summary>
|
|
1649
2604
|
<dl>
|
|
1650
2605
|
<dd>
|
|
1651
2606
|
|
|
1652
|
-
|
|
1653
|
-
from vellum import Vellum
|
|
1654
|
-
|
|
1655
|
-
client = Vellum(
|
|
1656
|
-
api_key="YOUR_API_KEY",
|
|
1657
|
-
)
|
|
1658
|
-
client.container_images.docker_service_token()
|
|
1659
|
-
|
|
1660
|
-
```
|
|
1661
|
-
</dd>
|
|
1662
|
-
</dl>
|
|
1663
|
-
</dd>
|
|
1664
|
-
</dl>
|
|
1665
|
-
|
|
1666
|
-
#### ⚙️ Parameters
|
|
2607
|
+
#### 📝 Description
|
|
1667
2608
|
|
|
1668
2609
|
<dl>
|
|
1669
2610
|
<dd>
|
|
@@ -1671,21 +2612,12 @@ client.container_images.docker_service_token()
|
|
|
1671
2612
|
<dl>
|
|
1672
2613
|
<dd>
|
|
1673
2614
|
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
</dd>
|
|
1677
|
-
</dl>
|
|
2615
|
+
DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
|
|
2616
|
+
`retrieve_prompt_deployment_release` xendpoint instead.
|
|
1678
2617
|
</dd>
|
|
1679
2618
|
</dl>
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
2619
|
</dd>
|
|
1683
2620
|
</dl>
|
|
1684
|
-
</details>
|
|
1685
|
-
|
|
1686
|
-
<details><summary><code>client.container_images.<a href="src/vellum/resources/container_images/client.py">push_container_image</a>(...)</code></summary>
|
|
1687
|
-
<dl>
|
|
1688
|
-
<dd>
|
|
1689
2621
|
|
|
1690
2622
|
#### 🔌 Usage
|
|
1691
2623
|
|
|
@@ -1699,12 +2631,12 @@ client.container_images.docker_service_token()
|
|
|
1699
2631
|
from vellum import Vellum
|
|
1700
2632
|
|
|
1701
2633
|
client = Vellum(
|
|
2634
|
+
api_version="YOUR_API_VERSION",
|
|
1702
2635
|
api_key="YOUR_API_KEY",
|
|
1703
2636
|
)
|
|
1704
|
-
client.
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
tags=["tags"],
|
|
2637
|
+
client.deployments.deployment_history_item_retrieve(
|
|
2638
|
+
history_id_or_release_tag="history_id_or_release_tag",
|
|
2639
|
+
id="id",
|
|
1708
2640
|
)
|
|
1709
2641
|
|
|
1710
2642
|
```
|
|
@@ -1721,15 +2653,7 @@ client.container_images.push_container_image(
|
|
|
1721
2653
|
<dl>
|
|
1722
2654
|
<dd>
|
|
1723
2655
|
|
|
1724
|
-
**
|
|
1725
|
-
|
|
1726
|
-
</dd>
|
|
1727
|
-
</dl>
|
|
1728
|
-
|
|
1729
|
-
<dl>
|
|
1730
|
-
<dd>
|
|
1731
|
-
|
|
1732
|
-
**sha:** `str`
|
|
2656
|
+
**history_id_or_release_tag:** `str` — Either the UUID of Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Deployment History Item you'd like to retrieve.
|
|
1733
2657
|
|
|
1734
2658
|
</dd>
|
|
1735
2659
|
</dl>
|
|
@@ -1737,7 +2661,7 @@ client.container_images.push_container_image(
|
|
|
1737
2661
|
<dl>
|
|
1738
2662
|
<dd>
|
|
1739
2663
|
|
|
1740
|
-
**
|
|
2664
|
+
**id:** `str` — Either the Prompt Deployment's ID or its unique name
|
|
1741
2665
|
|
|
1742
2666
|
</dd>
|
|
1743
2667
|
</dl>
|
|
@@ -1757,8 +2681,7 @@ client.container_images.push_container_image(
|
|
|
1757
2681
|
</dl>
|
|
1758
2682
|
</details>
|
|
1759
2683
|
|
|
1760
|
-
|
|
1761
|
-
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">list</a>(...)</code></summary>
|
|
2684
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">list_deployment_release_tags</a>(...)</code></summary>
|
|
1762
2685
|
<dl>
|
|
1763
2686
|
<dd>
|
|
1764
2687
|
|
|
@@ -1770,7 +2693,7 @@ client.container_images.push_container_image(
|
|
|
1770
2693
|
<dl>
|
|
1771
2694
|
<dd>
|
|
1772
2695
|
|
|
1773
|
-
|
|
2696
|
+
List Release Tags associated with the specified Prompt Deployment
|
|
1774
2697
|
</dd>
|
|
1775
2698
|
</dl>
|
|
1776
2699
|
</dd>
|
|
@@ -1788,9 +2711,12 @@ Used to list all Prompt Deployments.
|
|
|
1788
2711
|
from vellum import Vellum
|
|
1789
2712
|
|
|
1790
2713
|
client = Vellum(
|
|
2714
|
+
api_version="YOUR_API_VERSION",
|
|
1791
2715
|
api_key="YOUR_API_KEY",
|
|
1792
2716
|
)
|
|
1793
|
-
client.deployments.
|
|
2717
|
+
client.deployments.list_deployment_release_tags(
|
|
2718
|
+
id="id",
|
|
2719
|
+
)
|
|
1794
2720
|
|
|
1795
2721
|
```
|
|
1796
2722
|
</dd>
|
|
@@ -1806,6 +2732,14 @@ client.deployments.list()
|
|
|
1806
2732
|
<dl>
|
|
1807
2733
|
<dd>
|
|
1808
2734
|
|
|
2735
|
+
**id:** `str` — Either the Prompt Deployment's ID or its unique name
|
|
2736
|
+
|
|
2737
|
+
</dd>
|
|
2738
|
+
</dl>
|
|
2739
|
+
|
|
2740
|
+
<dl>
|
|
2741
|
+
<dd>
|
|
2742
|
+
|
|
1809
2743
|
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
1810
2744
|
|
|
1811
2745
|
</dd>
|
|
@@ -1830,7 +2764,7 @@ client.deployments.list()
|
|
|
1830
2764
|
<dl>
|
|
1831
2765
|
<dd>
|
|
1832
2766
|
|
|
1833
|
-
**
|
|
2767
|
+
**source:** `typing.Optional[ListDeploymentReleaseTagsRequestSource]`
|
|
1834
2768
|
|
|
1835
2769
|
</dd>
|
|
1836
2770
|
</dl>
|
|
@@ -1850,7 +2784,7 @@ client.deployments.list()
|
|
|
1850
2784
|
</dl>
|
|
1851
2785
|
</details>
|
|
1852
2786
|
|
|
1853
|
-
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">
|
|
2787
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_deployment_release_tag</a>(...)</code></summary>
|
|
1854
2788
|
<dl>
|
|
1855
2789
|
<dd>
|
|
1856
2790
|
|
|
@@ -1862,7 +2796,7 @@ client.deployments.list()
|
|
|
1862
2796
|
<dl>
|
|
1863
2797
|
<dd>
|
|
1864
2798
|
|
|
1865
|
-
|
|
2799
|
+
Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment.
|
|
1866
2800
|
</dd>
|
|
1867
2801
|
</dl>
|
|
1868
2802
|
</dd>
|
|
@@ -1880,10 +2814,12 @@ Used to retrieve a Prompt Deployment given its ID or name.
|
|
|
1880
2814
|
from vellum import Vellum
|
|
1881
2815
|
|
|
1882
2816
|
client = Vellum(
|
|
2817
|
+
api_version="YOUR_API_VERSION",
|
|
1883
2818
|
api_key="YOUR_API_KEY",
|
|
1884
2819
|
)
|
|
1885
|
-
client.deployments.
|
|
2820
|
+
client.deployments.retrieve_deployment_release_tag(
|
|
1886
2821
|
id="id",
|
|
2822
|
+
name="name",
|
|
1887
2823
|
)
|
|
1888
2824
|
|
|
1889
2825
|
```
|
|
@@ -1908,6 +2844,14 @@ client.deployments.retrieve(
|
|
|
1908
2844
|
<dl>
|
|
1909
2845
|
<dd>
|
|
1910
2846
|
|
|
2847
|
+
**name:** `str` — The name of the Release Tag associated with this Deployment that you'd like to retrieve.
|
|
2848
|
+
|
|
2849
|
+
</dd>
|
|
2850
|
+
</dl>
|
|
2851
|
+
|
|
2852
|
+
<dl>
|
|
2853
|
+
<dd>
|
|
2854
|
+
|
|
1911
2855
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
1912
2856
|
|
|
1913
2857
|
</dd>
|
|
@@ -1920,7 +2864,7 @@ client.deployments.retrieve(
|
|
|
1920
2864
|
</dl>
|
|
1921
2865
|
</details>
|
|
1922
2866
|
|
|
1923
|
-
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">
|
|
2867
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">update_deployment_release_tag</a>(...)</code></summary>
|
|
1924
2868
|
<dl>
|
|
1925
2869
|
<dd>
|
|
1926
2870
|
|
|
@@ -1932,8 +2876,7 @@ client.deployments.retrieve(
|
|
|
1932
2876
|
<dl>
|
|
1933
2877
|
<dd>
|
|
1934
2878
|
|
|
1935
|
-
|
|
1936
|
-
`retrieve_prompt_deployment_release` xendpoint instead.
|
|
2879
|
+
Updates an existing Release Tag associated with the specified Prompt Deployment.
|
|
1937
2880
|
</dd>
|
|
1938
2881
|
</dl>
|
|
1939
2882
|
</dd>
|
|
@@ -1951,11 +2894,12 @@ DEPRECATED: This endpoint is deprecated and will be removed in a future release.
|
|
|
1951
2894
|
from vellum import Vellum
|
|
1952
2895
|
|
|
1953
2896
|
client = Vellum(
|
|
2897
|
+
api_version="YOUR_API_VERSION",
|
|
1954
2898
|
api_key="YOUR_API_KEY",
|
|
1955
2899
|
)
|
|
1956
|
-
client.deployments.
|
|
1957
|
-
history_id_or_release_tag="history_id_or_release_tag",
|
|
2900
|
+
client.deployments.update_deployment_release_tag(
|
|
1958
2901
|
id="id",
|
|
2902
|
+
name="name",
|
|
1959
2903
|
)
|
|
1960
2904
|
|
|
1961
2905
|
```
|
|
@@ -1972,7 +2916,7 @@ client.deployments.deployment_history_item_retrieve(
|
|
|
1972
2916
|
<dl>
|
|
1973
2917
|
<dd>
|
|
1974
2918
|
|
|
1975
|
-
**
|
|
2919
|
+
**id:** `str` — Either the Prompt Deployment's ID or its unique name
|
|
1976
2920
|
|
|
1977
2921
|
</dd>
|
|
1978
2922
|
</dl>
|
|
@@ -1980,7 +2924,15 @@ client.deployments.deployment_history_item_retrieve(
|
|
|
1980
2924
|
<dl>
|
|
1981
2925
|
<dd>
|
|
1982
2926
|
|
|
1983
|
-
**
|
|
2927
|
+
**name:** `str` — The name of the Release Tag associated with this Deployment that you'd like to update.
|
|
2928
|
+
|
|
2929
|
+
</dd>
|
|
2930
|
+
</dl>
|
|
2931
|
+
|
|
2932
|
+
<dl>
|
|
2933
|
+
<dd>
|
|
2934
|
+
|
|
2935
|
+
**history_item_id:** `typing.Optional[str]` — The ID of the Release to tag
|
|
1984
2936
|
|
|
1985
2937
|
</dd>
|
|
1986
2938
|
</dl>
|
|
@@ -2000,7 +2952,7 @@ client.deployments.deployment_history_item_retrieve(
|
|
|
2000
2952
|
</dl>
|
|
2001
2953
|
</details>
|
|
2002
2954
|
|
|
2003
|
-
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">
|
|
2955
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_prompt_deployment_release</a>(...)</code></summary>
|
|
2004
2956
|
<dl>
|
|
2005
2957
|
<dd>
|
|
2006
2958
|
|
|
@@ -2012,7 +2964,7 @@ client.deployments.deployment_history_item_retrieve(
|
|
|
2012
2964
|
<dl>
|
|
2013
2965
|
<dd>
|
|
2014
2966
|
|
|
2015
|
-
|
|
2967
|
+
Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
|
|
2016
2968
|
</dd>
|
|
2017
2969
|
</dl>
|
|
2018
2970
|
</dd>
|
|
@@ -2030,10 +2982,12 @@ List Release Tags associated with the specified Prompt Deployment
|
|
|
2030
2982
|
from vellum import Vellum
|
|
2031
2983
|
|
|
2032
2984
|
client = Vellum(
|
|
2985
|
+
api_version="YOUR_API_VERSION",
|
|
2033
2986
|
api_key="YOUR_API_KEY",
|
|
2034
2987
|
)
|
|
2035
|
-
client.deployments.
|
|
2988
|
+
client.deployments.retrieve_prompt_deployment_release(
|
|
2036
2989
|
id="id",
|
|
2990
|
+
release_id_or_release_tag="release_id_or_release_tag",
|
|
2037
2991
|
)
|
|
2038
2992
|
|
|
2039
2993
|
```
|
|
@@ -2058,31 +3012,7 @@ client.deployments.list_deployment_release_tags(
|
|
|
2058
3012
|
<dl>
|
|
2059
3013
|
<dd>
|
|
2060
3014
|
|
|
2061
|
-
**
|
|
2062
|
-
|
|
2063
|
-
</dd>
|
|
2064
|
-
</dl>
|
|
2065
|
-
|
|
2066
|
-
<dl>
|
|
2067
|
-
<dd>
|
|
2068
|
-
|
|
2069
|
-
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
2070
|
-
|
|
2071
|
-
</dd>
|
|
2072
|
-
</dl>
|
|
2073
|
-
|
|
2074
|
-
<dl>
|
|
2075
|
-
<dd>
|
|
2076
|
-
|
|
2077
|
-
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
2078
|
-
|
|
2079
|
-
</dd>
|
|
2080
|
-
</dl>
|
|
2081
|
-
|
|
2082
|
-
<dl>
|
|
2083
|
-
<dd>
|
|
2084
|
-
|
|
2085
|
-
**source:** `typing.Optional[ListDeploymentReleaseTagsRequestSource]`
|
|
3015
|
+
**release_id_or_release_tag:** `str` — Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.
|
|
2086
3016
|
|
|
2087
3017
|
</dd>
|
|
2088
3018
|
</dl>
|
|
@@ -2102,7 +3032,7 @@ client.deployments.list_deployment_release_tags(
|
|
|
2102
3032
|
</dl>
|
|
2103
3033
|
</details>
|
|
2104
3034
|
|
|
2105
|
-
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">
|
|
3035
|
+
<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_provider_payload</a>(...)</code></summary>
|
|
2106
3036
|
<dl>
|
|
2107
3037
|
<dd>
|
|
2108
3038
|
|
|
@@ -2114,7 +3044,16 @@ client.deployments.list_deployment_release_tags(
|
|
|
2114
3044
|
<dl>
|
|
2115
3045
|
<dd>
|
|
2116
3046
|
|
|
2117
|
-
|
|
3047
|
+
Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider
|
|
3048
|
+
for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
|
|
3049
|
+
prompt or make an API call to the model provider.
|
|
3050
|
+
|
|
3051
|
+
This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
|
|
3052
|
+
to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
|
|
3053
|
+
that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
|
|
3054
|
+
derive meaning from the response body and instead, should simply pass it directly to the model provider as is.
|
|
3055
|
+
|
|
3056
|
+
We encourage you to seek advise from Vellum Support before integrating with this API for production use.
|
|
2118
3057
|
</dd>
|
|
2119
3058
|
</dl>
|
|
2120
3059
|
</dd>
|
|
@@ -2129,14 +3068,23 @@ Retrieve a Deployment Release Tag by tag name, associated with a specified Deplo
|
|
|
2129
3068
|
<dd>
|
|
2130
3069
|
|
|
2131
3070
|
```python
|
|
2132
|
-
from vellum import Vellum
|
|
3071
|
+
from vellum import StringInputRequest, Vellum
|
|
2133
3072
|
|
|
2134
3073
|
client = Vellum(
|
|
3074
|
+
api_version="YOUR_API_VERSION",
|
|
2135
3075
|
api_key="YOUR_API_KEY",
|
|
2136
3076
|
)
|
|
2137
|
-
client.deployments.
|
|
2138
|
-
|
|
2139
|
-
|
|
3077
|
+
client.deployments.retrieve_provider_payload(
|
|
3078
|
+
inputs=[
|
|
3079
|
+
StringInputRequest(
|
|
3080
|
+
name="x",
|
|
3081
|
+
value="value",
|
|
3082
|
+
),
|
|
3083
|
+
StringInputRequest(
|
|
3084
|
+
name="x",
|
|
3085
|
+
value="value",
|
|
3086
|
+
),
|
|
3087
|
+
],
|
|
2140
3088
|
)
|
|
2141
3089
|
|
|
2142
3090
|
```
|
|
@@ -2153,7 +3101,31 @@ client.deployments.retrieve_deployment_release_tag(
|
|
|
2153
3101
|
<dl>
|
|
2154
3102
|
<dd>
|
|
2155
3103
|
|
|
2156
|
-
**
|
|
3104
|
+
**inputs:** `typing.Sequence[PromptDeploymentInputRequest]` — The list of inputs defined in the Prompt's deployment with their corresponding values.
|
|
3105
|
+
|
|
3106
|
+
</dd>
|
|
3107
|
+
</dl>
|
|
3108
|
+
|
|
3109
|
+
<dl>
|
|
3110
|
+
<dd>
|
|
3111
|
+
|
|
3112
|
+
**deployment_id:** `typing.Optional[str]` — The ID of the deployment. Must provide either this or deployment_name.
|
|
3113
|
+
|
|
3114
|
+
</dd>
|
|
3115
|
+
</dl>
|
|
3116
|
+
|
|
3117
|
+
<dl>
|
|
3118
|
+
<dd>
|
|
3119
|
+
|
|
3120
|
+
**deployment_name:** `typing.Optional[str]` — The name of the deployment. Must provide either this or deployment_id.
|
|
3121
|
+
|
|
3122
|
+
</dd>
|
|
3123
|
+
</dl>
|
|
3124
|
+
|
|
3125
|
+
<dl>
|
|
3126
|
+
<dd>
|
|
3127
|
+
|
|
3128
|
+
**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
|
|
2157
3129
|
|
|
2158
3130
|
</dd>
|
|
2159
3131
|
</dl>
|
|
@@ -2161,7 +3133,7 @@ client.deployments.retrieve_deployment_release_tag(
|
|
|
2161
3133
|
<dl>
|
|
2162
3134
|
<dd>
|
|
2163
3135
|
|
|
2164
|
-
**
|
|
3136
|
+
**expand_meta:** `typing.Optional[CompilePromptDeploymentExpandMetaRequest]`
|
|
2165
3137
|
|
|
2166
3138
|
</dd>
|
|
2167
3139
|
</dl>
|
|
@@ -2181,7 +3153,8 @@ client.deployments.retrieve_deployment_release_tag(
|
|
|
2181
3153
|
</dl>
|
|
2182
3154
|
</details>
|
|
2183
3155
|
|
|
2184
|
-
|
|
3156
|
+
## DocumentIndexes
|
|
3157
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">list</a>(...)</code></summary>
|
|
2185
3158
|
<dl>
|
|
2186
3159
|
<dd>
|
|
2187
3160
|
|
|
@@ -2193,7 +3166,7 @@ client.deployments.retrieve_deployment_release_tag(
|
|
|
2193
3166
|
<dl>
|
|
2194
3167
|
<dd>
|
|
2195
3168
|
|
|
2196
|
-
|
|
3169
|
+
Used to retrieve a list of Document Indexes.
|
|
2197
3170
|
</dd>
|
|
2198
3171
|
</dl>
|
|
2199
3172
|
</dd>
|
|
@@ -2211,12 +3184,10 @@ Updates an existing Release Tag associated with the specified Prompt Deployment.
|
|
|
2211
3184
|
from vellum import Vellum
|
|
2212
3185
|
|
|
2213
3186
|
client = Vellum(
|
|
3187
|
+
api_version="YOUR_API_VERSION",
|
|
2214
3188
|
api_key="YOUR_API_KEY",
|
|
2215
3189
|
)
|
|
2216
|
-
client.
|
|
2217
|
-
id="id",
|
|
2218
|
-
name="name",
|
|
2219
|
-
)
|
|
3190
|
+
client.document_indexes.list()
|
|
2220
3191
|
|
|
2221
3192
|
```
|
|
2222
3193
|
</dd>
|
|
@@ -2232,7 +3203,7 @@ client.deployments.update_deployment_release_tag(
|
|
|
2232
3203
|
<dl>
|
|
2233
3204
|
<dd>
|
|
2234
3205
|
|
|
2235
|
-
**
|
|
3206
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
2236
3207
|
|
|
2237
3208
|
</dd>
|
|
2238
3209
|
</dl>
|
|
@@ -2240,7 +3211,7 @@ client.deployments.update_deployment_release_tag(
|
|
|
2240
3211
|
<dl>
|
|
2241
3212
|
<dd>
|
|
2242
3213
|
|
|
2243
|
-
**
|
|
3214
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
2244
3215
|
|
|
2245
3216
|
</dd>
|
|
2246
3217
|
</dl>
|
|
@@ -2248,7 +3219,28 @@ client.deployments.update_deployment_release_tag(
|
|
|
2248
3219
|
<dl>
|
|
2249
3220
|
<dd>
|
|
2250
3221
|
|
|
2251
|
-
**
|
|
3222
|
+
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
3223
|
+
|
|
3224
|
+
</dd>
|
|
3225
|
+
</dl>
|
|
3226
|
+
|
|
3227
|
+
<dl>
|
|
3228
|
+
<dd>
|
|
3229
|
+
|
|
3230
|
+
**search:** `typing.Optional[str]` — Search for document indices by name or label
|
|
3231
|
+
|
|
3232
|
+
</dd>
|
|
3233
|
+
</dl>
|
|
3234
|
+
|
|
3235
|
+
<dl>
|
|
3236
|
+
<dd>
|
|
3237
|
+
|
|
3238
|
+
**status:** `typing.Optional[DocumentIndexesListRequestStatus]`
|
|
3239
|
+
|
|
3240
|
+
Filter down to only document indices that have a status matching the status specified
|
|
3241
|
+
|
|
3242
|
+
* `ACTIVE` - Active
|
|
3243
|
+
* `ARCHIVED` - Archived
|
|
2252
3244
|
|
|
2253
3245
|
</dd>
|
|
2254
3246
|
</dl>
|
|
@@ -2268,7 +3260,7 @@ client.deployments.update_deployment_release_tag(
|
|
|
2268
3260
|
</dl>
|
|
2269
3261
|
</details>
|
|
2270
3262
|
|
|
2271
|
-
<details><summary><code>client.
|
|
3263
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">create</a>(...)</code></summary>
|
|
2272
3264
|
<dl>
|
|
2273
3265
|
<dd>
|
|
2274
3266
|
|
|
@@ -2280,7 +3272,7 @@ client.deployments.update_deployment_release_tag(
|
|
|
2280
3272
|
<dl>
|
|
2281
3273
|
<dd>
|
|
2282
3274
|
|
|
2283
|
-
|
|
3275
|
+
Creates a new document index.
|
|
2284
3276
|
</dd>
|
|
2285
3277
|
</dl>
|
|
2286
3278
|
</dd>
|
|
@@ -2295,14 +3287,25 @@ Retrieve a specific Prompt Deployment Release by either its UUID or the name of
|
|
|
2295
3287
|
<dd>
|
|
2296
3288
|
|
|
2297
3289
|
```python
|
|
2298
|
-
from vellum import
|
|
3290
|
+
from vellum import (
|
|
3291
|
+
DocumentIndexIndexingConfigRequest,
|
|
3292
|
+
OpenAiVectorizerConfigRequest,
|
|
3293
|
+
OpenAiVectorizerTextEmbedding3SmallRequest,
|
|
3294
|
+
Vellum,
|
|
3295
|
+
)
|
|
2299
3296
|
|
|
2300
3297
|
client = Vellum(
|
|
3298
|
+
api_version="YOUR_API_VERSION",
|
|
2301
3299
|
api_key="YOUR_API_KEY",
|
|
2302
3300
|
)
|
|
2303
|
-
client.
|
|
2304
|
-
|
|
2305
|
-
|
|
3301
|
+
client.document_indexes.create(
|
|
3302
|
+
label="x",
|
|
3303
|
+
name="x",
|
|
3304
|
+
indexing_config=DocumentIndexIndexingConfigRequest(
|
|
3305
|
+
vectorizer=OpenAiVectorizerTextEmbedding3SmallRequest(
|
|
3306
|
+
config=OpenAiVectorizerConfigRequest(),
|
|
3307
|
+
),
|
|
3308
|
+
),
|
|
2306
3309
|
)
|
|
2307
3310
|
|
|
2308
3311
|
```
|
|
@@ -2319,7 +3322,7 @@ client.deployments.retrieve_prompt_deployment_release(
|
|
|
2319
3322
|
<dl>
|
|
2320
3323
|
<dd>
|
|
2321
3324
|
|
|
2322
|
-
**
|
|
3325
|
+
**label:** `str` — A human-readable label for the document index
|
|
2323
3326
|
|
|
2324
3327
|
</dd>
|
|
2325
3328
|
</dl>
|
|
@@ -2327,7 +3330,36 @@ client.deployments.retrieve_prompt_deployment_release(
|
|
|
2327
3330
|
<dl>
|
|
2328
3331
|
<dd>
|
|
2329
3332
|
|
|
2330
|
-
**
|
|
3333
|
+
**name:** `str` — A name that uniquely identifies this index within its workspace
|
|
3334
|
+
|
|
3335
|
+
</dd>
|
|
3336
|
+
</dl>
|
|
3337
|
+
|
|
3338
|
+
<dl>
|
|
3339
|
+
<dd>
|
|
3340
|
+
|
|
3341
|
+
**indexing_config:** `DocumentIndexIndexingConfigRequest`
|
|
3342
|
+
|
|
3343
|
+
</dd>
|
|
3344
|
+
</dl>
|
|
3345
|
+
|
|
3346
|
+
<dl>
|
|
3347
|
+
<dd>
|
|
3348
|
+
|
|
3349
|
+
**status:** `typing.Optional[EntityStatus]`
|
|
3350
|
+
|
|
3351
|
+
The current status of the document index
|
|
3352
|
+
|
|
3353
|
+
* `ACTIVE` - Active
|
|
3354
|
+
* `ARCHIVED` - Archived
|
|
3355
|
+
|
|
3356
|
+
</dd>
|
|
3357
|
+
</dl>
|
|
3358
|
+
|
|
3359
|
+
<dl>
|
|
3360
|
+
<dd>
|
|
3361
|
+
|
|
3362
|
+
**copy_documents_from_index_id:** `typing.Optional[str]` — Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index
|
|
2331
3363
|
|
|
2332
3364
|
</dd>
|
|
2333
3365
|
</dl>
|
|
@@ -2347,7 +3379,7 @@ client.deployments.retrieve_prompt_deployment_release(
|
|
|
2347
3379
|
</dl>
|
|
2348
3380
|
</details>
|
|
2349
3381
|
|
|
2350
|
-
<details><summary><code>client.
|
|
3382
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">retrieve</a>(...)</code></summary>
|
|
2351
3383
|
<dl>
|
|
2352
3384
|
<dd>
|
|
2353
3385
|
|
|
@@ -2359,16 +3391,7 @@ client.deployments.retrieve_prompt_deployment_release(
|
|
|
2359
3391
|
<dl>
|
|
2360
3392
|
<dd>
|
|
2361
3393
|
|
|
2362
|
-
|
|
2363
|
-
for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
|
|
2364
|
-
prompt or make an API call to the model provider.
|
|
2365
|
-
|
|
2366
|
-
This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
|
|
2367
|
-
to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
|
|
2368
|
-
that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
|
|
2369
|
-
derive meaning from the response body and instead, should simply pass it directly to the model provider as is.
|
|
2370
|
-
|
|
2371
|
-
We encourage you to seek advise from Vellum Support before integrating with this API for production use.
|
|
3394
|
+
Used to retrieve a Document Index given its ID or name.
|
|
2372
3395
|
</dd>
|
|
2373
3396
|
</dl>
|
|
2374
3397
|
</dd>
|
|
@@ -2383,18 +3406,14 @@ We encourage you to seek advise from Vellum Support before integrating with this
|
|
|
2383
3406
|
<dd>
|
|
2384
3407
|
|
|
2385
3408
|
```python
|
|
2386
|
-
from vellum import
|
|
3409
|
+
from vellum import Vellum
|
|
2387
3410
|
|
|
2388
3411
|
client = Vellum(
|
|
3412
|
+
api_version="YOUR_API_VERSION",
|
|
2389
3413
|
api_key="YOUR_API_KEY",
|
|
2390
3414
|
)
|
|
2391
|
-
client.
|
|
2392
|
-
|
|
2393
|
-
StringInputRequest(
|
|
2394
|
-
name="name",
|
|
2395
|
-
value="value",
|
|
2396
|
-
)
|
|
2397
|
-
],
|
|
3415
|
+
client.document_indexes.retrieve(
|
|
3416
|
+
id="id",
|
|
2398
3417
|
)
|
|
2399
3418
|
|
|
2400
3419
|
```
|
|
@@ -2411,31 +3430,7 @@ client.deployments.retrieve_provider_payload(
|
|
|
2411
3430
|
<dl>
|
|
2412
3431
|
<dd>
|
|
2413
3432
|
|
|
2414
|
-
**
|
|
2415
|
-
|
|
2416
|
-
</dd>
|
|
2417
|
-
</dl>
|
|
2418
|
-
|
|
2419
|
-
<dl>
|
|
2420
|
-
<dd>
|
|
2421
|
-
|
|
2422
|
-
**deployment_id:** `typing.Optional[str]` — The ID of the deployment. Must provide either this or deployment_name.
|
|
2423
|
-
|
|
2424
|
-
</dd>
|
|
2425
|
-
</dl>
|
|
2426
|
-
|
|
2427
|
-
<dl>
|
|
2428
|
-
<dd>
|
|
2429
|
-
|
|
2430
|
-
**deployment_name:** `typing.Optional[str]` — The name of the deployment. Must provide either this or deployment_id.
|
|
2431
|
-
|
|
2432
|
-
</dd>
|
|
2433
|
-
</dl>
|
|
2434
|
-
|
|
2435
|
-
<dl>
|
|
2436
|
-
<dd>
|
|
2437
|
-
|
|
2438
|
-
**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
|
|
3433
|
+
**id:** `str` — Either the Document Index's ID or its unique name
|
|
2439
3434
|
|
|
2440
3435
|
</dd>
|
|
2441
3436
|
</dl>
|
|
@@ -2443,7 +3438,7 @@ client.deployments.retrieve_provider_payload(
|
|
|
2443
3438
|
<dl>
|
|
2444
3439
|
<dd>
|
|
2445
3440
|
|
|
2446
|
-
**
|
|
3441
|
+
**mask_indexing_config:** `typing.Optional[bool]` — Whether to mask the indexing configuration in the response
|
|
2447
3442
|
|
|
2448
3443
|
</dd>
|
|
2449
3444
|
</dl>
|
|
@@ -2463,8 +3458,7 @@ client.deployments.retrieve_provider_payload(
|
|
|
2463
3458
|
</dl>
|
|
2464
3459
|
</details>
|
|
2465
3460
|
|
|
2466
|
-
|
|
2467
|
-
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">list</a>(...)</code></summary>
|
|
3461
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">update</a>(...)</code></summary>
|
|
2468
3462
|
<dl>
|
|
2469
3463
|
<dd>
|
|
2470
3464
|
|
|
@@ -2476,7 +3470,7 @@ client.deployments.retrieve_provider_payload(
|
|
|
2476
3470
|
<dl>
|
|
2477
3471
|
<dd>
|
|
2478
3472
|
|
|
2479
|
-
Used to
|
|
3473
|
+
Used to fully update a Document Index given its ID or name.
|
|
2480
3474
|
</dd>
|
|
2481
3475
|
</dl>
|
|
2482
3476
|
</dd>
|
|
@@ -2494,9 +3488,13 @@ Used to retrieve a list of Document Indexes.
|
|
|
2494
3488
|
from vellum import Vellum
|
|
2495
3489
|
|
|
2496
3490
|
client = Vellum(
|
|
3491
|
+
api_version="YOUR_API_VERSION",
|
|
2497
3492
|
api_key="YOUR_API_KEY",
|
|
2498
3493
|
)
|
|
2499
|
-
client.document_indexes.
|
|
3494
|
+
client.document_indexes.update(
|
|
3495
|
+
id="id",
|
|
3496
|
+
label="x",
|
|
3497
|
+
)
|
|
2500
3498
|
|
|
2501
3499
|
```
|
|
2502
3500
|
</dd>
|
|
@@ -2512,23 +3510,7 @@ client.document_indexes.list()
|
|
|
2512
3510
|
<dl>
|
|
2513
3511
|
<dd>
|
|
2514
3512
|
|
|
2515
|
-
**
|
|
2516
|
-
|
|
2517
|
-
</dd>
|
|
2518
|
-
</dl>
|
|
2519
|
-
|
|
2520
|
-
<dl>
|
|
2521
|
-
<dd>
|
|
2522
|
-
|
|
2523
|
-
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
2524
|
-
|
|
2525
|
-
</dd>
|
|
2526
|
-
</dl>
|
|
2527
|
-
|
|
2528
|
-
<dl>
|
|
2529
|
-
<dd>
|
|
2530
|
-
|
|
2531
|
-
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
3513
|
+
**id:** `str` — Either the Document Index's ID or its unique name
|
|
2532
3514
|
|
|
2533
3515
|
</dd>
|
|
2534
3516
|
</dl>
|
|
@@ -2536,7 +3518,7 @@ client.document_indexes.list()
|
|
|
2536
3518
|
<dl>
|
|
2537
3519
|
<dd>
|
|
2538
3520
|
|
|
2539
|
-
**
|
|
3521
|
+
**label:** `str` — A human-readable label for the document index
|
|
2540
3522
|
|
|
2541
3523
|
</dd>
|
|
2542
3524
|
</dl>
|
|
@@ -2544,9 +3526,9 @@ client.document_indexes.list()
|
|
|
2544
3526
|
<dl>
|
|
2545
3527
|
<dd>
|
|
2546
3528
|
|
|
2547
|
-
**status:** `typing.Optional[
|
|
3529
|
+
**status:** `typing.Optional[EntityStatus]`
|
|
2548
3530
|
|
|
2549
|
-
|
|
3531
|
+
The current status of the document index
|
|
2550
3532
|
|
|
2551
3533
|
* `ACTIVE` - Active
|
|
2552
3534
|
* `ARCHIVED` - Archived
|
|
@@ -2569,7 +3551,7 @@ Filter down to only document indices that have a status matching the status spec
|
|
|
2569
3551
|
</dl>
|
|
2570
3552
|
</details>
|
|
2571
3553
|
|
|
2572
|
-
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">
|
|
3554
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">destroy</a>(...)</code></summary>
|
|
2573
3555
|
<dl>
|
|
2574
3556
|
<dd>
|
|
2575
3557
|
|
|
@@ -2581,7 +3563,7 @@ Filter down to only document indices that have a status matching the status spec
|
|
|
2581
3563
|
<dl>
|
|
2582
3564
|
<dd>
|
|
2583
3565
|
|
|
2584
|
-
|
|
3566
|
+
Used to delete a Document Index given its ID or name.
|
|
2585
3567
|
</dd>
|
|
2586
3568
|
</dl>
|
|
2587
3569
|
</dd>
|
|
@@ -2596,34 +3578,14 @@ Creates a new document index.
|
|
|
2596
3578
|
<dd>
|
|
2597
3579
|
|
|
2598
3580
|
```python
|
|
2599
|
-
from vellum import
|
|
2600
|
-
DocumentIndexIndexingConfigRequest,
|
|
2601
|
-
OpenAiVectorizerConfigRequest,
|
|
2602
|
-
OpenAiVectorizerTextEmbeddingAda002Request,
|
|
2603
|
-
SentenceChunkerConfigRequest,
|
|
2604
|
-
SentenceChunkingRequest,
|
|
2605
|
-
Vellum,
|
|
2606
|
-
)
|
|
3581
|
+
from vellum import Vellum
|
|
2607
3582
|
|
|
2608
3583
|
client = Vellum(
|
|
3584
|
+
api_version="YOUR_API_VERSION",
|
|
2609
3585
|
api_key="YOUR_API_KEY",
|
|
2610
3586
|
)
|
|
2611
|
-
client.document_indexes.
|
|
2612
|
-
|
|
2613
|
-
name="my-document-index",
|
|
2614
|
-
indexing_config=DocumentIndexIndexingConfigRequest(
|
|
2615
|
-
vectorizer=OpenAiVectorizerTextEmbeddingAda002Request(
|
|
2616
|
-
config=OpenAiVectorizerConfigRequest(
|
|
2617
|
-
add_openai_api_key=True,
|
|
2618
|
-
),
|
|
2619
|
-
),
|
|
2620
|
-
chunking=SentenceChunkingRequest(
|
|
2621
|
-
chunker_config=SentenceChunkerConfigRequest(
|
|
2622
|
-
character_limit=1000,
|
|
2623
|
-
min_overlap_ratio=0.5,
|
|
2624
|
-
),
|
|
2625
|
-
),
|
|
2626
|
-
),
|
|
3587
|
+
client.document_indexes.destroy(
|
|
3588
|
+
id="id",
|
|
2627
3589
|
)
|
|
2628
3590
|
|
|
2629
3591
|
```
|
|
@@ -2640,44 +3602,7 @@ client.document_indexes.create(
|
|
|
2640
3602
|
<dl>
|
|
2641
3603
|
<dd>
|
|
2642
3604
|
|
|
2643
|
-
**
|
|
2644
|
-
|
|
2645
|
-
</dd>
|
|
2646
|
-
</dl>
|
|
2647
|
-
|
|
2648
|
-
<dl>
|
|
2649
|
-
<dd>
|
|
2650
|
-
|
|
2651
|
-
**name:** `str` — A name that uniquely identifies this index within its workspace
|
|
2652
|
-
|
|
2653
|
-
</dd>
|
|
2654
|
-
</dl>
|
|
2655
|
-
|
|
2656
|
-
<dl>
|
|
2657
|
-
<dd>
|
|
2658
|
-
|
|
2659
|
-
**indexing_config:** `DocumentIndexIndexingConfigRequest`
|
|
2660
|
-
|
|
2661
|
-
</dd>
|
|
2662
|
-
</dl>
|
|
2663
|
-
|
|
2664
|
-
<dl>
|
|
2665
|
-
<dd>
|
|
2666
|
-
|
|
2667
|
-
**status:** `typing.Optional[EntityStatus]`
|
|
2668
|
-
|
|
2669
|
-
The current status of the document index
|
|
2670
|
-
|
|
2671
|
-
* `ACTIVE` - Active
|
|
2672
|
-
* `ARCHIVED` - Archived
|
|
2673
|
-
|
|
2674
|
-
</dd>
|
|
2675
|
-
</dl>
|
|
2676
|
-
|
|
2677
|
-
<dl>
|
|
2678
|
-
<dd>
|
|
2679
|
-
|
|
2680
|
-
**copy_documents_from_index_id:** `typing.Optional[str]` — Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index
|
|
3605
|
+
**id:** `str` — Either the Document Index's ID or its unique name
|
|
2681
3606
|
|
|
2682
3607
|
</dd>
|
|
2683
3608
|
</dl>
|
|
@@ -2697,7 +3622,7 @@ The current status of the document index
|
|
|
2697
3622
|
</dl>
|
|
2698
3623
|
</details>
|
|
2699
3624
|
|
|
2700
|
-
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">
|
|
3625
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">partial_update</a>(...)</code></summary>
|
|
2701
3626
|
<dl>
|
|
2702
3627
|
<dd>
|
|
2703
3628
|
|
|
@@ -2709,7 +3634,7 @@ The current status of the document index
|
|
|
2709
3634
|
<dl>
|
|
2710
3635
|
<dd>
|
|
2711
3636
|
|
|
2712
|
-
Used to
|
|
3637
|
+
Used to partial update a Document Index given its ID or name.
|
|
2713
3638
|
</dd>
|
|
2714
3639
|
</dl>
|
|
2715
3640
|
</dd>
|
|
@@ -2727,9 +3652,10 @@ Used to retrieve a Document Index given its ID or name.
|
|
|
2727
3652
|
from vellum import Vellum
|
|
2728
3653
|
|
|
2729
3654
|
client = Vellum(
|
|
3655
|
+
api_version="YOUR_API_VERSION",
|
|
2730
3656
|
api_key="YOUR_API_KEY",
|
|
2731
3657
|
)
|
|
2732
|
-
client.document_indexes.
|
|
3658
|
+
client.document_indexes.partial_update(
|
|
2733
3659
|
id="id",
|
|
2734
3660
|
)
|
|
2735
3661
|
|
|
@@ -2739,15 +3665,36 @@ client.document_indexes.retrieve(
|
|
|
2739
3665
|
</dd>
|
|
2740
3666
|
</dl>
|
|
2741
3667
|
|
|
2742
|
-
#### ⚙️ Parameters
|
|
2743
|
-
|
|
3668
|
+
#### ⚙️ Parameters
|
|
3669
|
+
|
|
3670
|
+
<dl>
|
|
3671
|
+
<dd>
|
|
3672
|
+
|
|
3673
|
+
<dl>
|
|
3674
|
+
<dd>
|
|
3675
|
+
|
|
3676
|
+
**id:** `str` — Either the Document Index's ID or its unique name
|
|
3677
|
+
|
|
3678
|
+
</dd>
|
|
3679
|
+
</dl>
|
|
3680
|
+
|
|
2744
3681
|
<dl>
|
|
2745
3682
|
<dd>
|
|
2746
3683
|
|
|
3684
|
+
**label:** `typing.Optional[str]` — A human-readable label for the document index
|
|
3685
|
+
|
|
3686
|
+
</dd>
|
|
3687
|
+
</dl>
|
|
3688
|
+
|
|
2747
3689
|
<dl>
|
|
2748
3690
|
<dd>
|
|
2749
3691
|
|
|
2750
|
-
**
|
|
3692
|
+
**status:** `typing.Optional[EntityStatus]`
|
|
3693
|
+
|
|
3694
|
+
The current status of the document index
|
|
3695
|
+
|
|
3696
|
+
* `ACTIVE` - Active
|
|
3697
|
+
* `ARCHIVED` - Archived
|
|
2751
3698
|
|
|
2752
3699
|
</dd>
|
|
2753
3700
|
</dl>
|
|
@@ -2767,7 +3714,7 @@ client.document_indexes.retrieve(
|
|
|
2767
3714
|
</dl>
|
|
2768
3715
|
</details>
|
|
2769
3716
|
|
|
2770
|
-
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">
|
|
3717
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">add_document</a>(...)</code></summary>
|
|
2771
3718
|
<dl>
|
|
2772
3719
|
<dd>
|
|
2773
3720
|
|
|
@@ -2779,7 +3726,7 @@ client.document_indexes.retrieve(
|
|
|
2779
3726
|
<dl>
|
|
2780
3727
|
<dd>
|
|
2781
3728
|
|
|
2782
|
-
|
|
3729
|
+
Adds a previously uploaded Document to the specified Document Index.
|
|
2783
3730
|
</dd>
|
|
2784
3731
|
</dl>
|
|
2785
3732
|
</dd>
|
|
@@ -2797,11 +3744,12 @@ Used to fully update a Document Index given its ID or name.
|
|
|
2797
3744
|
from vellum import Vellum
|
|
2798
3745
|
|
|
2799
3746
|
client = Vellum(
|
|
3747
|
+
api_version="YOUR_API_VERSION",
|
|
2800
3748
|
api_key="YOUR_API_KEY",
|
|
2801
3749
|
)
|
|
2802
|
-
client.document_indexes.
|
|
3750
|
+
client.document_indexes.add_document(
|
|
3751
|
+
document_id="document_id",
|
|
2803
3752
|
id="id",
|
|
2804
|
-
label="label",
|
|
2805
3753
|
)
|
|
2806
3754
|
|
|
2807
3755
|
```
|
|
@@ -2818,15 +3766,7 @@ client.document_indexes.update(
|
|
|
2818
3766
|
<dl>
|
|
2819
3767
|
<dd>
|
|
2820
3768
|
|
|
2821
|
-
**
|
|
2822
|
-
|
|
2823
|
-
</dd>
|
|
2824
|
-
</dl>
|
|
2825
|
-
|
|
2826
|
-
<dl>
|
|
2827
|
-
<dd>
|
|
2828
|
-
|
|
2829
|
-
**label:** `str` — A human-readable label for the document index
|
|
3769
|
+
**document_id:** `str` — Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.
|
|
2830
3770
|
|
|
2831
3771
|
</dd>
|
|
2832
3772
|
</dl>
|
|
@@ -2834,12 +3774,7 @@ client.document_indexes.update(
|
|
|
2834
3774
|
<dl>
|
|
2835
3775
|
<dd>
|
|
2836
3776
|
|
|
2837
|
-
**
|
|
2838
|
-
|
|
2839
|
-
The current status of the document index
|
|
2840
|
-
|
|
2841
|
-
* `ACTIVE` - Active
|
|
2842
|
-
* `ARCHIVED` - Archived
|
|
3777
|
+
**id:** `str` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.
|
|
2843
3778
|
|
|
2844
3779
|
</dd>
|
|
2845
3780
|
</dl>
|
|
@@ -2859,7 +3794,7 @@ The current status of the document index
|
|
|
2859
3794
|
</dl>
|
|
2860
3795
|
</details>
|
|
2861
3796
|
|
|
2862
|
-
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">
|
|
3797
|
+
<details><summary><code>client.document_indexes.<a href="src/vellum/resources/document_indexes/client.py">remove_document</a>(...)</code></summary>
|
|
2863
3798
|
<dl>
|
|
2864
3799
|
<dd>
|
|
2865
3800
|
|
|
@@ -2871,7 +3806,7 @@ The current status of the document index
|
|
|
2871
3806
|
<dl>
|
|
2872
3807
|
<dd>
|
|
2873
3808
|
|
|
2874
|
-
|
|
3809
|
+
Removes a Document from a Document Index without deleting the Document itself.
|
|
2875
3810
|
</dd>
|
|
2876
3811
|
</dl>
|
|
2877
3812
|
</dd>
|
|
@@ -2889,9 +3824,11 @@ Used to delete a Document Index given its ID or name.
|
|
|
2889
3824
|
from vellum import Vellum
|
|
2890
3825
|
|
|
2891
3826
|
client = Vellum(
|
|
3827
|
+
api_version="YOUR_API_VERSION",
|
|
2892
3828
|
api_key="YOUR_API_KEY",
|
|
2893
3829
|
)
|
|
2894
|
-
client.document_indexes.
|
|
3830
|
+
client.document_indexes.remove_document(
|
|
3831
|
+
document_id="document_id",
|
|
2895
3832
|
id="id",
|
|
2896
3833
|
)
|
|
2897
3834
|
|
|
@@ -2909,7 +3846,15 @@ client.document_indexes.destroy(
|
|
|
2909
3846
|
<dl>
|
|
2910
3847
|
<dd>
|
|
2911
3848
|
|
|
2912
|
-
**
|
|
3849
|
+
**document_id:** `str` — Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to remove.
|
|
3850
|
+
|
|
3851
|
+
</dd>
|
|
3852
|
+
</dl>
|
|
3853
|
+
|
|
3854
|
+
<dl>
|
|
3855
|
+
<dd>
|
|
3856
|
+
|
|
3857
|
+
**id:** `str` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.
|
|
2913
3858
|
|
|
2914
3859
|
</dd>
|
|
2915
3860
|
</dl>
|
|
@@ -2929,7 +3874,8 @@ client.document_indexes.destroy(
|
|
|
2929
3874
|
</dl>
|
|
2930
3875
|
</details>
|
|
2931
3876
|
|
|
2932
|
-
|
|
3877
|
+
## Documents
|
|
3878
|
+
<details><summary><code>client.documents.<a href="src/vellum/resources/documents/client.py">list</a>(...)</code></summary>
|
|
2933
3879
|
<dl>
|
|
2934
3880
|
<dd>
|
|
2935
3881
|
|
|
@@ -2941,7 +3887,7 @@ client.document_indexes.destroy(
|
|
|
2941
3887
|
<dl>
|
|
2942
3888
|
<dd>
|
|
2943
3889
|
|
|
2944
|
-
Used to
|
|
3890
|
+
Used to list documents. Optionally filter on supported fields.
|
|
2945
3891
|
</dd>
|
|
2946
3892
|
</dl>
|
|
2947
3893
|
</dd>
|
|
@@ -2959,11 +3905,10 @@ Used to partial update a Document Index given its ID or name.
|
|
|
2959
3905
|
from vellum import Vellum
|
|
2960
3906
|
|
|
2961
3907
|
client = Vellum(
|
|
3908
|
+
api_version="YOUR_API_VERSION",
|
|
2962
3909
|
api_key="YOUR_API_KEY",
|
|
2963
3910
|
)
|
|
2964
|
-
client.
|
|
2965
|
-
id="id",
|
|
2966
|
-
)
|
|
3911
|
+
client.documents.list()
|
|
2967
3912
|
|
|
2968
3913
|
```
|
|
2969
3914
|
</dd>
|
|
@@ -2979,7 +3924,7 @@ client.document_indexes.partial_update(
|
|
|
2979
3924
|
<dl>
|
|
2980
3925
|
<dd>
|
|
2981
3926
|
|
|
2982
|
-
**
|
|
3927
|
+
**document_index_id:** `typing.Optional[str]` — Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
|
|
2983
3928
|
|
|
2984
3929
|
</dd>
|
|
2985
3930
|
</dl>
|
|
@@ -2987,7 +3932,7 @@ client.document_indexes.partial_update(
|
|
|
2987
3932
|
<dl>
|
|
2988
3933
|
<dd>
|
|
2989
3934
|
|
|
2990
|
-
**
|
|
3935
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
2991
3936
|
|
|
2992
3937
|
</dd>
|
|
2993
3938
|
</dl>
|
|
@@ -2995,12 +3940,23 @@ client.document_indexes.partial_update(
|
|
|
2995
3940
|
<dl>
|
|
2996
3941
|
<dd>
|
|
2997
3942
|
|
|
2998
|
-
**
|
|
3943
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
3944
|
+
|
|
3945
|
+
</dd>
|
|
3946
|
+
</dl>
|
|
2999
3947
|
|
|
3000
|
-
|
|
3948
|
+
<dl>
|
|
3949
|
+
<dd>
|
|
3001
3950
|
|
|
3002
|
-
|
|
3003
|
-
|
|
3951
|
+
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
3952
|
+
|
|
3953
|
+
</dd>
|
|
3954
|
+
</dl>
|
|
3955
|
+
|
|
3956
|
+
<dl>
|
|
3957
|
+
<dd>
|
|
3958
|
+
|
|
3959
|
+
**search:** `typing.Optional[str]` — A search term.
|
|
3004
3960
|
|
|
3005
3961
|
</dd>
|
|
3006
3962
|
</dl>
|
|
@@ -3020,7 +3976,7 @@ The current status of the document index
|
|
|
3020
3976
|
</dl>
|
|
3021
3977
|
</details>
|
|
3022
3978
|
|
|
3023
|
-
<details><summary><code>client.
|
|
3979
|
+
<details><summary><code>client.documents.<a href="src/vellum/resources/documents/client.py">retrieve</a>(...)</code></summary>
|
|
3024
3980
|
<dl>
|
|
3025
3981
|
<dd>
|
|
3026
3982
|
|
|
@@ -3032,7 +3988,7 @@ The current status of the document index
|
|
|
3032
3988
|
<dl>
|
|
3033
3989
|
<dd>
|
|
3034
3990
|
|
|
3035
|
-
|
|
3991
|
+
Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.
|
|
3036
3992
|
</dd>
|
|
3037
3993
|
</dl>
|
|
3038
3994
|
</dd>
|
|
@@ -3050,10 +4006,10 @@ Adds a previously uploaded Document to the specified Document Index.
|
|
|
3050
4006
|
from vellum import Vellum
|
|
3051
4007
|
|
|
3052
4008
|
client = Vellum(
|
|
4009
|
+
api_version="YOUR_API_VERSION",
|
|
3053
4010
|
api_key="YOUR_API_KEY",
|
|
3054
4011
|
)
|
|
3055
|
-
client.
|
|
3056
|
-
document_id="document_id",
|
|
4012
|
+
client.documents.retrieve(
|
|
3057
4013
|
id="id",
|
|
3058
4014
|
)
|
|
3059
4015
|
|
|
@@ -3071,15 +4027,7 @@ client.document_indexes.add_document(
|
|
|
3071
4027
|
<dl>
|
|
3072
4028
|
<dd>
|
|
3073
4029
|
|
|
3074
|
-
**
|
|
3075
|
-
|
|
3076
|
-
</dd>
|
|
3077
|
-
</dl>
|
|
3078
|
-
|
|
3079
|
-
<dl>
|
|
3080
|
-
<dd>
|
|
3081
|
-
|
|
3082
|
-
**id:** `str` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.
|
|
4030
|
+
**id:** `str`
|
|
3083
4031
|
|
|
3084
4032
|
</dd>
|
|
3085
4033
|
</dl>
|
|
@@ -3099,7 +4047,7 @@ client.document_indexes.add_document(
|
|
|
3099
4047
|
</dl>
|
|
3100
4048
|
</details>
|
|
3101
4049
|
|
|
3102
|
-
<details><summary><code>client.
|
|
4050
|
+
<details><summary><code>client.documents.<a href="src/vellum/resources/documents/client.py">destroy</a>(...)</code></summary>
|
|
3103
4051
|
<dl>
|
|
3104
4052
|
<dd>
|
|
3105
4053
|
|
|
@@ -3111,7 +4059,7 @@ client.document_indexes.add_document(
|
|
|
3111
4059
|
<dl>
|
|
3112
4060
|
<dd>
|
|
3113
4061
|
|
|
3114
|
-
|
|
4062
|
+
Delete a Document, keying off of either its Vellum-generated ID or its external ID.
|
|
3115
4063
|
</dd>
|
|
3116
4064
|
</dl>
|
|
3117
4065
|
</dd>
|
|
@@ -3129,10 +4077,10 @@ Removes a Document from a Document Index without deleting the Document itself.
|
|
|
3129
4077
|
from vellum import Vellum
|
|
3130
4078
|
|
|
3131
4079
|
client = Vellum(
|
|
4080
|
+
api_version="YOUR_API_VERSION",
|
|
3132
4081
|
api_key="YOUR_API_KEY",
|
|
3133
4082
|
)
|
|
3134
|
-
client.
|
|
3135
|
-
document_id="document_id",
|
|
4083
|
+
client.documents.destroy(
|
|
3136
4084
|
id="id",
|
|
3137
4085
|
)
|
|
3138
4086
|
|
|
@@ -3150,15 +4098,7 @@ client.document_indexes.remove_document(
|
|
|
3150
4098
|
<dl>
|
|
3151
4099
|
<dd>
|
|
3152
4100
|
|
|
3153
|
-
**
|
|
3154
|
-
|
|
3155
|
-
</dd>
|
|
3156
|
-
</dl>
|
|
3157
|
-
|
|
3158
|
-
<dl>
|
|
3159
|
-
<dd>
|
|
3160
|
-
|
|
3161
|
-
**id:** `str` — Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index from which you'd like to remove a Document.
|
|
4101
|
+
**id:** `str`
|
|
3162
4102
|
|
|
3163
4103
|
</dd>
|
|
3164
4104
|
</dl>
|
|
@@ -3178,8 +4118,7 @@ client.document_indexes.remove_document(
|
|
|
3178
4118
|
</dl>
|
|
3179
4119
|
</details>
|
|
3180
4120
|
|
|
3181
|
-
|
|
3182
|
-
<details><summary><code>client.documents.<a href="src/vellum/resources/documents/client.py">list</a>(...)</code></summary>
|
|
4121
|
+
<details><summary><code>client.documents.<a href="src/vellum/resources/documents/client.py">partial_update</a>(...)</code></summary>
|
|
3183
4122
|
<dl>
|
|
3184
4123
|
<dd>
|
|
3185
4124
|
|
|
@@ -3191,7 +4130,7 @@ client.document_indexes.remove_document(
|
|
|
3191
4130
|
<dl>
|
|
3192
4131
|
<dd>
|
|
3193
4132
|
|
|
3194
|
-
|
|
4133
|
+
Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.
|
|
3195
4134
|
</dd>
|
|
3196
4135
|
</dl>
|
|
3197
4136
|
</dd>
|
|
@@ -3209,9 +4148,12 @@ Used to list documents. Optionally filter on supported fields.
|
|
|
3209
4148
|
from vellum import Vellum
|
|
3210
4149
|
|
|
3211
4150
|
client = Vellum(
|
|
4151
|
+
api_version="YOUR_API_VERSION",
|
|
3212
4152
|
api_key="YOUR_API_KEY",
|
|
3213
4153
|
)
|
|
3214
|
-
client.documents.
|
|
4154
|
+
client.documents.partial_update(
|
|
4155
|
+
id="id",
|
|
4156
|
+
)
|
|
3215
4157
|
|
|
3216
4158
|
```
|
|
3217
4159
|
</dd>
|
|
@@ -3227,7 +4169,7 @@ client.documents.list()
|
|
|
3227
4169
|
<dl>
|
|
3228
4170
|
<dd>
|
|
3229
4171
|
|
|
3230
|
-
**
|
|
4172
|
+
**id:** `str`
|
|
3231
4173
|
|
|
3232
4174
|
</dd>
|
|
3233
4175
|
</dl>
|
|
@@ -3235,7 +4177,7 @@ client.documents.list()
|
|
|
3235
4177
|
<dl>
|
|
3236
4178
|
<dd>
|
|
3237
4179
|
|
|
3238
|
-
**
|
|
4180
|
+
**label:** `typing.Optional[str]` — A human-readable label for the document. Defaults to the originally uploaded file's file name.
|
|
3239
4181
|
|
|
3240
4182
|
</dd>
|
|
3241
4183
|
</dl>
|
|
@@ -3243,7 +4185,11 @@ client.documents.list()
|
|
|
3243
4185
|
<dl>
|
|
3244
4186
|
<dd>
|
|
3245
4187
|
|
|
3246
|
-
**
|
|
4188
|
+
**status:** `typing.Optional[DocumentStatus]`
|
|
4189
|
+
|
|
4190
|
+
The current status of the document
|
|
4191
|
+
|
|
4192
|
+
* `ACTIVE` - Active
|
|
3247
4193
|
|
|
3248
4194
|
</dd>
|
|
3249
4195
|
</dl>
|
|
@@ -3251,7 +4197,7 @@ client.documents.list()
|
|
|
3251
4197
|
<dl>
|
|
3252
4198
|
<dd>
|
|
3253
4199
|
|
|
3254
|
-
**
|
|
4200
|
+
**keywords:** `typing.Optional[typing.Sequence[str]]` — A list of keywords that'll be associated with the document. Used as part of keyword search.
|
|
3255
4201
|
|
|
3256
4202
|
</dd>
|
|
3257
4203
|
</dl>
|
|
@@ -3259,7 +4205,7 @@ client.documents.list()
|
|
|
3259
4205
|
<dl>
|
|
3260
4206
|
<dd>
|
|
3261
4207
|
|
|
3262
|
-
**
|
|
4208
|
+
**metadata:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing any metadata associated with the document that you'd like to filter upon later.
|
|
3263
4209
|
|
|
3264
4210
|
</dd>
|
|
3265
4211
|
</dl>
|
|
@@ -3279,7 +4225,8 @@ client.documents.list()
|
|
|
3279
4225
|
</dl>
|
|
3280
4226
|
</details>
|
|
3281
4227
|
|
|
3282
|
-
|
|
4228
|
+
## Environments
|
|
4229
|
+
<details><summary><code>client.environments.<a href="src/vellum/resources/environments/client.py">environment_identity</a>()</code></summary>
|
|
3283
4230
|
<dl>
|
|
3284
4231
|
<dd>
|
|
3285
4232
|
|
|
@@ -3291,7 +4238,7 @@ client.documents.list()
|
|
|
3291
4238
|
<dl>
|
|
3292
4239
|
<dd>
|
|
3293
4240
|
|
|
3294
|
-
|
|
4241
|
+
Retrieves information about the active Environment
|
|
3295
4242
|
</dd>
|
|
3296
4243
|
</dl>
|
|
3297
4244
|
</dd>
|
|
@@ -3309,11 +4256,10 @@ Retrieve a Document, keying off of either its Vellum-generated ID or its externa
|
|
|
3309
4256
|
from vellum import Vellum
|
|
3310
4257
|
|
|
3311
4258
|
client = Vellum(
|
|
4259
|
+
api_version="YOUR_API_VERSION",
|
|
3312
4260
|
api_key="YOUR_API_KEY",
|
|
3313
4261
|
)
|
|
3314
|
-
client.
|
|
3315
|
-
id="id",
|
|
3316
|
-
)
|
|
4262
|
+
client.environments.environment_identity()
|
|
3317
4263
|
|
|
3318
4264
|
```
|
|
3319
4265
|
</dd>
|
|
@@ -3329,14 +4275,6 @@ client.documents.retrieve(
|
|
|
3329
4275
|
<dl>
|
|
3330
4276
|
<dd>
|
|
3331
4277
|
|
|
3332
|
-
**id:** `str`
|
|
3333
|
-
|
|
3334
|
-
</dd>
|
|
3335
|
-
</dl>
|
|
3336
|
-
|
|
3337
|
-
<dl>
|
|
3338
|
-
<dd>
|
|
3339
|
-
|
|
3340
4278
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
3341
4279
|
|
|
3342
4280
|
</dd>
|
|
@@ -3349,7 +4287,8 @@ client.documents.retrieve(
|
|
|
3349
4287
|
</dl>
|
|
3350
4288
|
</details>
|
|
3351
4289
|
|
|
3352
|
-
|
|
4290
|
+
## FolderEntities
|
|
4291
|
+
<details><summary><code>client.folder_entities.<a href="src/vellum/resources/folder_entities/client.py">list</a>(...)</code></summary>
|
|
3353
4292
|
<dl>
|
|
3354
4293
|
<dd>
|
|
3355
4294
|
|
|
@@ -3361,7 +4300,7 @@ client.documents.retrieve(
|
|
|
3361
4300
|
<dl>
|
|
3362
4301
|
<dd>
|
|
3363
4302
|
|
|
3364
|
-
|
|
4303
|
+
List all folder entities within a specified folder.
|
|
3365
4304
|
</dd>
|
|
3366
4305
|
</dl>
|
|
3367
4306
|
</dd>
|
|
@@ -3379,10 +4318,11 @@ Delete a Document, keying off of either its Vellum-generated ID or its external
|
|
|
3379
4318
|
from vellum import Vellum
|
|
3380
4319
|
|
|
3381
4320
|
client = Vellum(
|
|
4321
|
+
api_version="YOUR_API_VERSION",
|
|
3382
4322
|
api_key="YOUR_API_KEY",
|
|
3383
4323
|
)
|
|
3384
|
-
client.
|
|
3385
|
-
|
|
4324
|
+
client.folder_entities.list(
|
|
4325
|
+
parent_folder_id="parent_folder_id",
|
|
3386
4326
|
)
|
|
3387
4327
|
|
|
3388
4328
|
```
|
|
@@ -3399,7 +4339,53 @@ client.documents.destroy(
|
|
|
3399
4339
|
<dl>
|
|
3400
4340
|
<dd>
|
|
3401
4341
|
|
|
3402
|
-
**
|
|
4342
|
+
**parent_folder_id:** `str`
|
|
4343
|
+
|
|
4344
|
+
Filter down to only those entities whose parent folder has the specified ID.
|
|
4345
|
+
|
|
4346
|
+
To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide
|
|
4347
|
+
a string representing the entity type of the root directory. Supported root directories include:
|
|
4348
|
+
- PROMPT_SANDBOX
|
|
4349
|
+
- WORKFLOW_SANDBOX
|
|
4350
|
+
- DOCUMENT_INDEX
|
|
4351
|
+
- TEST_SUITE
|
|
4352
|
+
|
|
4353
|
+
</dd>
|
|
4354
|
+
</dl>
|
|
4355
|
+
|
|
4356
|
+
<dl>
|
|
4357
|
+
<dd>
|
|
4358
|
+
|
|
4359
|
+
**entity_status:** `typing.Optional[FolderEntitiesListRequestEntityStatus]`
|
|
4360
|
+
|
|
4361
|
+
Filter down to only those objects whose entities have a status matching the status specified.
|
|
4362
|
+
|
|
4363
|
+
* `ACTIVE` - Active
|
|
4364
|
+
* `ARCHIVED` - Archived
|
|
4365
|
+
|
|
4366
|
+
</dd>
|
|
4367
|
+
</dl>
|
|
4368
|
+
|
|
4369
|
+
<dl>
|
|
4370
|
+
<dd>
|
|
4371
|
+
|
|
4372
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
4373
|
+
|
|
4374
|
+
</dd>
|
|
4375
|
+
</dl>
|
|
4376
|
+
|
|
4377
|
+
<dl>
|
|
4378
|
+
<dd>
|
|
4379
|
+
|
|
4380
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
4381
|
+
|
|
4382
|
+
</dd>
|
|
4383
|
+
</dl>
|
|
4384
|
+
|
|
4385
|
+
<dl>
|
|
4386
|
+
<dd>
|
|
4387
|
+
|
|
4388
|
+
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
3403
4389
|
|
|
3404
4390
|
</dd>
|
|
3405
4391
|
</dl>
|
|
@@ -3419,7 +4405,7 @@ client.documents.destroy(
|
|
|
3419
4405
|
</dl>
|
|
3420
4406
|
</details>
|
|
3421
4407
|
|
|
3422
|
-
<details><summary><code>client.
|
|
4408
|
+
<details><summary><code>client.folder_entities.<a href="src/vellum/resources/folder_entities/client.py">add_entity_to_folder</a>(...)</code></summary>
|
|
3423
4409
|
<dl>
|
|
3424
4410
|
<dd>
|
|
3425
4411
|
|
|
@@ -3431,7 +4417,9 @@ client.documents.destroy(
|
|
|
3431
4417
|
<dl>
|
|
3432
4418
|
<dd>
|
|
3433
4419
|
|
|
3434
|
-
|
|
4420
|
+
Add an entity to a specific folder or root directory.
|
|
4421
|
+
|
|
4422
|
+
Adding an entity to a folder will remove it from any other folders it might have been a member of.
|
|
3435
4423
|
</dd>
|
|
3436
4424
|
</dl>
|
|
3437
4425
|
</dd>
|
|
@@ -3449,10 +4437,12 @@ Update a Document, keying off of either its Vellum-generated ID or its external
|
|
|
3449
4437
|
from vellum import Vellum
|
|
3450
4438
|
|
|
3451
4439
|
client = Vellum(
|
|
4440
|
+
api_version="YOUR_API_VERSION",
|
|
3452
4441
|
api_key="YOUR_API_KEY",
|
|
3453
4442
|
)
|
|
3454
|
-
client.
|
|
3455
|
-
|
|
4443
|
+
client.folder_entities.add_entity_to_folder(
|
|
4444
|
+
folder_id="folder_id",
|
|
4445
|
+
entity_id="entity_id",
|
|
3456
4446
|
)
|
|
3457
4447
|
|
|
3458
4448
|
```
|
|
@@ -3469,27 +4459,14 @@ client.documents.partial_update(
|
|
|
3469
4459
|
<dl>
|
|
3470
4460
|
<dd>
|
|
3471
4461
|
|
|
3472
|
-
**
|
|
3473
|
-
|
|
3474
|
-
</dd>
|
|
3475
|
-
</dl>
|
|
3476
|
-
|
|
3477
|
-
<dl>
|
|
3478
|
-
<dd>
|
|
3479
|
-
|
|
3480
|
-
**label:** `typing.Optional[str]` — A human-readable label for the document. Defaults to the originally uploaded file's file name.
|
|
3481
|
-
|
|
3482
|
-
</dd>
|
|
3483
|
-
</dl>
|
|
3484
|
-
|
|
3485
|
-
<dl>
|
|
3486
|
-
<dd>
|
|
3487
|
-
|
|
3488
|
-
**status:** `typing.Optional[DocumentStatus]`
|
|
3489
|
-
|
|
3490
|
-
The current status of the document
|
|
4462
|
+
**folder_id:** `str`
|
|
3491
4463
|
|
|
3492
|
-
|
|
4464
|
+
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
|
|
4465
|
+
directory. Supported root directories include:
|
|
4466
|
+
- PROMPT_SANDBOX
|
|
4467
|
+
- WORKFLOW_SANDBOX
|
|
4468
|
+
- DOCUMENT_INDEX
|
|
4469
|
+
- TEST_SUITE
|
|
3493
4470
|
|
|
3494
4471
|
</dd>
|
|
3495
4472
|
</dl>
|
|
@@ -3497,7 +4474,7 @@ The current status of the document
|
|
|
3497
4474
|
<dl>
|
|
3498
4475
|
<dd>
|
|
3499
4476
|
|
|
3500
|
-
**
|
|
4477
|
+
**entity_id:** `str` — The ID of the entity you would like to move.
|
|
3501
4478
|
|
|
3502
4479
|
</dd>
|
|
3503
4480
|
</dl>
|
|
@@ -3517,7 +4494,8 @@ The current status of the document
|
|
|
3517
4494
|
</dl>
|
|
3518
4495
|
</details>
|
|
3519
4496
|
|
|
3520
|
-
|
|
4497
|
+
## IntegrationAuthConfigs
|
|
4498
|
+
<details><summary><code>client.integration_auth_configs.<a href="src/vellum/resources/integration_auth_configs/client.py">list_integration_auth_configs</a>(...)</code></summary>
|
|
3521
4499
|
<dl>
|
|
3522
4500
|
<dd>
|
|
3523
4501
|
|
|
@@ -3529,9 +4507,7 @@ The current status of the document
|
|
|
3529
4507
|
<dl>
|
|
3530
4508
|
<dd>
|
|
3531
4509
|
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
**Note:** Uses a base url of `https://documents.vellum.ai`.
|
|
4510
|
+
List Integration Auth Configs
|
|
3535
4511
|
</dd>
|
|
3536
4512
|
</dl>
|
|
3537
4513
|
</dd>
|
|
@@ -3549,11 +4525,10 @@ Upload a document to be indexed and used for search.
|
|
|
3549
4525
|
from vellum import Vellum
|
|
3550
4526
|
|
|
3551
4527
|
client = Vellum(
|
|
4528
|
+
api_version="YOUR_API_VERSION",
|
|
3552
4529
|
api_key="YOUR_API_KEY",
|
|
3553
4530
|
)
|
|
3554
|
-
client.
|
|
3555
|
-
label="label",
|
|
3556
|
-
)
|
|
4531
|
+
client.integration_auth_configs.list_integration_auth_configs()
|
|
3557
4532
|
|
|
3558
4533
|
```
|
|
3559
4534
|
</dd>
|
|
@@ -3569,7 +4544,10 @@ client.documents.upload(
|
|
|
3569
4544
|
<dl>
|
|
3570
4545
|
<dd>
|
|
3571
4546
|
|
|
3572
|
-
**
|
|
4547
|
+
**expand:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
|
|
4548
|
+
|
|
4549
|
+
The response fields to expand for more information.
|
|
4550
|
+
- 'integration_credentials' expands the list of integration credentials that the authenticated entity has access to for the auth config.
|
|
3573
4551
|
|
|
3574
4552
|
</dd>
|
|
3575
4553
|
</dl>
|
|
@@ -3577,9 +4555,15 @@ client.documents.upload(
|
|
|
3577
4555
|
<dl>
|
|
3578
4556
|
<dd>
|
|
3579
4557
|
|
|
3580
|
-
**
|
|
4558
|
+
**integration_name:** `typing.Optional[str]`
|
|
4559
|
+
|
|
4560
|
+
</dd>
|
|
4561
|
+
</dl>
|
|
4562
|
+
|
|
4563
|
+
<dl>
|
|
4564
|
+
<dd>
|
|
3581
4565
|
|
|
3582
|
-
|
|
4566
|
+
**integration_provider:** `typing.Optional[str]`
|
|
3583
4567
|
|
|
3584
4568
|
</dd>
|
|
3585
4569
|
</dl>
|
|
@@ -3587,7 +4571,7 @@ core.File` — See core.File for more documentation
|
|
|
3587
4571
|
<dl>
|
|
3588
4572
|
<dd>
|
|
3589
4573
|
|
|
3590
|
-
**
|
|
4574
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
3591
4575
|
|
|
3592
4576
|
</dd>
|
|
3593
4577
|
</dl>
|
|
@@ -3595,7 +4579,7 @@ core.File` — See core.File for more documentation
|
|
|
3595
4579
|
<dl>
|
|
3596
4580
|
<dd>
|
|
3597
4581
|
|
|
3598
|
-
**
|
|
4582
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
3599
4583
|
|
|
3600
4584
|
</dd>
|
|
3601
4585
|
</dl>
|
|
@@ -3603,7 +4587,7 @@ core.File` — See core.File for more documentation
|
|
|
3603
4587
|
<dl>
|
|
3604
4588
|
<dd>
|
|
3605
4589
|
|
|
3606
|
-
**
|
|
4590
|
+
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
3607
4591
|
|
|
3608
4592
|
</dd>
|
|
3609
4593
|
</dl>
|
|
@@ -3611,7 +4595,7 @@ core.File` — See core.File for more documentation
|
|
|
3611
4595
|
<dl>
|
|
3612
4596
|
<dd>
|
|
3613
4597
|
|
|
3614
|
-
**
|
|
4598
|
+
**search:** `typing.Optional[str]` — A search term.
|
|
3615
4599
|
|
|
3616
4600
|
</dd>
|
|
3617
4601
|
</dl>
|
|
@@ -3631,8 +4615,8 @@ core.File` — See core.File for more documentation
|
|
|
3631
4615
|
</dl>
|
|
3632
4616
|
</details>
|
|
3633
4617
|
|
|
3634
|
-
##
|
|
3635
|
-
<details><summary><code>client.
|
|
4618
|
+
## IntegrationProviders
|
|
4619
|
+
<details><summary><code>client.integration_providers.<a href="src/vellum/resources/integration_providers/client.py">retrieve_integration_provider_tool_definition</a>(...)</code></summary>
|
|
3636
4620
|
<dl>
|
|
3637
4621
|
<dd>
|
|
3638
4622
|
|
|
@@ -3644,7 +4628,7 @@ core.File` — See core.File for more documentation
|
|
|
3644
4628
|
<dl>
|
|
3645
4629
|
<dd>
|
|
3646
4630
|
|
|
3647
|
-
|
|
4631
|
+
Retrieve a specific integration tool definition.
|
|
3648
4632
|
</dd>
|
|
3649
4633
|
</dl>
|
|
3650
4634
|
</dd>
|
|
@@ -3662,10 +4646,13 @@ List all folder entities within a specified folder.
|
|
|
3662
4646
|
from vellum import Vellum
|
|
3663
4647
|
|
|
3664
4648
|
client = Vellum(
|
|
4649
|
+
api_version="YOUR_API_VERSION",
|
|
3665
4650
|
api_key="YOUR_API_KEY",
|
|
3666
4651
|
)
|
|
3667
|
-
client.
|
|
3668
|
-
|
|
4652
|
+
client.integration_providers.retrieve_integration_provider_tool_definition(
|
|
4653
|
+
integration_name="integration_name",
|
|
4654
|
+
integration_provider="integration_provider",
|
|
4655
|
+
tool_name="tool_name",
|
|
3669
4656
|
)
|
|
3670
4657
|
|
|
3671
4658
|
```
|
|
@@ -3682,37 +4669,7 @@ client.folder_entities.list(
|
|
|
3682
4669
|
<dl>
|
|
3683
4670
|
<dd>
|
|
3684
4671
|
|
|
3685
|
-
**
|
|
3686
|
-
|
|
3687
|
-
Filter down to only those entities whose parent folder has the specified ID.
|
|
3688
|
-
|
|
3689
|
-
To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide
|
|
3690
|
-
a string representing the entity type of the root directory. Supported root directories include:
|
|
3691
|
-
- PROMPT_SANDBOX
|
|
3692
|
-
- WORKFLOW_SANDBOX
|
|
3693
|
-
- DOCUMENT_INDEX
|
|
3694
|
-
- TEST_SUITE
|
|
3695
|
-
|
|
3696
|
-
</dd>
|
|
3697
|
-
</dl>
|
|
3698
|
-
|
|
3699
|
-
<dl>
|
|
3700
|
-
<dd>
|
|
3701
|
-
|
|
3702
|
-
**entity_status:** `typing.Optional[FolderEntitiesListRequestEntityStatus]`
|
|
3703
|
-
|
|
3704
|
-
Filter down to only those objects whose entities have a status matching the status specified.
|
|
3705
|
-
|
|
3706
|
-
* `ACTIVE` - Active
|
|
3707
|
-
* `ARCHIVED` - Archived
|
|
3708
|
-
|
|
3709
|
-
</dd>
|
|
3710
|
-
</dl>
|
|
3711
|
-
|
|
3712
|
-
<dl>
|
|
3713
|
-
<dd>
|
|
3714
|
-
|
|
3715
|
-
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
4672
|
+
**integration_name:** `str` — The integration name
|
|
3716
4673
|
|
|
3717
4674
|
</dd>
|
|
3718
4675
|
</dl>
|
|
@@ -3720,7 +4677,7 @@ Filter down to only those objects whose entities have a status matching the stat
|
|
|
3720
4677
|
<dl>
|
|
3721
4678
|
<dd>
|
|
3722
4679
|
|
|
3723
|
-
**
|
|
4680
|
+
**integration_provider:** `str` — The integration provider name
|
|
3724
4681
|
|
|
3725
4682
|
</dd>
|
|
3726
4683
|
</dl>
|
|
@@ -3728,7 +4685,7 @@ Filter down to only those objects whose entities have a status matching the stat
|
|
|
3728
4685
|
<dl>
|
|
3729
4686
|
<dd>
|
|
3730
4687
|
|
|
3731
|
-
**
|
|
4688
|
+
**tool_name:** `str` — The tool's unique name, as specified by the integration provider
|
|
3732
4689
|
|
|
3733
4690
|
</dd>
|
|
3734
4691
|
</dl>
|
|
@@ -3748,7 +4705,7 @@ Filter down to only those objects whose entities have a status matching the stat
|
|
|
3748
4705
|
</dl>
|
|
3749
4706
|
</details>
|
|
3750
4707
|
|
|
3751
|
-
<details><summary><code>client.
|
|
4708
|
+
<details><summary><code>client.integration_providers.<a href="src/vellum/resources/integration_providers/client.py">list_integration_tools</a>(...)</code></summary>
|
|
3752
4709
|
<dl>
|
|
3753
4710
|
<dd>
|
|
3754
4711
|
|
|
@@ -3760,9 +4717,7 @@ Filter down to only those objects whose entities have a status matching the stat
|
|
|
3760
4717
|
<dl>
|
|
3761
4718
|
<dd>
|
|
3762
4719
|
|
|
3763
|
-
|
|
3764
|
-
|
|
3765
|
-
Adding an entity to a folder will remove it from any other folders it might have been a member of.
|
|
4720
|
+
List all integration tools for a given provider and integration.
|
|
3766
4721
|
</dd>
|
|
3767
4722
|
</dl>
|
|
3768
4723
|
</dd>
|
|
@@ -3780,11 +4735,11 @@ Adding an entity to a folder will remove it from any other folders it might have
|
|
|
3780
4735
|
from vellum import Vellum
|
|
3781
4736
|
|
|
3782
4737
|
client = Vellum(
|
|
4738
|
+
api_version="YOUR_API_VERSION",
|
|
3783
4739
|
api_key="YOUR_API_KEY",
|
|
3784
4740
|
)
|
|
3785
|
-
client.
|
|
3786
|
-
|
|
3787
|
-
entity_id="entity_id",
|
|
4741
|
+
client.integration_providers.list_integration_tools(
|
|
4742
|
+
integration_provider="integration_provider",
|
|
3788
4743
|
)
|
|
3789
4744
|
|
|
3790
4745
|
```
|
|
@@ -3801,14 +4756,15 @@ client.folder_entities.add_entity_to_folder(
|
|
|
3801
4756
|
<dl>
|
|
3802
4757
|
<dd>
|
|
3803
4758
|
|
|
3804
|
-
**
|
|
4759
|
+
**integration_provider:** `str` — The integration provider name
|
|
4760
|
+
|
|
4761
|
+
</dd>
|
|
4762
|
+
</dl>
|
|
3805
4763
|
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
|
|
3810
|
-
- DOCUMENT_INDEX
|
|
3811
|
-
- TEST_SUITE
|
|
4764
|
+
<dl>
|
|
4765
|
+
<dd>
|
|
4766
|
+
|
|
4767
|
+
**important:** `typing.Optional[bool]` — Whether to filter the tools by important
|
|
3812
4768
|
|
|
3813
4769
|
</dd>
|
|
3814
4770
|
</dl>
|
|
@@ -3816,7 +4772,39 @@ directory. Supported root directories include:
|
|
|
3816
4772
|
<dl>
|
|
3817
4773
|
<dd>
|
|
3818
4774
|
|
|
3819
|
-
**
|
|
4775
|
+
**include_deprecated:** `typing.Optional[bool]` — Whether to include deprecated tools
|
|
4776
|
+
|
|
4777
|
+
</dd>
|
|
4778
|
+
</dl>
|
|
4779
|
+
|
|
4780
|
+
<dl>
|
|
4781
|
+
<dd>
|
|
4782
|
+
|
|
4783
|
+
**integration_name:** `typing.Optional[str]` — The Vellum Integration name
|
|
4784
|
+
|
|
4785
|
+
</dd>
|
|
4786
|
+
</dl>
|
|
4787
|
+
|
|
4788
|
+
<dl>
|
|
4789
|
+
<dd>
|
|
4790
|
+
|
|
4791
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
4792
|
+
|
|
4793
|
+
</dd>
|
|
4794
|
+
</dl>
|
|
4795
|
+
|
|
4796
|
+
<dl>
|
|
4797
|
+
<dd>
|
|
4798
|
+
|
|
4799
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
4800
|
+
|
|
4801
|
+
</dd>
|
|
4802
|
+
</dl>
|
|
4803
|
+
|
|
4804
|
+
<dl>
|
|
4805
|
+
<dd>
|
|
4806
|
+
|
|
4807
|
+
**search:** `typing.Optional[str]` — The search term to filter the tools by
|
|
3820
4808
|
|
|
3821
4809
|
</dd>
|
|
3822
4810
|
</dl>
|
|
@@ -3853,15 +4841,20 @@ directory. Supported root directories include:
|
|
|
3853
4841
|
from vellum import StringInput, Vellum
|
|
3854
4842
|
|
|
3855
4843
|
client = Vellum(
|
|
4844
|
+
api_version="YOUR_API_VERSION",
|
|
3856
4845
|
api_key="YOUR_API_KEY",
|
|
3857
4846
|
)
|
|
3858
4847
|
client.metric_definitions.execute_metric_definition(
|
|
3859
4848
|
id="id",
|
|
3860
4849
|
inputs=[
|
|
3861
4850
|
StringInput(
|
|
3862
|
-
name="
|
|
4851
|
+
name="x",
|
|
4852
|
+
value="value",
|
|
4853
|
+
),
|
|
4854
|
+
StringInput(
|
|
4855
|
+
name="x",
|
|
3863
4856
|
value="value",
|
|
3864
|
-
)
|
|
4857
|
+
),
|
|
3865
4858
|
],
|
|
3866
4859
|
)
|
|
3867
4860
|
|
|
@@ -3931,6 +4924,7 @@ client.metric_definitions.execute_metric_definition(
|
|
|
3931
4924
|
from vellum import Vellum
|
|
3932
4925
|
|
|
3933
4926
|
client = Vellum(
|
|
4927
|
+
api_version="YOUR_API_VERSION",
|
|
3934
4928
|
api_key="YOUR_API_KEY",
|
|
3935
4929
|
)
|
|
3936
4930
|
client.metric_definitions.metric_definition_history_item_retrieve(
|
|
@@ -4011,6 +5005,7 @@ Retrieve details about an ML Model
|
|
|
4011
5005
|
from vellum import Vellum
|
|
4012
5006
|
|
|
4013
5007
|
client = Vellum(
|
|
5008
|
+
api_version="YOUR_API_VERSION",
|
|
4014
5009
|
api_key="YOUR_API_KEY",
|
|
4015
5010
|
)
|
|
4016
5011
|
client.ml_models.retrieve(
|
|
@@ -4082,6 +5077,7 @@ Retrieves information about the active Organization
|
|
|
4082
5077
|
from vellum import Vellum
|
|
4083
5078
|
|
|
4084
5079
|
client = Vellum(
|
|
5080
|
+
api_version="YOUR_API_VERSION",
|
|
4085
5081
|
api_key="YOUR_API_KEY",
|
|
4086
5082
|
)
|
|
4087
5083
|
client.organizations.organization_identity()
|
|
@@ -4143,6 +5139,7 @@ Used to pull the definition of a Prompt from Vellum.
|
|
|
4143
5139
|
from vellum import Vellum
|
|
4144
5140
|
|
|
4145
5141
|
client = Vellum(
|
|
5142
|
+
api_version="YOUR_API_VERSION",
|
|
4146
5143
|
api_key="YOUR_API_KEY",
|
|
4147
5144
|
)
|
|
4148
5145
|
client.prompts.pull(
|
|
@@ -4227,6 +5224,7 @@ from vellum import (
|
|
|
4227
5224
|
)
|
|
4228
5225
|
|
|
4229
5226
|
client = Vellum(
|
|
5227
|
+
api_version="YOUR_API_VERSION",
|
|
4230
5228
|
api_key="YOUR_API_KEY",
|
|
4231
5229
|
)
|
|
4232
5230
|
client.prompts.push(
|
|
@@ -4234,16 +5232,24 @@ client.prompts.push(
|
|
|
4234
5232
|
ml_model="ml_model",
|
|
4235
5233
|
input_variables=[
|
|
4236
5234
|
VellumVariable(
|
|
4237
|
-
id="
|
|
5235
|
+
id="x",
|
|
5236
|
+
key="key",
|
|
5237
|
+
type="STRING",
|
|
5238
|
+
),
|
|
5239
|
+
VellumVariable(
|
|
5240
|
+
id="x",
|
|
4238
5241
|
key="key",
|
|
4239
5242
|
type="STRING",
|
|
4240
|
-
)
|
|
5243
|
+
),
|
|
4241
5244
|
],
|
|
4242
5245
|
parameters=PromptParameters(),
|
|
4243
5246
|
blocks=[
|
|
4244
5247
|
JinjaPromptBlock(
|
|
4245
5248
|
template="template",
|
|
4246
|
-
)
|
|
5249
|
+
),
|
|
5250
|
+
JinjaPromptBlock(
|
|
5251
|
+
template="template",
|
|
5252
|
+
),
|
|
4247
5253
|
],
|
|
4248
5254
|
),
|
|
4249
5255
|
)
|
|
@@ -4270,7 +5276,15 @@ client.prompts.push(
|
|
|
4270
5276
|
<dl>
|
|
4271
5277
|
<dd>
|
|
4272
5278
|
|
|
4273
|
-
**prompt_variant_id:** `typing.Optional[str]`
|
|
5279
|
+
**prompt_variant_id:** `typing.Optional[str]` — If specified, an existing Prompt Variant by the provided ID will be updated. Otherwise, a new Prompt Variant will be created and an ID generated.
|
|
5280
|
+
|
|
5281
|
+
</dd>
|
|
5282
|
+
</dl>
|
|
5283
|
+
|
|
5284
|
+
<dl>
|
|
5285
|
+
<dd>
|
|
5286
|
+
|
|
5287
|
+
**prompt_variant_label:** `typing.Optional[str]` — If provided, then the created/updated Prompt Variant will have this label.
|
|
4274
5288
|
|
|
4275
5289
|
</dd>
|
|
4276
5290
|
</dl>
|
|
@@ -4315,6 +5329,7 @@ client.prompts.push(
|
|
|
4315
5329
|
from vellum import Vellum
|
|
4316
5330
|
|
|
4317
5331
|
client = Vellum(
|
|
5332
|
+
api_version="YOUR_API_VERSION",
|
|
4318
5333
|
api_key="YOUR_API_KEY",
|
|
4319
5334
|
)
|
|
4320
5335
|
client.sandboxes.deploy_prompt(
|
|
@@ -4437,32 +5452,21 @@ or overwritten with default values.
|
|
|
4437
5452
|
<dd>
|
|
4438
5453
|
|
|
4439
5454
|
```python
|
|
4440
|
-
from vellum import
|
|
4441
|
-
ChatMessageRequest,
|
|
4442
|
-
NamedScenarioInputChatHistoryVariableValueRequest,
|
|
4443
|
-
Vellum,
|
|
4444
|
-
)
|
|
5455
|
+
from vellum import NamedScenarioInputStringVariableValueRequest, Vellum
|
|
4445
5456
|
|
|
4446
5457
|
client = Vellum(
|
|
5458
|
+
api_version="YOUR_API_VERSION",
|
|
4447
5459
|
api_key="YOUR_API_KEY",
|
|
4448
5460
|
)
|
|
4449
5461
|
client.sandboxes.upsert_sandbox_scenario(
|
|
4450
5462
|
id="id",
|
|
4451
|
-
label="Scenario 2",
|
|
4452
5463
|
inputs=[
|
|
4453
|
-
|
|
4454
|
-
|
|
4455
|
-
|
|
4456
|
-
|
|
4457
|
-
|
|
4458
|
-
|
|
4459
|
-
ChatMessageRequest(
|
|
4460
|
-
text="AI's don't have a favorite color.... Yet.",
|
|
4461
|
-
role="ASSISTANT",
|
|
4462
|
-
),
|
|
4463
|
-
],
|
|
4464
|
-
name="chat_history",
|
|
4465
|
-
)
|
|
5464
|
+
NamedScenarioInputStringVariableValueRequest(
|
|
5465
|
+
name="x",
|
|
5466
|
+
),
|
|
5467
|
+
NamedScenarioInputStringVariableValueRequest(
|
|
5468
|
+
name="x",
|
|
5469
|
+
),
|
|
4466
5470
|
],
|
|
4467
5471
|
)
|
|
4468
5472
|
|
|
@@ -4554,6 +5558,7 @@ Deletes an existing scenario from a sandbox, keying off of the provided scenario
|
|
|
4554
5558
|
from vellum import Vellum
|
|
4555
5559
|
|
|
4556
5560
|
client = Vellum(
|
|
5561
|
+
api_version="YOUR_API_VERSION",
|
|
4557
5562
|
api_key="YOUR_API_KEY",
|
|
4558
5563
|
)
|
|
4559
5564
|
client.sandboxes.delete_sandbox_scenario(
|
|
@@ -4638,6 +5643,7 @@ from vellum import (
|
|
|
4638
5643
|
)
|
|
4639
5644
|
|
|
4640
5645
|
client = Vellum(
|
|
5646
|
+
api_version="YOUR_API_VERSION",
|
|
4641
5647
|
api_key="YOUR_API_KEY",
|
|
4642
5648
|
)
|
|
4643
5649
|
client.test_suite_runs.create(
|
|
@@ -4728,6 +5734,7 @@ Retrieve a specific Test Suite Run by ID
|
|
|
4728
5734
|
from vellum import Vellum
|
|
4729
5735
|
|
|
4730
5736
|
client = Vellum(
|
|
5737
|
+
api_version="YOUR_API_VERSION",
|
|
4731
5738
|
api_key="YOUR_API_KEY",
|
|
4732
5739
|
)
|
|
4733
5740
|
client.test_suite_runs.retrieve(
|
|
@@ -4784,6 +5791,7 @@ client.test_suite_runs.retrieve(
|
|
|
4784
5791
|
from vellum import Vellum
|
|
4785
5792
|
|
|
4786
5793
|
client = Vellum(
|
|
5794
|
+
api_version="YOUR_API_VERSION",
|
|
4787
5795
|
api_key="YOUR_API_KEY",
|
|
4788
5796
|
)
|
|
4789
5797
|
client.test_suite_runs.list_executions(
|
|
@@ -4815,9 +5823,9 @@ client.test_suite_runs.list_executions(
|
|
|
4815
5823
|
**expand:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]`
|
|
4816
5824
|
|
|
4817
5825
|
The response fields to expand for more information.
|
|
4818
|
-
- '
|
|
4819
|
-
- '
|
|
4820
|
-
- '
|
|
5826
|
+
- 'metric_results.metric_label' expands the metric label for each metric result.
|
|
5827
|
+
- 'metric_results.metric_definition' expands the metric definition for each metric result.
|
|
5828
|
+
- 'metric_results.metric_definition.name' expands the metric definition name for each metric result.
|
|
4821
5829
|
|
|
4822
5830
|
</dd>
|
|
4823
5831
|
</dl>
|
|
@@ -4884,6 +5892,7 @@ List the Test Cases associated with a Test Suite
|
|
|
4884
5892
|
from vellum import Vellum
|
|
4885
5893
|
|
|
4886
5894
|
client = Vellum(
|
|
5895
|
+
api_version="YOUR_API_VERSION",
|
|
4887
5896
|
api_key="YOUR_API_KEY",
|
|
4888
5897
|
)
|
|
4889
5898
|
client.test_suites.list_test_suite_test_cases(
|
|
@@ -4973,40 +5982,29 @@ or overwritten with default values.
|
|
|
4973
5982
|
<dd>
|
|
4974
5983
|
|
|
4975
5984
|
```python
|
|
4976
|
-
from vellum import
|
|
4977
|
-
NamedTestCaseArrayVariableValueRequest,
|
|
4978
|
-
NamedTestCaseStringVariableValueRequest,
|
|
4979
|
-
StringVellumValueRequest,
|
|
4980
|
-
Vellum,
|
|
4981
|
-
)
|
|
5985
|
+
from vellum import NamedTestCaseStringVariableValueRequest, Vellum
|
|
4982
5986
|
|
|
4983
5987
|
client = Vellum(
|
|
5988
|
+
api_version="YOUR_API_VERSION",
|
|
4984
5989
|
api_key="YOUR_API_KEY",
|
|
4985
5990
|
)
|
|
4986
5991
|
client.test_suites.upsert_test_suite_test_case(
|
|
4987
5992
|
id_="id",
|
|
4988
|
-
label="Test Case 1",
|
|
4989
5993
|
input_values=[
|
|
4990
5994
|
NamedTestCaseStringVariableValueRequest(
|
|
4991
|
-
|
|
4992
|
-
|
|
4993
|
-
|
|
5995
|
+
name="x",
|
|
5996
|
+
),
|
|
5997
|
+
NamedTestCaseStringVariableValueRequest(
|
|
5998
|
+
name="x",
|
|
5999
|
+
),
|
|
4994
6000
|
],
|
|
4995
6001
|
evaluation_values=[
|
|
4996
|
-
|
|
4997
|
-
|
|
4998
|
-
|
|
4999
|
-
|
|
5000
|
-
|
|
5001
|
-
|
|
5002
|
-
value="Green",
|
|
5003
|
-
),
|
|
5004
|
-
StringVellumValueRequest(
|
|
5005
|
-
value="Blue",
|
|
5006
|
-
),
|
|
5007
|
-
],
|
|
5008
|
-
name="var_2",
|
|
5009
|
-
)
|
|
6002
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6003
|
+
name="x",
|
|
6004
|
+
),
|
|
6005
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6006
|
+
name="x",
|
|
6007
|
+
),
|
|
5010
6008
|
],
|
|
5011
6009
|
)
|
|
5012
6010
|
|
|
@@ -5096,7 +6094,137 @@ client.test_suites.upsert_test_suite_test_case(
|
|
|
5096
6094
|
<dl>
|
|
5097
6095
|
<dd>
|
|
5098
6096
|
|
|
5099
|
-
Created, replace, and delete Test Cases within the specified Test Suite in bulk
|
|
6097
|
+
Created, replace, and delete Test Cases within the specified Test Suite in bulk
|
|
6098
|
+
</dd>
|
|
6099
|
+
</dl>
|
|
6100
|
+
</dd>
|
|
6101
|
+
</dl>
|
|
6102
|
+
|
|
6103
|
+
#### 🔌 Usage
|
|
6104
|
+
|
|
6105
|
+
<dl>
|
|
6106
|
+
<dd>
|
|
6107
|
+
|
|
6108
|
+
<dl>
|
|
6109
|
+
<dd>
|
|
6110
|
+
|
|
6111
|
+
```python
|
|
6112
|
+
from vellum import (
|
|
6113
|
+
CreateTestSuiteTestCaseRequest,
|
|
6114
|
+
NamedTestCaseStringVariableValueRequest,
|
|
6115
|
+
TestSuiteTestCaseCreateBulkOperationRequest,
|
|
6116
|
+
Vellum,
|
|
6117
|
+
)
|
|
6118
|
+
|
|
6119
|
+
client = Vellum(
|
|
6120
|
+
api_version="YOUR_API_VERSION",
|
|
6121
|
+
api_key="YOUR_API_KEY",
|
|
6122
|
+
)
|
|
6123
|
+
response = client.test_suites.test_suite_test_cases_bulk(
|
|
6124
|
+
id="id",
|
|
6125
|
+
request=[
|
|
6126
|
+
TestSuiteTestCaseCreateBulkOperationRequest(
|
|
6127
|
+
id="id",
|
|
6128
|
+
data=CreateTestSuiteTestCaseRequest(
|
|
6129
|
+
input_values=[
|
|
6130
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6131
|
+
name="x",
|
|
6132
|
+
),
|
|
6133
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6134
|
+
name="x",
|
|
6135
|
+
),
|
|
6136
|
+
],
|
|
6137
|
+
evaluation_values=[
|
|
6138
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6139
|
+
name="x",
|
|
6140
|
+
),
|
|
6141
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6142
|
+
name="x",
|
|
6143
|
+
),
|
|
6144
|
+
],
|
|
6145
|
+
),
|
|
6146
|
+
),
|
|
6147
|
+
TestSuiteTestCaseCreateBulkOperationRequest(
|
|
6148
|
+
id="id",
|
|
6149
|
+
data=CreateTestSuiteTestCaseRequest(
|
|
6150
|
+
input_values=[
|
|
6151
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6152
|
+
name="x",
|
|
6153
|
+
),
|
|
6154
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6155
|
+
name="x",
|
|
6156
|
+
),
|
|
6157
|
+
],
|
|
6158
|
+
evaluation_values=[
|
|
6159
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6160
|
+
name="x",
|
|
6161
|
+
),
|
|
6162
|
+
NamedTestCaseStringVariableValueRequest(
|
|
6163
|
+
name="x",
|
|
6164
|
+
),
|
|
6165
|
+
],
|
|
6166
|
+
),
|
|
6167
|
+
),
|
|
6168
|
+
],
|
|
6169
|
+
)
|
|
6170
|
+
for chunk in response.data:
|
|
6171
|
+
yield chunk
|
|
6172
|
+
|
|
6173
|
+
```
|
|
6174
|
+
</dd>
|
|
6175
|
+
</dl>
|
|
6176
|
+
</dd>
|
|
6177
|
+
</dl>
|
|
6178
|
+
|
|
6179
|
+
#### ⚙️ Parameters
|
|
6180
|
+
|
|
6181
|
+
<dl>
|
|
6182
|
+
<dd>
|
|
6183
|
+
|
|
6184
|
+
<dl>
|
|
6185
|
+
<dd>
|
|
6186
|
+
|
|
6187
|
+
**id:** `str` — Either the Test Suites' ID or its unique name
|
|
6188
|
+
|
|
6189
|
+
</dd>
|
|
6190
|
+
</dl>
|
|
6191
|
+
|
|
6192
|
+
<dl>
|
|
6193
|
+
<dd>
|
|
6194
|
+
|
|
6195
|
+
**request:** `typing.Sequence[TestSuiteTestCaseBulkOperationRequest]`
|
|
6196
|
+
|
|
6197
|
+
</dd>
|
|
6198
|
+
</dl>
|
|
6199
|
+
|
|
6200
|
+
<dl>
|
|
6201
|
+
<dd>
|
|
6202
|
+
|
|
6203
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
6204
|
+
|
|
6205
|
+
</dd>
|
|
6206
|
+
</dl>
|
|
6207
|
+
</dd>
|
|
6208
|
+
</dl>
|
|
6209
|
+
|
|
6210
|
+
|
|
6211
|
+
</dd>
|
|
6212
|
+
</dl>
|
|
6213
|
+
</details>
|
|
6214
|
+
|
|
6215
|
+
<details><summary><code>client.test_suites.<a href="src/vellum/resources/test_suites/client.py">delete_test_suite_test_case</a>(...)</code></summary>
|
|
6216
|
+
<dl>
|
|
6217
|
+
<dd>
|
|
6218
|
+
|
|
6219
|
+
#### 📝 Description
|
|
6220
|
+
|
|
6221
|
+
<dl>
|
|
6222
|
+
<dd>
|
|
6223
|
+
|
|
6224
|
+
<dl>
|
|
6225
|
+
<dd>
|
|
6226
|
+
|
|
6227
|
+
Deletes an existing test case for a test suite, keying off of the test case id.
|
|
5100
6228
|
</dd>
|
|
5101
6229
|
</dl>
|
|
5102
6230
|
</dd>
|
|
@@ -5111,38 +6239,16 @@ Created, replace, and delete Test Cases within the specified Test Suite in bulk
|
|
|
5111
6239
|
<dd>
|
|
5112
6240
|
|
|
5113
6241
|
```python
|
|
5114
|
-
from vellum import
|
|
5115
|
-
CreateTestSuiteTestCaseRequest,
|
|
5116
|
-
NamedTestCaseStringVariableValueRequest,
|
|
5117
|
-
TestSuiteTestCaseCreateBulkOperationRequest,
|
|
5118
|
-
Vellum,
|
|
5119
|
-
)
|
|
6242
|
+
from vellum import Vellum
|
|
5120
6243
|
|
|
5121
6244
|
client = Vellum(
|
|
6245
|
+
api_version="YOUR_API_VERSION",
|
|
5122
6246
|
api_key="YOUR_API_KEY",
|
|
5123
6247
|
)
|
|
5124
|
-
|
|
6248
|
+
client.test_suites.delete_test_suite_test_case(
|
|
5125
6249
|
id="id",
|
|
5126
|
-
|
|
5127
|
-
TestSuiteTestCaseCreateBulkOperationRequest(
|
|
5128
|
-
id="id",
|
|
5129
|
-
data=CreateTestSuiteTestCaseRequest(
|
|
5130
|
-
input_values=[
|
|
5131
|
-
NamedTestCaseStringVariableValueRequest(
|
|
5132
|
-
name="name",
|
|
5133
|
-
)
|
|
5134
|
-
],
|
|
5135
|
-
evaluation_values=[
|
|
5136
|
-
NamedTestCaseStringVariableValueRequest(
|
|
5137
|
-
name="name",
|
|
5138
|
-
)
|
|
5139
|
-
],
|
|
5140
|
-
),
|
|
5141
|
-
)
|
|
5142
|
-
],
|
|
6250
|
+
test_case_id="test_case_id",
|
|
5143
6251
|
)
|
|
5144
|
-
for chunk in response:
|
|
5145
|
-
yield chunk
|
|
5146
6252
|
|
|
5147
6253
|
```
|
|
5148
6254
|
</dd>
|
|
@@ -5166,7 +6272,7 @@ for chunk in response:
|
|
|
5166
6272
|
<dl>
|
|
5167
6273
|
<dd>
|
|
5168
6274
|
|
|
5169
|
-
**
|
|
6275
|
+
**test_case_id:** `str` — An id identifying the test case that you'd like to delete
|
|
5170
6276
|
|
|
5171
6277
|
</dd>
|
|
5172
6278
|
</dl>
|
|
@@ -5186,7 +6292,8 @@ for chunk in response:
|
|
|
5186
6292
|
</dl>
|
|
5187
6293
|
</details>
|
|
5188
6294
|
|
|
5189
|
-
|
|
6295
|
+
## UploadedFiles
|
|
6296
|
+
<details><summary><code>client.uploaded_files.<a href="src/vellum/resources/uploaded_files/client.py">retrieve</a>(...)</code></summary>
|
|
5190
6297
|
<dl>
|
|
5191
6298
|
<dd>
|
|
5192
6299
|
|
|
@@ -5198,7 +6305,7 @@ for chunk in response:
|
|
|
5198
6305
|
<dl>
|
|
5199
6306
|
<dd>
|
|
5200
6307
|
|
|
5201
|
-
|
|
6308
|
+
Retrieve a previously uploaded file by its ID
|
|
5202
6309
|
</dd>
|
|
5203
6310
|
</dl>
|
|
5204
6311
|
</dd>
|
|
@@ -5216,11 +6323,11 @@ Deletes an existing test case for a test suite, keying off of the test case id.
|
|
|
5216
6323
|
from vellum import Vellum
|
|
5217
6324
|
|
|
5218
6325
|
client = Vellum(
|
|
6326
|
+
api_version="YOUR_API_VERSION",
|
|
5219
6327
|
api_key="YOUR_API_KEY",
|
|
5220
6328
|
)
|
|
5221
|
-
client.
|
|
6329
|
+
client.uploaded_files.retrieve(
|
|
5222
6330
|
id="id",
|
|
5223
|
-
test_case_id="test_case_id",
|
|
5224
6331
|
)
|
|
5225
6332
|
|
|
5226
6333
|
```
|
|
@@ -5237,7 +6344,7 @@ client.test_suites.delete_test_suite_test_case(
|
|
|
5237
6344
|
<dl>
|
|
5238
6345
|
<dd>
|
|
5239
6346
|
|
|
5240
|
-
**id:** `str` —
|
|
6347
|
+
**id:** `str` — A UUID string identifying this uploaded file.
|
|
5241
6348
|
|
|
5242
6349
|
</dd>
|
|
5243
6350
|
</dl>
|
|
@@ -5245,7 +6352,7 @@ client.test_suites.delete_test_suite_test_case(
|
|
|
5245
6352
|
<dl>
|
|
5246
6353
|
<dd>
|
|
5247
6354
|
|
|
5248
|
-
**
|
|
6355
|
+
**expiry_seconds:** `typing.Optional[int]` — The number of seconds until the signed URL expires. Must be > 0 and <= 2592000 (30 days). Non-numeric or out-of-range values fall back to the default (604800 seconds or 7 days).
|
|
5249
6356
|
|
|
5250
6357
|
</dd>
|
|
5251
6358
|
</dl>
|
|
@@ -5296,6 +6403,7 @@ Used to list all Workflow Deployments.
|
|
|
5296
6403
|
from vellum import Vellum
|
|
5297
6404
|
|
|
5298
6405
|
client = Vellum(
|
|
6406
|
+
api_version="YOUR_API_VERSION",
|
|
5299
6407
|
api_key="YOUR_API_KEY",
|
|
5300
6408
|
)
|
|
5301
6409
|
client.workflow_deployments.list()
|
|
@@ -5388,6 +6496,7 @@ Used to retrieve a workflow deployment given its ID or name.
|
|
|
5388
6496
|
from vellum import Vellum
|
|
5389
6497
|
|
|
5390
6498
|
client = Vellum(
|
|
6499
|
+
api_version="YOUR_API_VERSION",
|
|
5391
6500
|
api_key="YOUR_API_KEY",
|
|
5392
6501
|
)
|
|
5393
6502
|
client.workflow_deployments.retrieve(
|
|
@@ -5444,6 +6553,7 @@ client.workflow_deployments.retrieve(
|
|
|
5444
6553
|
from vellum import Vellum
|
|
5445
6554
|
|
|
5446
6555
|
client = Vellum(
|
|
6556
|
+
api_version="YOUR_API_VERSION",
|
|
5447
6557
|
api_key="YOUR_API_KEY",
|
|
5448
6558
|
)
|
|
5449
6559
|
client.workflow_deployments.list_workflow_deployment_event_executions(
|
|
@@ -5496,6 +6606,14 @@ client.workflow_deployments.list_workflow_deployment_event_executions(
|
|
|
5496
6606
|
<dl>
|
|
5497
6607
|
<dd>
|
|
5498
6608
|
|
|
6609
|
+
**ordering:** `typing.Optional[str]`
|
|
6610
|
+
|
|
6611
|
+
</dd>
|
|
6612
|
+
</dl>
|
|
6613
|
+
|
|
6614
|
+
<dl>
|
|
6615
|
+
<dd>
|
|
6616
|
+
|
|
5499
6617
|
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
5500
6618
|
|
|
5501
6619
|
</dd>
|
|
@@ -5524,6 +6642,7 @@ client.workflow_deployments.list_workflow_deployment_event_executions(
|
|
|
5524
6642
|
from vellum import Vellum
|
|
5525
6643
|
|
|
5526
6644
|
client = Vellum(
|
|
6645
|
+
api_version="YOUR_API_VERSION",
|
|
5527
6646
|
api_key="YOUR_API_KEY",
|
|
5528
6647
|
)
|
|
5529
6648
|
client.workflow_deployments.workflow_deployment_event_execution(
|
|
@@ -5604,6 +6723,7 @@ DEPRECATED: This endpoint is deprecated and will be removed in a future release.
|
|
|
5604
6723
|
from vellum import Vellum
|
|
5605
6724
|
|
|
5606
6725
|
client = Vellum(
|
|
6726
|
+
api_version="YOUR_API_VERSION",
|
|
5607
6727
|
api_key="YOUR_API_KEY",
|
|
5608
6728
|
)
|
|
5609
6729
|
client.workflow_deployments.workflow_deployment_history_item_retrieve(
|
|
@@ -5683,6 +6803,7 @@ List Release Tags associated with the specified Workflow Deployment
|
|
|
5683
6803
|
from vellum import Vellum
|
|
5684
6804
|
|
|
5685
6805
|
client = Vellum(
|
|
6806
|
+
api_version="YOUR_API_VERSION",
|
|
5686
6807
|
api_key="YOUR_API_KEY",
|
|
5687
6808
|
)
|
|
5688
6809
|
client.workflow_deployments.list_workflow_release_tags(
|
|
@@ -5785,6 +6906,7 @@ Retrieve a Workflow Release Tag by tag name, associated with a specified Workflo
|
|
|
5785
6906
|
from vellum import Vellum
|
|
5786
6907
|
|
|
5787
6908
|
client = Vellum(
|
|
6909
|
+
api_version="YOUR_API_VERSION",
|
|
5788
6910
|
api_key="YOUR_API_KEY",
|
|
5789
6911
|
)
|
|
5790
6912
|
client.workflow_deployments.retrieve_workflow_release_tag(
|
|
@@ -5864,6 +6986,7 @@ Updates an existing Release Tag associated with the specified Workflow Deploymen
|
|
|
5864
6986
|
from vellum import Vellum
|
|
5865
6987
|
|
|
5866
6988
|
client = Vellum(
|
|
6989
|
+
api_version="YOUR_API_VERSION",
|
|
5867
6990
|
api_key="YOUR_API_KEY",
|
|
5868
6991
|
)
|
|
5869
6992
|
client.workflow_deployments.update_workflow_release_tag(
|
|
@@ -5921,8 +7044,102 @@ client.workflow_deployments.update_workflow_release_tag(
|
|
|
5921
7044
|
</dl>
|
|
5922
7045
|
</details>
|
|
5923
7046
|
|
|
5924
|
-
|
|
5925
|
-
<
|
|
7047
|
+
<details><summary><code>client.workflow_deployments.<a href="src/vellum/resources/workflow_deployments/client.py">list_workflow_deployment_releases</a>(...)</code></summary>
|
|
7048
|
+
<dl>
|
|
7049
|
+
<dd>
|
|
7050
|
+
|
|
7051
|
+
#### 📝 Description
|
|
7052
|
+
|
|
7053
|
+
<dl>
|
|
7054
|
+
<dd>
|
|
7055
|
+
|
|
7056
|
+
<dl>
|
|
7057
|
+
<dd>
|
|
7058
|
+
|
|
7059
|
+
List the Releases of the specified Workflow Deployment for the current Environment.
|
|
7060
|
+
</dd>
|
|
7061
|
+
</dl>
|
|
7062
|
+
</dd>
|
|
7063
|
+
</dl>
|
|
7064
|
+
|
|
7065
|
+
#### 🔌 Usage
|
|
7066
|
+
|
|
7067
|
+
<dl>
|
|
7068
|
+
<dd>
|
|
7069
|
+
|
|
7070
|
+
<dl>
|
|
7071
|
+
<dd>
|
|
7072
|
+
|
|
7073
|
+
```python
|
|
7074
|
+
from vellum import Vellum
|
|
7075
|
+
|
|
7076
|
+
client = Vellum(
|
|
7077
|
+
api_version="YOUR_API_VERSION",
|
|
7078
|
+
api_key="YOUR_API_KEY",
|
|
7079
|
+
)
|
|
7080
|
+
client.workflow_deployments.list_workflow_deployment_releases(
|
|
7081
|
+
id="id",
|
|
7082
|
+
)
|
|
7083
|
+
|
|
7084
|
+
```
|
|
7085
|
+
</dd>
|
|
7086
|
+
</dl>
|
|
7087
|
+
</dd>
|
|
7088
|
+
</dl>
|
|
7089
|
+
|
|
7090
|
+
#### ⚙️ Parameters
|
|
7091
|
+
|
|
7092
|
+
<dl>
|
|
7093
|
+
<dd>
|
|
7094
|
+
|
|
7095
|
+
<dl>
|
|
7096
|
+
<dd>
|
|
7097
|
+
|
|
7098
|
+
**id:** `str` — Either the Workflow Deployment's ID or its unique name
|
|
7099
|
+
|
|
7100
|
+
</dd>
|
|
7101
|
+
</dl>
|
|
7102
|
+
|
|
7103
|
+
<dl>
|
|
7104
|
+
<dd>
|
|
7105
|
+
|
|
7106
|
+
**limit:** `typing.Optional[int]` — Number of results to return per page.
|
|
7107
|
+
|
|
7108
|
+
</dd>
|
|
7109
|
+
</dl>
|
|
7110
|
+
|
|
7111
|
+
<dl>
|
|
7112
|
+
<dd>
|
|
7113
|
+
|
|
7114
|
+
**offset:** `typing.Optional[int]` — The initial index from which to return the results.
|
|
7115
|
+
|
|
7116
|
+
</dd>
|
|
7117
|
+
</dl>
|
|
7118
|
+
|
|
7119
|
+
<dl>
|
|
7120
|
+
<dd>
|
|
7121
|
+
|
|
7122
|
+
**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
|
|
7123
|
+
|
|
7124
|
+
</dd>
|
|
7125
|
+
</dl>
|
|
7126
|
+
|
|
7127
|
+
<dl>
|
|
7128
|
+
<dd>
|
|
7129
|
+
|
|
7130
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
7131
|
+
|
|
7132
|
+
</dd>
|
|
7133
|
+
</dl>
|
|
7134
|
+
</dd>
|
|
7135
|
+
</dl>
|
|
7136
|
+
|
|
7137
|
+
|
|
7138
|
+
</dd>
|
|
7139
|
+
</dl>
|
|
7140
|
+
</details>
|
|
7141
|
+
|
|
7142
|
+
<details><summary><code>client.workflow_deployments.<a href="src/vellum/resources/workflow_deployments/client.py">retrieve_workflow_deployment_release</a>(...)</code></summary>
|
|
5926
7143
|
<dl>
|
|
5927
7144
|
<dd>
|
|
5928
7145
|
|
|
@@ -5952,9 +7169,10 @@ Retrieve a specific Workflow Deployment Release by either its UUID or the name o
|
|
|
5952
7169
|
from vellum import Vellum
|
|
5953
7170
|
|
|
5954
7171
|
client = Vellum(
|
|
7172
|
+
api_version="YOUR_API_VERSION",
|
|
5955
7173
|
api_key="YOUR_API_KEY",
|
|
5956
7174
|
)
|
|
5957
|
-
client.
|
|
7175
|
+
client.workflow_deployments.retrieve_workflow_deployment_release(
|
|
5958
7176
|
id="id",
|
|
5959
7177
|
release_id_or_release_tag="release_id_or_release_tag",
|
|
5960
7178
|
)
|
|
@@ -6001,8 +7219,8 @@ client.release_reviews.retrieve_workflow_deployment_release(
|
|
|
6001
7219
|
</dl>
|
|
6002
7220
|
</details>
|
|
6003
7221
|
|
|
6004
|
-
##
|
|
6005
|
-
<details><summary><code>client.
|
|
7222
|
+
## WorkflowExecutions
|
|
7223
|
+
<details><summary><code>client.workflow_executions.<a href="src/vellum/resources/workflow_executions/client.py">retrieve_workflow_execution_detail</a>(...)</code></summary>
|
|
6006
7224
|
<dl>
|
|
6007
7225
|
<dd>
|
|
6008
7226
|
|
|
@@ -6018,11 +7236,11 @@ client.release_reviews.retrieve_workflow_deployment_release(
|
|
|
6018
7236
|
from vellum import Vellum
|
|
6019
7237
|
|
|
6020
7238
|
client = Vellum(
|
|
7239
|
+
api_version="YOUR_API_VERSION",
|
|
6021
7240
|
api_key="YOUR_API_KEY",
|
|
6022
7241
|
)
|
|
6023
|
-
client.
|
|
6024
|
-
|
|
6025
|
-
workflow_id="workflow_id",
|
|
7242
|
+
client.workflow_executions.retrieve_workflow_execution_detail(
|
|
7243
|
+
execution_id="execution_id",
|
|
6026
7244
|
)
|
|
6027
7245
|
|
|
6028
7246
|
```
|
|
@@ -6039,15 +7257,81 @@ client.workflow_sandboxes.deploy_workflow(
|
|
|
6039
7257
|
<dl>
|
|
6040
7258
|
<dd>
|
|
6041
7259
|
|
|
6042
|
-
**
|
|
7260
|
+
**execution_id:** `str`
|
|
7261
|
+
|
|
7262
|
+
</dd>
|
|
7263
|
+
</dl>
|
|
7264
|
+
|
|
7265
|
+
<dl>
|
|
7266
|
+
<dd>
|
|
7267
|
+
|
|
7268
|
+
**prev_span_id:** `typing.Optional[str]` — Optional keyset cursor span_id to continue from (exclusive)
|
|
7269
|
+
|
|
7270
|
+
</dd>
|
|
7271
|
+
</dl>
|
|
7272
|
+
|
|
7273
|
+
<dl>
|
|
7274
|
+
<dd>
|
|
7275
|
+
|
|
7276
|
+
**span_limit:** `typing.Optional[int]` — Maximum number of spans to return (for lazy loading)
|
|
7277
|
+
|
|
7278
|
+
</dd>
|
|
7279
|
+
</dl>
|
|
7280
|
+
|
|
7281
|
+
<dl>
|
|
7282
|
+
<dd>
|
|
7283
|
+
|
|
7284
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
6043
7285
|
|
|
6044
7286
|
</dd>
|
|
6045
7287
|
</dl>
|
|
7288
|
+
</dd>
|
|
7289
|
+
</dl>
|
|
7290
|
+
|
|
7291
|
+
|
|
7292
|
+
</dd>
|
|
7293
|
+
</dl>
|
|
7294
|
+
</details>
|
|
7295
|
+
|
|
7296
|
+
## WorkflowSandboxes
|
|
7297
|
+
<details><summary><code>client.workflow_sandboxes.<a href="src/vellum/resources/workflow_sandboxes/client.py">deploy_workflow</a>(...)</code></summary>
|
|
7298
|
+
<dl>
|
|
7299
|
+
<dd>
|
|
7300
|
+
|
|
7301
|
+
#### 🔌 Usage
|
|
7302
|
+
|
|
7303
|
+
<dl>
|
|
7304
|
+
<dd>
|
|
7305
|
+
|
|
7306
|
+
<dl>
|
|
7307
|
+
<dd>
|
|
7308
|
+
|
|
7309
|
+
```python
|
|
7310
|
+
from vellum import Vellum
|
|
7311
|
+
|
|
7312
|
+
client = Vellum(
|
|
7313
|
+
api_version="YOUR_API_VERSION",
|
|
7314
|
+
api_key="YOUR_API_KEY",
|
|
7315
|
+
)
|
|
7316
|
+
client.workflow_sandboxes.deploy_workflow(
|
|
7317
|
+
id="id",
|
|
7318
|
+
)
|
|
7319
|
+
|
|
7320
|
+
```
|
|
7321
|
+
</dd>
|
|
7322
|
+
</dl>
|
|
7323
|
+
</dd>
|
|
7324
|
+
</dl>
|
|
7325
|
+
|
|
7326
|
+
#### ⚙️ Parameters
|
|
7327
|
+
|
|
7328
|
+
<dl>
|
|
7329
|
+
<dd>
|
|
6046
7330
|
|
|
6047
7331
|
<dl>
|
|
6048
7332
|
<dd>
|
|
6049
7333
|
|
|
6050
|
-
**
|
|
7334
|
+
**id:** `str` — A UUID string identifying this workflow sandbox.
|
|
6051
7335
|
|
|
6052
7336
|
</dd>
|
|
6053
7337
|
</dl>
|
|
@@ -6137,6 +7421,7 @@ List Workflow Sandbox examples that were previously cloned into the User's Works
|
|
|
6137
7421
|
from vellum import Vellum
|
|
6138
7422
|
|
|
6139
7423
|
client = Vellum(
|
|
7424
|
+
api_version="YOUR_API_VERSION",
|
|
6140
7425
|
api_key="YOUR_API_KEY",
|
|
6141
7426
|
)
|
|
6142
7427
|
client.workflow_sandboxes.list_workflow_sandbox_examples()
|
|
@@ -6200,10 +7485,26 @@ client.workflow_sandboxes.list_workflow_sandbox_examples()
|
|
|
6200
7485
|
</details>
|
|
6201
7486
|
|
|
6202
7487
|
## Workflows
|
|
6203
|
-
<details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">
|
|
7488
|
+
<details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">retrieve_state</a>(...)</code></summary>
|
|
7489
|
+
<dl>
|
|
7490
|
+
<dd>
|
|
7491
|
+
|
|
7492
|
+
#### 📝 Description
|
|
7493
|
+
|
|
7494
|
+
<dl>
|
|
7495
|
+
<dd>
|
|
7496
|
+
|
|
6204
7497
|
<dl>
|
|
6205
7498
|
<dd>
|
|
6206
7499
|
|
|
7500
|
+
Retrieve the current state of a workflow execution.
|
|
7501
|
+
|
|
7502
|
+
**Note:** Uses a base url of `https://predict.vellum.ai`.
|
|
7503
|
+
</dd>
|
|
7504
|
+
</dl>
|
|
7505
|
+
</dd>
|
|
7506
|
+
</dl>
|
|
7507
|
+
|
|
6207
7508
|
#### 🔌 Usage
|
|
6208
7509
|
|
|
6209
7510
|
<dl>
|
|
@@ -6216,10 +7517,11 @@ client.workflow_sandboxes.list_workflow_sandbox_examples()
|
|
|
6216
7517
|
from vellum import Vellum
|
|
6217
7518
|
|
|
6218
7519
|
client = Vellum(
|
|
7520
|
+
api_version="YOUR_API_VERSION",
|
|
6219
7521
|
api_key="YOUR_API_KEY",
|
|
6220
7522
|
)
|
|
6221
|
-
client.workflows.
|
|
6222
|
-
|
|
7523
|
+
client.workflows.retrieve_state(
|
|
7524
|
+
span_id="span_id",
|
|
6223
7525
|
)
|
|
6224
7526
|
|
|
6225
7527
|
```
|
|
@@ -6236,7 +7538,7 @@ client.workflows.push(
|
|
|
6236
7538
|
<dl>
|
|
6237
7539
|
<dd>
|
|
6238
7540
|
|
|
6239
|
-
**
|
|
7541
|
+
**span_id:** `str` — The span ID of the workflow execution to retrieve state for
|
|
6240
7542
|
|
|
6241
7543
|
</dd>
|
|
6242
7544
|
</dl>
|
|
@@ -6244,33 +7546,70 @@ client.workflows.push(
|
|
|
6244
7546
|
<dl>
|
|
6245
7547
|
<dd>
|
|
6246
7548
|
|
|
6247
|
-
**
|
|
7549
|
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
|
|
6248
7550
|
|
|
6249
7551
|
</dd>
|
|
6250
7552
|
</dl>
|
|
7553
|
+
</dd>
|
|
7554
|
+
</dl>
|
|
7555
|
+
|
|
7556
|
+
|
|
7557
|
+
</dd>
|
|
7558
|
+
</dl>
|
|
7559
|
+
</details>
|
|
6251
7560
|
|
|
7561
|
+
<details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">serialize_workflow_files</a>(...)</code></summary>
|
|
6252
7562
|
<dl>
|
|
6253
7563
|
<dd>
|
|
6254
7564
|
|
|
6255
|
-
|
|
6256
|
-
|
|
7565
|
+
#### 📝 Description
|
|
7566
|
+
|
|
7567
|
+
<dl>
|
|
7568
|
+
<dd>
|
|
7569
|
+
|
|
7570
|
+
<dl>
|
|
7571
|
+
<dd>
|
|
7572
|
+
|
|
7573
|
+
Serialize files
|
|
7574
|
+
</dd>
|
|
7575
|
+
</dl>
|
|
6257
7576
|
</dd>
|
|
6258
7577
|
</dl>
|
|
6259
7578
|
|
|
7579
|
+
#### 🔌 Usage
|
|
7580
|
+
|
|
6260
7581
|
<dl>
|
|
6261
7582
|
<dd>
|
|
6262
7583
|
|
|
6263
|
-
|
|
7584
|
+
<dl>
|
|
7585
|
+
<dd>
|
|
6264
7586
|
|
|
6265
|
-
|
|
6266
|
-
|
|
7587
|
+
```python
|
|
7588
|
+
from vellum import Vellum
|
|
7589
|
+
|
|
7590
|
+
client = Vellum(
|
|
7591
|
+
api_version="YOUR_API_VERSION",
|
|
7592
|
+
api_key="YOUR_API_KEY",
|
|
7593
|
+
)
|
|
7594
|
+
client.workflows.serialize_workflow_files(
|
|
7595
|
+
files={"files": {"key": "value"}},
|
|
7596
|
+
)
|
|
7597
|
+
|
|
7598
|
+
```
|
|
7599
|
+
</dd>
|
|
7600
|
+
</dl>
|
|
6267
7601
|
</dd>
|
|
6268
7602
|
</dl>
|
|
6269
7603
|
|
|
7604
|
+
#### ⚙️ Parameters
|
|
7605
|
+
|
|
7606
|
+
<dl>
|
|
7607
|
+
<dd>
|
|
7608
|
+
|
|
6270
7609
|
<dl>
|
|
6271
7610
|
<dd>
|
|
6272
7611
|
|
|
6273
|
-
**
|
|
7612
|
+
**files:** `typing.Dict[str, typing.Optional[typing.Any]]`
|
|
6274
7613
|
|
|
6275
7614
|
</dd>
|
|
6276
7615
|
</dl>
|
|
@@ -6278,7 +7617,7 @@ typing.Optional[core.File]` — See core.File for more documentation
|
|
|
6278
7617
|
<dl>
|
|
6279
7618
|
<dd>
|
|
6280
7619
|
|
|
6281
|
-
**
|
|
7620
|
+
**module:** `typing.Optional[str]`
|
|
6282
7621
|
|
|
6283
7622
|
</dd>
|
|
6284
7623
|
</dl>
|
|
@@ -6329,6 +7668,7 @@ Used to retrieve a Workspace Secret given its ID or name.
|
|
|
6329
7668
|
from vellum import Vellum
|
|
6330
7669
|
|
|
6331
7670
|
client = Vellum(
|
|
7671
|
+
api_version="YOUR_API_VERSION",
|
|
6332
7672
|
api_key="YOUR_API_KEY",
|
|
6333
7673
|
)
|
|
6334
7674
|
client.workspace_secrets.retrieve(
|
|
@@ -6399,6 +7739,7 @@ Used to update a Workspace Secret given its ID or name.
|
|
|
6399
7739
|
from vellum import Vellum
|
|
6400
7740
|
|
|
6401
7741
|
client = Vellum(
|
|
7742
|
+
api_version="YOUR_API_VERSION",
|
|
6402
7743
|
api_key="YOUR_API_KEY",
|
|
6403
7744
|
)
|
|
6404
7745
|
client.workspace_secrets.partial_update(
|
|
@@ -6486,6 +7827,7 @@ Retrieves information about the active Workspace
|
|
|
6486
7827
|
from vellum import Vellum
|
|
6487
7828
|
|
|
6488
7829
|
client = Vellum(
|
|
7830
|
+
api_version="YOUR_API_VERSION",
|
|
6489
7831
|
api_key="YOUR_API_KEY",
|
|
6490
7832
|
)
|
|
6491
7833
|
client.workspaces.workspace_identity()
|