vellum-ai 0.14.53__tar.gz → 0.14.55__tar.gz

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.14.53
+Version: 0.14.55
 Summary: 
 License: MIT
 Requires-Python: >=3.9,<4.0

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/ee/vellum_cli/logger.py

@@ -1,5 +1,6 @@
 import logging
 import os
+from typing import Optional
 
 
 class CLIFormatter(logging.Formatter):
@@ -34,3 +35,13 @@ def load_cli_logger() -> logging.Logger:
     logger.addHandler(handler)
 
     return logger
+
+
+def handle_cli_error(logger: logging.Logger, title: str, message: str, suggestion: Optional[str] = None):
+    logger.error("\n\033[1;31m✖ {}\033[0m".format(title))  # Bold red X and title
+    logger.error("\n\033[1m{}\033[0m".format(message))  # Bold message
+    if suggestion:
+        logger.error("\n\033[1;34mNext steps:\033[0m")  # Bold blue
+        logger.error(suggestion)
+
+    exit(1)

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/ee/vellum_cli/push.py

@@ -15,7 +15,7 @@ from vellum.types import WorkflowPushDeploymentConfigRequest
 from vellum.workflows.vellum_client import create_vellum_client
 from vellum.workflows.workflows.base import BaseWorkflow
 from vellum_cli.config import DEFAULT_WORKSPACE_CONFIG, WorkflowConfig, WorkflowDeploymentConfig, load_vellum_cli_config
-from vellum_cli.logger import load_cli_logger
+from vellum_cli.logger import handle_cli_error, load_cli_logger
 from vellum_ee.workflows.display.workflows.get_vellum_workflow_display_class import get_workflow_display
 
 
@@ -178,41 +178,39 @@ def push_command(
             strict=strict,
         )
     except ApiError as e:
-        if e.status_code != 400 or not isinstance(e.body, dict) or "diffs" not in e.body:
-            raise e
-
-        diffs: dict = e.body["diffs"]
-        generated_only = diffs.get("generated_only", [])
-        generated_only_str = (
-            "\n".join(
-                ["Files that were generated but not found in the original project:"]
-                + [f"- {file}" for file in generated_only]
+        if e.status_code == 400 and isinstance(e.body, dict) and "diffs" in e.body:
+            diffs: dict = e.body["diffs"]
+            generated_only = diffs.get("generated_only", [])
+            generated_only_str = (
+                "\n".join(
+                    ["Files that were generated but not found in the original project:"]
+                    + [f"- {file}" for file in generated_only]
+                )
+                if generated_only
+                else ""
             )
-            if generated_only
-            else ""
-        )
 
-        original_only = diffs.get("original_only", [])
-        original_only_str = (
-            "\n".join(
-                ["Files that were found in the original project but not generated:"]
-                + [f"- {file}" for file in original_only]
+            original_only = diffs.get("original_only", [])
+            original_only_str = (
+                "\n".join(
+                    ["Files that were found in the original project but not generated:"]
+                    + [f"- {file}" for file in original_only]
+                )
+                if original_only
+                else ""
             )
-            if original_only
-            else ""
-        )
 
-        modified = diffs.get("modified", {})
-        modified_str = (
-            "\n\n".join(
-                ["Files that were different between the original project and the generated artifact:"]
-                + ["\n".join(line.strip() for line in lines) for lines in modified.values()]
+            modified = diffs.get("modified", {})
+            modified_str = (
+                "\n\n".join(
+                    ["Files that were different between the original project and the generated artifact:"]
+                    + ["\n".join(line.strip() for line in lines) for lines in modified.values()]
+                )
+                if modified
+                else ""
             )
-            if modified
-            else ""
-        )
 
-        reported_diffs = f"""\
+            reported_diffs = f"""\
 {e.body.get("detail")}
 
 {generated_only_str}
@@ -221,8 +219,14 @@ def push_command(
 
 {modified_str}
 """
-        logger.error(reported_diffs)
-        return
+            logger.error(reported_diffs)
+            return
+
+        if e.status_code == 400 and isinstance(e.body, dict) and "detail" in e.body:
+            handle_cli_error(logger, title="API request to /workflows/push failed.", message=e.body["detail"])
+            return
+
+        raise e
 
     if dry_run:
         error_messages = [str(e) for e in workflow_display.errors]

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/ee/vellum_cli/tests/test_push.py

@@ -525,6 +525,37 @@ Files that were different between the original project and the generated artifac
     )
 
 
+def test_push__push_fails_due_to_400_error(mock_module, vellum_client):
+    # GIVEN a single workflow configured
+    temp_dir = mock_module.temp_dir
+    module = mock_module.module
+
+    # AND a workflow exists in the module successfully
+    _ensure_workflow_py(temp_dir, module)
+
+    # AND the push API call returns a 4xx response
+    vellum_client.workflows.push.side_effect = ApiError(
+        status_code=400,
+        body={
+            "detail": "Pushing the Workflow failed because you did something wrong",
+        },
+    )
+
+    # WHEN calling `vellum push` on strict mode
+    runner = CliRunner()
+    result = runner.invoke(cli_main, ["push", module])
+
+    # THEN it should fail with a user error code
+    assert result.exit_code == 1
+
+    # AND the error message should be in the error message
+    assert "API request to /workflows/push failed." in result.output
+    assert "Pushing the Workflow failed because you did something wrong" in result.output
+
+    # AND the stack trace should not be
+    assert "Traceback" not in result.output
+
+
 @pytest.mark.parametrize(
     "file_data",
     [

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/ee/vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_serialization.py

@@ -161,17 +161,12 @@ def test_serialize_workflow():
             },
         ],
         "outputs": [
-            {
-                "id": "e62bc785-a914-4066-b79e-8c89a5d0ec6c",
-                "name": "text",
-                "type": "STRING",
-                "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": ""}},
-            },
+            {"id": "e62bc785-a914-4066-b79e-8c89a5d0ec6c", "name": "text", "type": "STRING", "value": None},
             {
                 "id": "4674f1d9-e3af-411f-8a55-40a3a3ab5394",
                 "name": "chat_history",
                 "type": "CHAT_HISTORY",
-                "value": {"type": "CONSTANT_VALUE", "value": {"type": "JSON", "value": []}},
+                "value": None,
             },
         ],
     }

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/ee/vellum_ee/workflows/display/workflows/base_workflow_display.py

@@ -583,14 +583,30 @@ class BaseWorkflowDisplay(Generic[WorkflowType]):
         # DEPRECATED: This will be removed in the 0.15.0 release
         workflow_class: Optional[Type[BaseWorkflow]] = None,
     ) -> Union[WorkflowEventDisplayContext, None]:
-        workflow_display_module = f"{module_path}.display.workflow"
+        full_workflow_display_module_path = f"{module_path}.display.workflow"
         try:
-            display_class = importlib.import_module(workflow_display_module)
+            display_module = importlib.import_module(full_workflow_display_module_path)
         except ModuleNotFoundError:
+            logger.exception("Failed to import workflow display module: %s", full_workflow_display_module_path)
             return None
 
-        WorkflowDisplayClass = display_class.WorkflowDisplay
-        if not isinstance(WorkflowDisplayClass, type) or not issubclass(WorkflowDisplayClass, BaseWorkflowDisplay):
+        WorkflowDisplayClass: Optional[Type[BaseWorkflowDisplay]] = None
+        for name, definition in display_module.__dict__.items():
+            if name.startswith("_"):
+                continue
+
+            if (
+                not isinstance(definition, type)
+                or not issubclass(definition, BaseWorkflowDisplay)
+                or definition == BaseWorkflowDisplay
+            ):
+                continue
+
+            WorkflowDisplayClass = definition
+            break
+
+        if not WorkflowDisplayClass:
+            logger.exception("No workflow display class found in module: %s", full_workflow_display_module_path)
             return None
 
         return WorkflowDisplayClass().get_event_display_context()

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/ee/vellum_ee/workflows/tests/test_display_meta.py

@@ -54,3 +54,51 @@ def test_base_class_dynamic_import(files):
     }
     assert display_meta
     assert display_meta.model_dump(mode="json") == expected_result
+
+
+def test_gather_event_display_context__custom_workflow_name():
+    # GIVEN a workflow module with a custom workflow name
+    workflow_output_id = uuid4()
+    files = {
+        "__init__.py": "",
+        "workflow.py": """\
+from vellum.workflows import BaseWorkflow
+
+class MyCustomWorkflow(BaseWorkflow):
+    class Outputs(BaseWorkflow.Outputs):
+        answer = "foo"
+""",
+        "display/__init__.py": """\
+# flake8: noqa: F401, F403
+
+from .workflow import *
+""",
+        "display/workflow.py": f"""\
+from uuid import UUID
+from vellum_ee.workflows.display.workflows import BaseWorkflowDisplay
+from vellum_ee.workflows.display.base import WorkflowOutputDisplay
+from ..workflow import MyCustomWorkflow
+
+class MyCustomWorkflowDisplay(BaseWorkflowDisplay[MyCustomWorkflow]):
+    output_displays = {{
+        MyCustomWorkflow.Outputs.answer: WorkflowOutputDisplay(
+            id=UUID("{workflow_output_id}"), name="answer"
+        )
+    }}
+""",
+    }
+
+    namespace = str(uuid4())
+
+    # AND the virtual file loader is registered
+    sys.meta_path.append(VirtualFileFinder(files, namespace))
+
+    # WHEN the workflow display context is gathered
+    Workflow = BaseWorkflow.load_from_module(namespace)
+    display_meta = BaseWorkflowDisplay.gather_event_display_context(namespace, Workflow)
+
+    # THEN the workflow display context is successfully gathered
+    assert display_meta
+    assert display_meta.workflow_outputs == {
+        "answer": workflow_output_id,
+    }

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/pyproject.toml

@@ -3,7 +3,7 @@ name = "vellum-ai"
 
 [tool.poetry]
 name = "vellum-ai"
-version = "0.14.53"
+version = "0.14.55"
 description = ""
 readme = "README.md"
 authors = []

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/src/vellum/__init__.py

@@ -65,6 +65,7 @@ from .types import (
     CompilePromptMeta,
     ComponentsSchemasPdfSearchResultMetaSource,
     ComponentsSchemasPdfSearchResultMetaSourceRequest,
+    ComponentsSchemasPromptVersionBuildConfigSandbox,
     ConditionCombinator,
     ConditionalNodeResult,
     ConditionalNodeResultData,
@@ -316,6 +317,7 @@ from .types import (
     PromptRequestJsonInput,
     PromptRequestStringInput,
     PromptSettings,
+    PromptVersionBuildConfigSandbox,
     RawPromptExecutionOverridesRequest,
     ReductoChunkerConfig,
     ReductoChunkerConfigRequest,
@@ -688,6 +690,7 @@ __all__ = [
     "CompilePromptMeta",
     "ComponentsSchemasPdfSearchResultMetaSource",
     "ComponentsSchemasPdfSearchResultMetaSourceRequest",
+    "ComponentsSchemasPromptVersionBuildConfigSandbox",
     "ConditionCombinator",
     "ConditionalNodeResult",
     "ConditionalNodeResultData",
@@ -948,6 +951,7 @@ __all__ = [
     "PromptRequestJsonInput",
     "PromptRequestStringInput",
     "PromptSettings",
+    "PromptVersionBuildConfigSandbox",
     "RawPromptExecutionOverridesRequest",
     "ReductoChunkerConfig",
     "ReductoChunkerConfigRequest",

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/src/vellum/client/core/client_wrapper.py

@@ -18,7 +18,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.14.53",
+            "X-Fern-SDK-Version": "0.14.55",
         }
         headers["X-API-KEY"] = self.api_key
         return headers

{vellum_ai-0.14.53 → vellum_ai-0.14.55}/src/vellum/client/reference.md

@@ -1932,7 +1932,8 @@ client.deployments.retrieve(
 <dl>
 <dd>
 
-Retrieve a specific Deployment History Item by either its UUID or the name of a Release Tag that points to it.
+DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
+`retrieve_prompt_deployment_release` xendpoint instead.
 </dd>
 </dl>
 </dd>
@@ -2267,7 +2268,7 @@ client.deployments.update_deployment_release_tag(
 </dl>
 </details>
 
-<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_provider_payload</a>(...)</code></summary>
+<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_prompt_deployment_release</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -2279,16 +2280,7 @@ client.deployments.update_deployment_release_tag(
 <dl>
 <dd>
 
-Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider
-for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
-prompt or make an API call to the model provider.
-
-This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
-to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
-that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
-derive meaning from the response body and instead, should simply pass it directly to the model provider as is.
-
-We encourage you to seek advise from Vellum Support before integrating with this API for production use.
+Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
 </dd>
 </dl>
 </dd>
@@ -2303,18 +2295,14 @@ We encourage you to seek advise from Vellum Support before integrating with this
 <dd>
 
 ```python
-from vellum import StringInputRequest, Vellum
+from vellum import Vellum
 
 client = Vellum(
     api_key="YOUR_API_KEY",
 )
-client.deployments.retrieve_provider_payload(
-    inputs=[
-        StringInputRequest(
-            name="name",
-            value="value",
-        )
-    ],
+client.deployments.retrieve_prompt_deployment_release(
+    id="id",
+    release_id_or_release_tag="release_id_or_release_tag",
 )
 
 ```
@@ -2331,31 +2319,7 @@ client.deployments.retrieve_provider_payload(
 <dl>
 <dd>
 
-**inputs:** `typing.Sequence[PromptDeploymentInputRequest]` — The list of inputs defined in the Prompt's deployment with their corresponding values.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**deployment_id:** `typing.Optional[str]` — The ID of the deployment. Must provide either this or deployment_name.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**deployment_name:** `typing.Optional[str]` — The name of the deployment. Must provide either this or deployment_id.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
+**id:** `str` — A UUID string identifying this deployment.
     
 </dd>
 </dl>
@@ -2363,7 +2327,7 @@ client.deployments.retrieve_provider_payload(
 <dl>
 <dd>
 
-**expand_meta:** `typing.Optional[CompilePromptDeploymentExpandMetaRequest]` 
+**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.
     
 </dd>
 </dl>
@@ -2383,8 +2347,7 @@ client.deployments.retrieve_provider_payload(
 </dl>
 </details>
 
-## ReleaseReviews
-<details><summary><code>client.release_reviews.<a href="src/vellum/resources/release_reviews/client.py">retrieve_prompt_deployment_release</a>(...)</code></summary>
+<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_provider_payload</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -2396,7 +2359,16 @@ client.deployments.retrieve_provider_payload(
 <dl>
 <dd>
 
-Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
+Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider
+for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
+prompt or make an API call to the model provider.
+
+This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
+to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
+that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
+derive meaning from the response body and instead, should simply pass it directly to the model provider as is.
+
+We encourage you to seek advise from Vellum Support before integrating with this API for production use.
 </dd>
 </dl>
 </dd>
@@ -2411,14 +2383,18 @@ Retrieve a specific Prompt Deployment Release by either its UUID or the name of
 <dd>
 
 ```python
-from vellum import Vellum
+from vellum import StringInputRequest, Vellum
 
 client = Vellum(
     api_key="YOUR_API_KEY",
 )
-client.release_reviews.retrieve_prompt_deployment_release(
-    id="id",
-    release_id_or_release_tag="release_id_or_release_tag",
+client.deployments.retrieve_provider_payload(
+    inputs=[
+        StringInputRequest(
+            name="name",
+            value="value",
+        )
+    ],
 )
 
 ```
@@ -2435,7 +2411,7 @@ client.release_reviews.retrieve_prompt_deployment_release(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this deployment.
+**inputs:** `typing.Sequence[PromptDeploymentInputRequest]` — The list of inputs defined in the Prompt's deployment with their corresponding values.
     
 </dd>
 </dl>
@@ -2443,7 +2419,7 @@ client.release_reviews.retrieve_prompt_deployment_release(
 <dl>
 <dd>
 
-**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.
+**deployment_id:** `typing.Optional[str]` — The ID of the deployment. Must provide either this or deployment_name.
     
 </dd>
 </dl>
@@ -2451,70 +2427,15 @@ client.release_reviews.retrieve_prompt_deployment_release(
 <dl>
 <dd>
 
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**deployment_name:** `typing.Optional[str]` — The name of the deployment. Must provide either this or deployment_id.
     
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.release_reviews.<a href="src/vellum/resources/release_reviews/client.py">retrieve_workflow_deployment_release</a>(...)</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```python
-from vellum import Vellum
-
-client = Vellum(
-    api_key="YOUR_API_KEY",
-)
-client.release_reviews.retrieve_workflow_deployment_release(
-    id="id",
-    release_id_or_release_tag="release_id_or_release_tag",
-)
-
-```
-</dd>
-</dl>
 </dd>
 </dl>
 
-#### ⚙️ Parameters
-
 <dl>
 <dd>
 
-<dl>
-<dd>
-
-**id:** `str` — A UUID string identifying this workflow deployment.
+**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
     
 </dd>
 </dl>
@@ -2522,7 +2443,7 @@ client.release_reviews.retrieve_workflow_deployment_release(
 <dl>
 <dd>
 
-**release_id_or_release_tag:** `str` — Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve.
+**expand_meta:** `typing.Optional[CompilePromptDeploymentExpandMetaRequest]` 
     
 </dd>
 </dl>
@@ -5664,7 +5585,8 @@ client.workflow_deployments.workflow_deployment_event_execution(
 <dl>
 <dd>
 
-Retrieve a specific Workflow Deployment History Item by either its UUID or the name of a Release Tag that points to it.
+DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
+`retrieve_workflow_deployment_release` endpoint instead.
 </dd>
 </dl>
 </dd>
@@ -5995,6 +5917,86 @@ client.workflow_deployments.update_workflow_release_tag(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## ReleaseReviews
+<details><summary><code>client.release_reviews.<a href="src/vellum/resources/release_reviews/client.py">retrieve_workflow_deployment_release</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import Vellum
+
+client = Vellum(
+    api_key="YOUR_API_KEY",
+)
+client.release_reviews.retrieve_workflow_deployment_release(
+    id="id",
+    release_id_or_release_tag="release_id_or_release_tag",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `str` — A UUID string identifying this workflow deployment.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**release_id_or_release_tag:** `str` — Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>