vellum-ai 0.14.34__py3-none-any.whl → 0.14.36__py3-none-any.whl

vellum/__init__.py

@@ -300,6 +300,9 @@ from .types import (
     PromptDeploymentExpandMetaRequest,
     PromptDeploymentInputRequest,
     PromptDeploymentParentContext,
+    PromptDeploymentRelease,
+    PromptDeploymentReleasePromptDeployment,
+    PromptDeploymentReleasePromptVersion,
     PromptExecConfig,
     PromptExecutionMeta,
     PromptNodeExecutionMeta,
@@ -507,6 +510,7 @@ from .types import (
     WorkflowDeploymentParentContext,
     WorkflowDeploymentRead,
     WorkflowDeploymentRelease,
+    WorkflowDeploymentReleaseWorkflowDeployment,
     WorkflowDeploymentReleaseWorkflowVersion,
     WorkflowError,
     WorkflowEventDisplayContext,
@@ -921,6 +925,9 @@ __all__ = [
     "PromptDeploymentExpandMetaRequest",
     "PromptDeploymentInputRequest",
     "PromptDeploymentParentContext",
+    "PromptDeploymentRelease",
+    "PromptDeploymentReleasePromptDeployment",
+    "PromptDeploymentReleasePromptVersion",
     "PromptExecConfig",
     "PromptExecutionMeta",
     "PromptNodeExecutionMeta",
@@ -1130,6 +1137,7 @@ __all__ = [
     "WorkflowDeploymentParentContext",
     "WorkflowDeploymentRead",
     "WorkflowDeploymentRelease",
+    "WorkflowDeploymentReleaseWorkflowDeployment",
     "WorkflowDeploymentReleaseWorkflowVersion",
     "WorkflowDeploymentsListRequestStatus",
     "WorkflowError",

vellum/client/__init__.py

@@ -7,6 +7,7 @@ from .core.client_wrapper import SyncClientWrapper
 from .resources.ad_hoc.client import AdHocClient
 from .resources.container_images.client import ContainerImagesClient
 from .resources.deployments.client import DeploymentsClient
+from .resources.release_reviews.client import ReleaseReviewsClient
 from .resources.document_indexes.client import DocumentIndexesClient
 from .resources.documents.client import DocumentsClient
 from .resources.folder_entities.client import FolderEntitiesClient
@@ -18,7 +19,6 @@ from .resources.sandboxes.client import SandboxesClient
 from .resources.test_suite_runs.client import TestSuiteRunsClient
 from .resources.test_suites.client import TestSuitesClient
 from .resources.workflow_deployments.client import WorkflowDeploymentsClient
-from .resources.release_reviews.client import ReleaseReviewsClient
 from .resources.workflow_sandboxes.client import WorkflowSandboxesClient
 from .resources.workflows.client import WorkflowsClient
 from .resources.workspace_secrets.client import WorkspaceSecretsClient
@@ -65,6 +65,7 @@ from .core.client_wrapper import AsyncClientWrapper
 from .resources.ad_hoc.client import AsyncAdHocClient
 from .resources.container_images.client import AsyncContainerImagesClient
 from .resources.deployments.client import AsyncDeploymentsClient
+from .resources.release_reviews.client import AsyncReleaseReviewsClient
 from .resources.document_indexes.client import AsyncDocumentIndexesClient
 from .resources.documents.client import AsyncDocumentsClient
 from .resources.folder_entities.client import AsyncFolderEntitiesClient
@@ -76,7 +77,6 @@ from .resources.sandboxes.client import AsyncSandboxesClient
 from .resources.test_suite_runs.client import AsyncTestSuiteRunsClient
 from .resources.test_suites.client import AsyncTestSuitesClient
 from .resources.workflow_deployments.client import AsyncWorkflowDeploymentsClient
-from .resources.release_reviews.client import AsyncReleaseReviewsClient
 from .resources.workflow_sandboxes.client import AsyncWorkflowSandboxesClient
 from .resources.workflows.client import AsyncWorkflowsClient
 from .resources.workspace_secrets.client import AsyncWorkspaceSecretsClient
@@ -143,6 +143,7 @@ class Vellum:
         self.ad_hoc = AdHocClient(client_wrapper=self._client_wrapper)
         self.container_images = ContainerImagesClient(client_wrapper=self._client_wrapper)
         self.deployments = DeploymentsClient(client_wrapper=self._client_wrapper)
+        self.release_reviews = ReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.document_indexes = DocumentIndexesClient(client_wrapper=self._client_wrapper)
         self.documents = DocumentsClient(client_wrapper=self._client_wrapper)
         self.folder_entities = FolderEntitiesClient(client_wrapper=self._client_wrapper)
@@ -154,7 +155,6 @@ class Vellum:
         self.test_suite_runs = TestSuiteRunsClient(client_wrapper=self._client_wrapper)
         self.test_suites = TestSuitesClient(client_wrapper=self._client_wrapper)
         self.workflow_deployments = WorkflowDeploymentsClient(client_wrapper=self._client_wrapper)
-        self.release_reviews = ReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.workflow_sandboxes = WorkflowSandboxesClient(client_wrapper=self._client_wrapper)
         self.workflows = WorkflowsClient(client_wrapper=self._client_wrapper)
         self.workspace_secrets = WorkspaceSecretsClient(client_wrapper=self._client_wrapper)
@@ -1486,6 +1486,7 @@ class AsyncVellum:
         self.ad_hoc = AsyncAdHocClient(client_wrapper=self._client_wrapper)
         self.container_images = AsyncContainerImagesClient(client_wrapper=self._client_wrapper)
         self.deployments = AsyncDeploymentsClient(client_wrapper=self._client_wrapper)
+        self.release_reviews = AsyncReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.document_indexes = AsyncDocumentIndexesClient(client_wrapper=self._client_wrapper)
         self.documents = AsyncDocumentsClient(client_wrapper=self._client_wrapper)
         self.folder_entities = AsyncFolderEntitiesClient(client_wrapper=self._client_wrapper)
@@ -1497,7 +1498,6 @@ class AsyncVellum:
         self.test_suite_runs = AsyncTestSuiteRunsClient(client_wrapper=self._client_wrapper)
         self.test_suites = AsyncTestSuitesClient(client_wrapper=self._client_wrapper)
         self.workflow_deployments = AsyncWorkflowDeploymentsClient(client_wrapper=self._client_wrapper)
-        self.release_reviews = AsyncReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.workflow_sandboxes = AsyncWorkflowSandboxesClient(client_wrapper=self._client_wrapper)
         self.workflows = AsyncWorkflowsClient(client_wrapper=self._client_wrapper)
         self.workspace_secrets = AsyncWorkspaceSecretsClient(client_wrapper=self._client_wrapper)

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.34",
+            "X-Fern-SDK-Version": "0.14.36",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

vellum/client/resources/release_reviews/client.py

@@ -3,11 +3,12 @@
 from ...core.client_wrapper import SyncClientWrapper
 import typing
 from ...core.request_options import RequestOptions
-from ...types.workflow_deployment_release import WorkflowDeploymentRelease
+from ...types.prompt_deployment_release import PromptDeploymentRelease
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.pydantic_utilities import parse_obj_as
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
+from ...types.workflow_deployment_release import WorkflowDeploymentRelease
 from ...core.client_wrapper import AsyncClientWrapper
 
 
@@ -15,6 +16,60 @@ class ReleaseReviewsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
+    def retrieve_prompt_deployment_release(
+        self, id: str, release_id_or_release_tag: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PromptDeploymentRelease:
+        """
+        Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
+
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this deployment.
+
+        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.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptDeploymentRelease
+
+
+        Examples
+        --------
+        from vellum import 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",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/deployments/{jsonable_encoder(id)}/releases/{jsonable_encoder(release_id_or_release_tag)}",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptDeploymentRelease,
+                    parse_obj_as(
+                        type_=PromptDeploymentRelease,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
     def retrieve_workflow_deployment_release(
         self, id: str, release_id_or_release_tag: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> WorkflowDeploymentRelease:
@@ -74,6 +129,68 @@ class AsyncReleaseReviewsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
+    async def retrieve_prompt_deployment_release(
+        self, id: str, release_id_or_release_tag: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PromptDeploymentRelease:
+        """
+        Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
+
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this deployment.
+
+        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.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptDeploymentRelease
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.release_reviews.retrieve_prompt_deployment_release(
+                id="id",
+                release_id_or_release_tag="release_id_or_release_tag",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/deployments/{jsonable_encoder(id)}/releases/{jsonable_encoder(release_id_or_release_tag)}",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptDeploymentRelease,
+                    parse_obj_as(
+                        type_=PromptDeploymentRelease,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
     async def retrieve_workflow_deployment_release(
         self, id: str, release_id_or_release_tag: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> WorkflowDeploymentRelease:

vellum/client/types/__init__.py

@@ -308,6 +308,9 @@ from .prompt_block_state import PromptBlockState
 from .prompt_deployment_expand_meta_request import PromptDeploymentExpandMetaRequest
 from .prompt_deployment_input_request import PromptDeploymentInputRequest
 from .prompt_deployment_parent_context import PromptDeploymentParentContext
+from .prompt_deployment_release import PromptDeploymentRelease
+from .prompt_deployment_release_prompt_deployment import PromptDeploymentReleasePromptDeployment
+from .prompt_deployment_release_prompt_version import PromptDeploymentReleasePromptVersion
 from .prompt_exec_config import PromptExecConfig
 from .prompt_execution_meta import PromptExecutionMeta
 from .prompt_node_execution_meta import PromptNodeExecutionMeta
@@ -531,6 +534,7 @@ from .workflow_deployment_history_item import WorkflowDeploymentHistoryItem
 from .workflow_deployment_parent_context import WorkflowDeploymentParentContext
 from .workflow_deployment_read import WorkflowDeploymentRead
 from .workflow_deployment_release import WorkflowDeploymentRelease
+from .workflow_deployment_release_workflow_deployment import WorkflowDeploymentReleaseWorkflowDeployment
 from .workflow_deployment_release_workflow_version import WorkflowDeploymentReleaseWorkflowVersion
 from .workflow_error import WorkflowError
 from .workflow_event_display_context import WorkflowEventDisplayContext
@@ -901,6 +905,9 @@ __all__ = [
     "PromptDeploymentExpandMetaRequest",
     "PromptDeploymentInputRequest",
     "PromptDeploymentParentContext",
+    "PromptDeploymentRelease",
+    "PromptDeploymentReleasePromptDeployment",
+    "PromptDeploymentReleasePromptVersion",
     "PromptExecConfig",
     "PromptExecutionMeta",
     "PromptNodeExecutionMeta",
@@ -1108,6 +1115,7 @@ __all__ = [
     "WorkflowDeploymentParentContext",
     "WorkflowDeploymentRead",
     "WorkflowDeploymentRelease",
+    "WorkflowDeploymentReleaseWorkflowDeployment",
     "WorkflowDeploymentReleaseWorkflowVersion",
     "WorkflowError",
     "WorkflowEventDisplayContext",

vellum/client/types/prompt_deployment_release.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import datetime as dt
+from .release_environment import ReleaseEnvironment
+import typing
+from .release_created_by import ReleaseCreatedBy
+from .prompt_deployment_release_prompt_version import PromptDeploymentReleasePromptVersion
+from .prompt_deployment_release_prompt_deployment import PromptDeploymentReleasePromptDeployment
+from .release_release_tag import ReleaseReleaseTag
+from .slim_release_review import SlimReleaseReview
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PromptDeploymentRelease(UniversalBaseModel):
+    id: str
+    created: dt.datetime
+    environment: ReleaseEnvironment
+    created_by: typing.Optional[ReleaseCreatedBy] = None
+    prompt_version: PromptDeploymentReleasePromptVersion
+    deployment: PromptDeploymentReleasePromptDeployment
+    description: typing.Optional[str] = None
+    release_tags: typing.List[ReleaseReleaseTag]
+    reviews: typing.List[SlimReleaseReview]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum/client/types/prompt_deployment_release_prompt_deployment.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class PromptDeploymentReleasePromptDeployment(UniversalBaseModel):
+    name: str
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum/client/types/prompt_deployment_release_prompt_version.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class PromptDeploymentReleasePromptVersion(UniversalBaseModel):
+    id: str
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum/client/types/workflow_deployment_release.py

@@ -8,6 +8,7 @@ from .release_environment import ReleaseEnvironment
 import typing
 from .release_created_by import ReleaseCreatedBy
 from .workflow_deployment_release_workflow_version import WorkflowDeploymentReleaseWorkflowVersion
+from .workflow_deployment_release_workflow_deployment import WorkflowDeploymentReleaseWorkflowDeployment
 from .release_release_tag import ReleaseReleaseTag
 from .slim_release_review import SlimReleaseReview
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
@@ -21,6 +22,7 @@ class WorkflowDeploymentRelease(UniversalBaseModel):
     environment: ReleaseEnvironment
     created_by: typing.Optional[ReleaseCreatedBy] = None
     workflow_version: WorkflowDeploymentReleaseWorkflowVersion
+    deployment: WorkflowDeploymentReleaseWorkflowDeployment
     description: typing.Optional[str] = None
     release_tags: typing.List[ReleaseReleaseTag]
     reviews: typing.List[SlimReleaseReview]

vellum/client/types/workflow_deployment_release_workflow_deployment.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class WorkflowDeploymentReleaseWorkflowDeployment(UniversalBaseModel):
+    name: str
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum/types/prompt_deployment_release.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.prompt_deployment_release import *

vellum/types/prompt_deployment_release_prompt_deployment.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.prompt_deployment_release_prompt_deployment import *

vellum/types/prompt_deployment_release_prompt_version.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.prompt_deployment_release_prompt_version import *

vellum/types/workflow_deployment_release_workflow_deployment.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.workflow_deployment_release_workflow_deployment import *

vellum/workflows/nodes/displayable/guardrail_node/node.py

@@ -34,6 +34,7 @@ class GuardrailNode(BaseNode[StateType], Generic[StateType]):
 
     class Outputs(BaseOutputs):
         score: float
+        normalized_score: Optional[float]
         log: Optional[str]
 
     def run(self) -> Outputs:
@@ -46,16 +47,30 @@ class GuardrailNode(BaseNode[StateType], Generic[StateType]):
 
         metric_outputs = {output.name: output.value for output in metric_execution.outputs}
 
-        score = metric_outputs.get("score")
+        SCORE_KEY = "score"
+        NORMALIZED_SCORE_KEY = "normalized_score"
+        LOG_KEY = "log"
+
+        score = metric_outputs.get(SCORE_KEY)
         if not isinstance(score, float):
             raise NodeException(
-                message="Metric execution must have one output named 'score' with type 'float'",
+                message=f"Metric execution must have one output named '{SCORE_KEY}' with type 'float'",
                 code=WorkflowErrorCode.INVALID_OUTPUTS,
             )
-        metric_outputs.pop("score")
+        metric_outputs.pop(SCORE_KEY)
+
+        if NORMALIZED_SCORE_KEY in metric_outputs:
+            normalized_score = metric_outputs.pop(NORMALIZED_SCORE_KEY)
+            if not isinstance(normalized_score, float):
+                raise NodeException(
+                    message=f"Metric execution must have one output named '{NORMALIZED_SCORE_KEY}' with type 'float'",
+                    code=WorkflowErrorCode.INVALID_OUTPUTS,
+                )
+        else:
+            normalized_score = None
 
-        if "log" in metric_outputs:
-            log = metric_outputs.pop("log") or ""
+        if LOG_KEY in metric_outputs:
+            log = metric_outputs.pop(LOG_KEY) or ""
             if not isinstance(log, str):
                 raise NodeException(
                     message="Metric execution log output must be of type 'str'",
@@ -64,7 +79,7 @@ class GuardrailNode(BaseNode[StateType], Generic[StateType]):
         else:
             log = None
 
-        return self.Outputs(score=score, log=log, **metric_outputs)
+        return self.Outputs(score=score, normalized_score=normalized_score, log=log, **metric_outputs)
 
     def _compile_metric_inputs(self) -> List[MetricDefinitionInput]:
         # TODO: We may want to consolidate with prompt deployment input compilation

vellum/workflows/nodes/displayable/guardrail_node/test_node.py

@@ -3,6 +3,8 @@ import pytest
 from vellum import TestSuiteRunMetricNumberOutput
 from vellum.client.types.metric_definition_execution import MetricDefinitionExecution
 from vellum.client.types.test_suite_run_metric_string_output import TestSuiteRunMetricStringOutput
+from vellum.workflows.errors import WorkflowErrorCode
+from vellum.workflows.exceptions import NodeException
 from vellum.workflows.nodes.displayable.guardrail_node.node import GuardrailNode
 
 
@@ -36,3 +38,64 @@ def test_run_guardrail_node__empty_log(vellum_client, log_value):
     # THEN the workflow should have completed successfully
     assert outputs.score == 0.6
     assert outputs.log == ""
+
+
+def test_run_guardrail_node__normalized_score(vellum_client):
+    """Confirm that we can successfully invoke a Guardrail Node"""
+
+    # GIVEN a Guardrail Node
+    class MyGuard(GuardrailNode):
+        metric_definition = "example_metric_definition"
+        metric_inputs = {}
+
+    # AND we know that the guardrail node will return a normalized score
+    mock_metric_execution = MetricDefinitionExecution(
+        outputs=[
+            TestSuiteRunMetricNumberOutput(
+                name="score",
+                value=0.6,
+            ),
+            TestSuiteRunMetricNumberOutput(
+                name="normalized_score",
+                value=1.0,
+            ),
+        ],
+    )
+    vellum_client.metric_definitions.execute_metric_definition.return_value = mock_metric_execution
+
+    # WHEN we run the Guardrail Node
+    outputs = MyGuard().run()
+
+    # THEN the workflow should have completed successfully
+    assert outputs.score == 0.6
+    assert outputs.normalized_score == 1.0
+
+
+def test_run_guardrail_node__normalized_score_null(vellum_client):
+    # GIVEN a Guardrail Node
+    class MyGuard(GuardrailNode):
+        metric_definition = "example_metric_definition"
+        metric_inputs = {}
+
+    # AND we know that the guardrail node will return a normalized score that is None
+    mock_metric_execution = MetricDefinitionExecution(
+        outputs=[
+            TestSuiteRunMetricNumberOutput(
+                name="score",
+                value=0.6,
+            ),
+            TestSuiteRunMetricNumberOutput(
+                name="normalized_score",
+                value=None,
+            ),
+        ],
+    )
+    vellum_client.metric_definitions.execute_metric_definition.return_value = mock_metric_execution
+
+    # WHEN we run the Guardrail Node
+    with pytest.raises(NodeException) as exc_info:
+        MyGuard().run()
+
+    # THEN we get an exception
+    assert exc_info.value.message == "Metric execution must have one output named 'normalized_score' with type 'float'"
+    assert exc_info.value.code == WorkflowErrorCode.INVALID_OUTPUTS

vellum/workflows/nodes/displayable/prompt_deployment_node/node.py

@@ -1,6 +1,7 @@
 import json
-from typing import Iterator
+from typing import Any, Dict, Iterator, Type, Union
 
+from vellum.workflows.constants import undefined
 from vellum.workflows.errors import WorkflowErrorCode
 from vellum.workflows.exceptions import NodeException
 from vellum.workflows.nodes.displayable.bases import BasePromptDeploymentNode as BasePromptDeploymentNode
@@ -11,7 +12,7 @@ from vellum.workflows.types.generics import StateType
 
 class PromptDeploymentNode(BasePromptDeploymentNode[StateType]):
     """
-    Used to execute a Prompt Deployment and surface a string output for convenience.
+    Used to execute a Prompt Deployment and surface a string output and json output if applicable for convenience.
 
     prompt_inputs: EntityInputsInterface - The inputs for the Prompt
     deployment: Union[UUID, str] - Either the Prompt Deployment's UUID or its name.
@@ -33,9 +34,11 @@ class PromptDeploymentNode(BasePromptDeploymentNode[StateType]):
         The outputs of the PromptDeploymentNode.
 
         text: str - The result of the Prompt Execution
+        json: Optional[Dict[Any, Any]] - The result of the Prompt Execution in JSON format
         """
 
         text: str
+        json: Union[Dict[Any, Any], Type[undefined]] = undefined
 
     def run(self) -> Iterator[BaseOutput]:
         outputs = yield from self._process_prompt_event_stream()
@@ -46,12 +49,18 @@ class PromptDeploymentNode(BasePromptDeploymentNode[StateType]):
             )
 
         string_outputs = []
+        json_output = None
+
         for output in outputs:
             if output.value is None:
                 continue
 
             if output.type == "STRING":
                 string_outputs.append(output.value)
+                try:
+                    json_output = json.loads(output.value)
+                except (json.JSONDecodeError, TypeError):
+                    pass
             elif output.type == "JSON":
                 string_outputs.append(json.dumps(output.value, indent=4))
             elif output.type == "FUNCTION_CALL":
@@ -61,3 +70,6 @@ class PromptDeploymentNode(BasePromptDeploymentNode[StateType]):
 
         value = "\n".join(string_outputs)
         yield BaseOutput(name="text", value=value)
+
+        if json_output:
+            yield BaseOutput(name="json", value=json_output)

vellum/workflows/nodes/displayable/prompt_deployment_node/tests/test_node.py

@@ -151,3 +151,46 @@ def test_prompt_deployment_node__parent_context_serialization(mock_httpx_transpo
     request_execution_context = json.loads(call_request_args.read().decode("utf-8"))["execution_context"]
     assert request_execution_context["trace_id"] == str(trace_id)
     assert request_execution_context["parent_context"]
+
+
+def test_prompt_deployment_node__json_output(vellum_client):
+    # GIVEN a PromptDeploymentNode
+    class MyPromptDeploymentNode(PromptDeploymentNode):
+        deployment = "example_prompt_deployment"
+        prompt_inputs = {}
+
+    # AND a known JSON response from invoking a prompt deployment
+    expected_json = {"result": "Hello, world!"}
+    expected_outputs: List[PromptOutput] = [
+        StringVellumValue(value=json.dumps(expected_json)),
+    ]
+
+    def generate_prompt_events(*args: Any, **kwargs: Any) -> Iterator[ExecutePromptEvent]:
+        execution_id = str(uuid4())
+        events: List[ExecutePromptEvent] = [
+            InitiatedExecutePromptEvent(execution_id=execution_id),
+            FulfilledExecutePromptEvent(
+                execution_id=execution_id,
+                outputs=expected_outputs,
+            ),
+        ]
+        yield from events
+
+    vellum_client.execute_prompt_stream.side_effect = generate_prompt_events
+
+    # WHEN the node is run
+    node = MyPromptDeploymentNode()
+    outputs = [o for o in node.run()]
+
+    # THEN the node should have produced the outputs we expect
+    results_output = outputs[0]
+    assert results_output.name == "results"
+    assert results_output.value == expected_outputs
+
+    text_output = outputs[1]
+    assert text_output.name == "text"
+    assert text_output.value == '{"result": "Hello, world!"}'
+
+    json_output = outputs[2]
+    assert json_output.name == "json"
+    assert json_output.value == expected_json

vellum/workflows/state/base.py

@@ -2,6 +2,7 @@ from collections import defaultdict
 from copy import deepcopy
 from dataclasses import field
 from datetime import datetime
+import logging
 from queue import Queue
 from threading import Lock
 from uuid import UUID, uuid4
@@ -29,6 +30,8 @@ from vellum.workflows.types.utils import (
 if TYPE_CHECKING:
     from vellum.workflows.nodes.bases import BaseNode
 
+logger = logging.getLogger(__name__)
+
 
 class _Snapshottable:
     _snapshot_callback: Callable[[], None]
@@ -377,7 +380,10 @@ class BaseState(metaclass=_BaseStateMeta):
         Snapshots the current state to the workflow emitter. The invoked callback is overridden by the
         workflow runner.
         """
-        self.__snapshot_callback__(deepcopy(self))
+        try:
+            self.__snapshot_callback__(deepcopy(self))
+        except Exception:
+            logger.exception("Failed to snapshot Workflow state.")
 
     @classmethod
     def __get_pydantic_core_schema__(

vellum/workflows/state/tests/test_state.py

@@ -13,6 +13,16 @@ from vellum.workflows.state.encoder import DefaultStateEncoder
 snapshot_count: Dict[int, int] = defaultdict(int)
 
 
+@pytest.fixture()
+def mock_deepcopy(mocker):
+    return mocker.patch("vellum.workflows.state.base.deepcopy")
+
+
+@pytest.fixture
+def mock_logger(mocker):
+    return mocker.patch("vellum.workflows.state.base.logger")
+
+
 class MockState(BaseState):
     foo: str
     nested_dict: Dict[str, int] = {}
@@ -170,3 +180,42 @@ def test_state_json_serialization__with_queue():
 
     # THEN the state is serialized correctly with the queue turned into a list
     assert json_state["meta"]["node_outputs"] == {"MockNode.Outputs.baz": ["test1", "test2"]}
+
+
+def test_state_snapshot__deepcopy_fails__logs_error(mock_deepcopy, mock_logger):
+    # GIVEN an initial state instance
+    class MockState(BaseState):
+        foo: str
+
+    state = MockState(foo="bar")
+
+    # AND we have a snapshot callback that we are tracking
+    snapshot_count = 0
+
+    def __snapshot_callback__(state: "BaseState") -> None:
+        nonlocal snapshot_count
+        snapshot_count += 1
+
+    state.__snapshot_callback__ = __snapshot_callback__
+
+    # AND deepcopy fails the first time but succeeds the second time
+    deepcopy_side_effect_count = 0
+
+    def side_effect(*args, **kwargs):
+        nonlocal deepcopy_side_effect_count
+        deepcopy_side_effect_count += 1
+        if deepcopy_side_effect_count == 1:
+            raise Exception("Failed to deepcopy")
+        return deepcopy(args[0])
+
+    mock_deepcopy.side_effect = side_effect
+
+    # WHEN we snapshot the state twice
+    state.__snapshot__()
+    state.__snapshot__()
+
+    # THEN we were able to invoke the callback once
+    assert snapshot_count == 1
+
+    # AND alert sentry once
+    assert mock_logger.exception.call_count == 1

{vellum_ai-0.14.34.dist-info → vellum_ai-0.14.36.dist-info}/METADATA

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

{vellum_ai-0.14.34.dist-info → vellum_ai-0.14.36.dist-info}/RECORD

@@ -7,7 +7,7 @@ vellum_cli/image_push.py,sha256=8DDvRDJEZ-FukUCqGW1827bg1ybF4xBbx9WyqWYQE-g,6816
 vellum_cli/init.py,sha256=WpnMXPItPmh0f0bBGIer3p-e5gu8DUGwSArT_FuoMEw,5093
 vellum_cli/logger.py,sha256=PuRFa0WCh4sAGFS5aqWB0QIYpS6nBWwPJrIXpWxugV4,1022
 vellum_cli/ping.py,sha256=p_BCCRjgPhng6JktuECtkDQLbhopt6JpmrtGoLnLJT8,1161
-vellum_cli/pull.py,sha256=YTo5cVCcp7RjS9lHednOuud4rW4bH7jqV3GMdbic_Uk,12002
+vellum_cli/pull.py,sha256=27Mh10aQ8H1OkTmQOJcOuJ5cQcYbNjkkuQrBmtkRe0o,12262
 vellum_cli/push.py,sha256=xjTNbLwOVFNU3kpBrm56Bk5QkSRrJ9z86qceghCzfIA,9655
 vellum_cli/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum_cli/tests/conftest.py,sha256=AFYZryKA2qnUuCPBxBKmHLFoPiE0WhBFFej9tNwSHdc,1526
@@ -16,7 +16,7 @@ vellum_cli/tests/test_image_push.py,sha256=i3lJuW8nFRwL1M1OF6752IZYvGAFgKmkB2hd_
 vellum_cli/tests/test_init.py,sha256=8UOc_ThfouR4ja5cCl_URuLk7ohr9JXfCnG4yka1OUQ,18754
 vellum_cli/tests/test_main.py,sha256=qDZG-aQauPwBwM6A2DIu1494n47v3pL28XakTbLGZ-k,272
 vellum_cli/tests/test_ping.py,sha256=3ucVRThEmTadlV9LrJdCCrr1Ofj3rOjG6ue0BNR2UC0,2523
-vellum_cli/tests/test_pull.py,sha256=fci5idbcAsnvfJcmP8KlULX4w4gkjLtXkn3iV4wsLZA,46472
+vellum_cli/tests/test_pull.py,sha256=5nIDX5yXLyi6p-siLvrzfaepI4RWbaoMwgFoQFUEhI0,46692
 vellum_cli/tests/test_push.py,sha256=zDv_Q1hbXtLwmTJDPRAvwDjbuHC09uNRYOy4FQujUow,23476
 vellum_ee/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum_ee/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -123,12 +123,12 @@ vellum_ee/workflows/tests/local_workflow/workflow.py,sha256=A4qOzOPNwePYxWbcAgIP
 vellum_ee/workflows/tests/test_display_meta.py,sha256=C25dErwghPNXio49pvSRxyOuc96srH6eYEwTAWdE2zY,2258
 vellum_ee/workflows/tests/test_server.py,sha256=SsOkS6sGO7uGC4mxvk4iv8AtcXs058P9hgFHzTWmpII,14519
 vellum_ee/workflows/tests/test_virtual_files.py,sha256=TJEcMR0v2S8CkloXNmCHA0QW0K6pYNGaIjraJz7sFvY,2762
-vellum/__init__.py,sha256=Ur02Hk_LtwXW45f-LBBtBhRX1xJRSq05ytaQUfgIGmc,40970
+vellum/__init__.py,sha256=hl6RSGwdQetF5BV0k-8eGbGDVhdnZDpYX7MQXpZ4c-0,41308
 vellum/client/README.md,sha256=JkCJjmMZl4jrPj46pkmL9dpK4gSzQQmP5I7z4aME4LY,4749
-vellum/client/__init__.py,sha256=ki-TDOmYzC0FePN7swDyE6UpHFQV_4dK7lqy4h-3s1Y,118148
+vellum/client/__init__.py,sha256=Z-JHK2jGxhtTtmkLeOaUGGJWIUNYGNVBLvUewC6lp6w,118148
 vellum/client/core/__init__.py,sha256=SQ85PF84B9MuKnBwHNHWemSGuy-g_515gFYNFhvEE0I,1438
 vellum/client/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-vellum/client/core/client_wrapper.py,sha256=-wKm98fWVAP4wszQZhj8UDobt3IotWN6IYciYhNcNck,1869
+vellum/client/core/client_wrapper.py,sha256=xLCZEpnqwYGxZRQKKBufqucpuc1GH4onEtUKV7qvzdM,1869
 vellum/client/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 vellum/client/core/file.py,sha256=X9IbmkZmB2bB_DpmZAO3crWdXagOakAyn6UCOCImCPg,2322
 vellum/client/core/http_client.py,sha256=R0pQpCppnEtxccGvXl4uJ76s7ro_65Fo_erlNNLp_AI,19228
@@ -173,7 +173,7 @@ vellum/client/resources/organizations/client.py,sha256=Uye92moqjAcOCs4astmuFpT92
 vellum/client/resources/prompts/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 vellum/client/resources/prompts/client.py,sha256=_rNTUjhl_ZF3vyQa_M1BSTrX4DlFXU_SXkwwCEYKD2s,6598
 vellum/client/resources/release_reviews/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-vellum/client/resources/release_reviews/client.py,sha256=6u7qYK_fpRZzizYnFtUS06Q41RqEzSsre6RQwRimf8w,5088
+vellum/client/resources/release_reviews/client.py,sha256=VLXcmw1o8cYYtdTJQpajJWE2ve1z40_IXIbQRQIhqpY,9395
 vellum/client/resources/sandboxes/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 vellum/client/resources/sandboxes/client.py,sha256=SG4BV0NG1Ow10mXSu52ybj-c6hR7wcNxfGJK4eiHu_8,17670
 vellum/client/resources/test_suite_runs/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
@@ -195,7 +195,7 @@ vellum/client/resources/workspace_secrets/__init__.py,sha256=FTtvy8EDg9nNNg9WCat
 vellum/client/resources/workspace_secrets/client.py,sha256=h7UzXLyTttPq1t-JZGMg1BWxypxJvBGUdqg7KGT7MK4,8027
 vellum/client/resources/workspaces/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 vellum/client/resources/workspaces/client.py,sha256=RthwzN1o-Jxwg5yyNNodavFyNUSxfLoTv26w3mRR5g8,3595
-vellum/client/types/__init__.py,sha256=ZGqDXdE0b5IdJIYVcPEUZ33lgiV5Jy47KM1c5OzyDok,61976
+vellum/client/types/__init__.py,sha256=vfEaeh8-2xzhzeFo8j-OnbmezsjCd4EJS4zhxuw_JbE,62505
 vellum/client/types/ad_hoc_execute_prompt_event.py,sha256=bCjujA2XsOgyF3bRZbcEqV2rOIymRgsLoIRtZpB14xg,607
 vellum/client/types/ad_hoc_expand_meta.py,sha256=1gv-NCsy_6xBYupLvZH979yf2VMdxAU-l0y0ynMKZaw,1331
 vellum/client/types/ad_hoc_fulfilled_prompt_execution_meta.py,sha256=Bfvf1d_dkmshxRACVM5vcxbH_7AQY23RmrrnPc0ytYY,939
@@ -492,6 +492,9 @@ vellum/client/types/prompt_block_state.py,sha256=BRAzTYARoSU36IVZGWMeeqhl5fgFMXC
 vellum/client/types/prompt_deployment_expand_meta_request.py,sha256=agsiAaHB6lDoZPlnfJ2nmhB4Ud4EiJJTX05YmduyCPo,1910
 vellum/client/types/prompt_deployment_input_request.py,sha256=KrT4-Ew2VvTWXEkYQz2oyHn5EDOgrMW7FzRFaPH3ARg,353
 vellum/client/types/prompt_deployment_parent_context.py,sha256=eu8dYmRb789uZeFVzbRkJrErDYZXo35f2qaNBcY0wOQ,2319
+vellum/client/types/prompt_deployment_release.py,sha256=H6sluuxANsoaX6gA9lw76lJkTECuxFofSeetKF00ze0,1346
+vellum/client/types/prompt_deployment_release_prompt_deployment.py,sha256=tj8g0qEJyAuijxRBUV6nO2IITEorqVY-C37oqiWg6Po,582
+vellum/client/types/prompt_deployment_release_prompt_version.py,sha256=NELGH68M8-SFtdci1Ygg0FpgjYeZgmBjfFke2m3GP8Y,577
 vellum/client/types/prompt_exec_config.py,sha256=kthvyEe-IzfTpOBd1fYrczHuxD-v7k6cwjmuaY170RQ,1390
 vellum/client/types/prompt_execution_meta.py,sha256=3hhMZgdAR5mKfnh2e_eVN3oKfT0E9w26khVPrpjn7jk,1141
 vellum/client/types/prompt_node_execution_meta.py,sha256=IyWH__nCp5uwS0N32b2ZEsA-Fv7AZDB4nnlRZayU2Gc,888
@@ -698,7 +701,8 @@ vellum/client/types/workflow_deployment_event_executions_response.py,sha256=x7mZ
 vellum/client/types/workflow_deployment_history_item.py,sha256=4WUPzcthBvEZ7iaisKfEg0soUtHjcTEnL_VUVaKpTyw,1420
 vellum/client/types/workflow_deployment_parent_context.py,sha256=QNyPj2o-jauaC48KrRjCWan1IKIbDgyuxLxURmhXsXM,2347
 vellum/client/types/workflow_deployment_read.py,sha256=tp1WaojTVE_dz1oiZ97h8ixMbIWDgy2yRu08A7wPMpw,2363
-vellum/client/types/workflow_deployment_release.py,sha256=UshzYZE5Fv1hAwztaMTD1Fs0JNQqbeNus0IrwXLkKL0,1444
+vellum/client/types/workflow_deployment_release.py,sha256=1OveujSLRID7B6aGGjqsN5R8MbEHn3SS0sp3dj22DQs,1609
+vellum/client/types/workflow_deployment_release_workflow_deployment.py,sha256=irWt901SImKChLayz7_52C1W7JldKiQHweqkjuMUoNQ,586
 vellum/client/types/workflow_deployment_release_workflow_version.py,sha256=NP3FoxLpgMUIK1OAPf_ei58mxE9F7BLAuw7q55CIcT8,989
 vellum/client/types/workflow_error.py,sha256=EQajkEmLS64T0wYm0goHQl0rT7Lguurk8pLwkhjsgAI,282
 vellum/client/types/workflow_event_display_context.py,sha256=tnO9lgIJKnLtuS6xum_QilI83LjOmnWCLtnSHLn1oNo,929
@@ -1157,6 +1161,9 @@ vellum/types/prompt_block_state.py,sha256=tKqNrZnHWjvfGS_6oIUTpdCPGxvRJa31Le6qWL
 vellum/types/prompt_deployment_expand_meta_request.py,sha256=5dBdvjjK9zCKxrPMdKQPj6iG8A06GAlb_zazde6qZsU,175
 vellum/types/prompt_deployment_input_request.py,sha256=z8CxCZWnKW8BBZajQ6iDnz-2gaxU-FrnYrVe_MvC3FU,169
 vellum/types/prompt_deployment_parent_context.py,sha256=U9X9PvXhG6ZUE8RxLrH13xfqKvs3DOwbxzWmujoXTbg,170
+vellum/types/prompt_deployment_release.py,sha256=jr4iRA0A6HaHbI1EINxUPLZrRCi6uKWOnvjxQZyu7bg,163
+vellum/types/prompt_deployment_release_prompt_deployment.py,sha256=WetrclgECqyJ6ppPp-dNaaHRt7ayawa9wszRBn3p2OE,181
+vellum/types/prompt_deployment_release_prompt_version.py,sha256=cFVyvBTHjiTSpA2SrFS_SkbB26UDigaBUSJmKh1SEkg,178
 vellum/types/prompt_exec_config.py,sha256=aNeOGDi6l2rVzvkFt8CJE6L3W2EmY8gZaSb5051w8as,156
 vellum/types/prompt_execution_meta.py,sha256=_5izDjusf-TM69zKhvXr5EHH4Fx9jfWkg8F5_KNJV-w,159
 vellum/types/prompt_node_execution_meta.py,sha256=cJoHlIn_lb_sLpQniB8eszRJvFI6mJij9QgUIiKtiCY,164
@@ -1364,6 +1371,7 @@ vellum/types/workflow_deployment_history_item.py,sha256=dp5pwzOVO83KPwAbYeO3NXlK
 vellum/types/workflow_deployment_parent_context.py,sha256=kB0eeRXagHqRnuDVA9B8aDlvBZVOmQ702JYXD8evh24,172
 vellum/types/workflow_deployment_read.py,sha256=dDGG27VP0bvC565JzeSOHJ-5Pvs7eCF4R8F9k8316bo,162
 vellum/types/workflow_deployment_release.py,sha256=lBnOc5Tw2-jLGWmthzkwdaLGvylcDiarO-maZSote0A,165
+vellum/types/workflow_deployment_release_workflow_deployment.py,sha256=8qT32r--NyJppqBizD9QP6jvM5YdcsdpGEtaKMG1RbE,185
 vellum/types/workflow_deployment_release_workflow_version.py,sha256=l5SJrY9z3lG5K82V2wY2sY50V40CQWKl95nDjnHu4Dc,182
 vellum/types/workflow_error.py,sha256=7rZcYJG5jYr4IbEvgv57G6Lxutrdg43SD8mUerd58_A,152
 vellum/types/workflow_event_display_context.py,sha256=jiH4vHlWYdT_2zM8yxPox3fXjnFStzIO46N90B2TdNA,168
@@ -1577,8 +1585,8 @@ vellum/workflows/nodes/displayable/final_output_node/node.py,sha256=PuQ0RvtAmoSI
 vellum/workflows/nodes/displayable/final_output_node/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum/workflows/nodes/displayable/final_output_node/tests/test_node.py,sha256=E6LQ74qZjY4Xi4avx2qdOCgGhF8pEcNLBh8cqYRkzMI,709
 vellum/workflows/nodes/displayable/guardrail_node/__init__.py,sha256=Ab5eXmOoBhyV4dMWdzh32HLUmnPIBEK_zFCT38C4Fng,68
-vellum/workflows/nodes/displayable/guardrail_node/node.py,sha256=A9_vuahgKSemPAZdrDJilWwciLhOBTcxINXRnUHQl_g,4427
-vellum/workflows/nodes/displayable/guardrail_node/test_node.py,sha256=1yPIAt4_GWiUKT6u3rTW2XKp62b8xG8Jj3JWeCm5ZDM,1368
+vellum/workflows/nodes/displayable/guardrail_node/node.py,sha256=AHyqBiP9_XZx9jI-EbPY2dHDRwKrpo_SS6DAdrPBulA,5086
+vellum/workflows/nodes/displayable/guardrail_node/test_node.py,sha256=gpaa7fmVPLH2dDjlNTbjutF3SBXa_aearI3xYvZ4ekg,3533
 vellum/workflows/nodes/displayable/inline_prompt_node/__init__.py,sha256=gSUOoEZLlrx35-tQhSAd3An8WDwBqyiQh-sIebLU9wU,74
 vellum/workflows/nodes/displayable/inline_prompt_node/node.py,sha256=8RXZqWMzViUjFfbpmcy1gkSsKnEpci8BGwsuPYv4xMQ,3380
 vellum/workflows/nodes/displayable/inline_prompt_node/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1588,9 +1596,9 @@ vellum/workflows/nodes/displayable/merge_node/node.py,sha256=nZtGGVAvY4fvGg8vwV6
 vellum/workflows/nodes/displayable/note_node/__init__.py,sha256=KWA3P4fyYJ-fOTky8qNGlcOotQ-HeHJ9AjZt6mRQmCE,58
 vellum/workflows/nodes/displayable/note_node/node.py,sha256=sIN1VBQ7zeT3GhN0kupXbFfdpvgedWV79k4woJNp5IQ,394
 vellum/workflows/nodes/displayable/prompt_deployment_node/__init__.py,sha256=krX1Hds-TSVYZsx0wJFX4wsAKkEFYOX1ifwRGiIM-EA,82
-vellum/workflows/nodes/displayable/prompt_deployment_node/node.py,sha256=pb-KbrnfTRL7mmNtVAMmiCiys8raXkl5Od7sIu682xU,2707
+vellum/workflows/nodes/displayable/prompt_deployment_node/node.py,sha256=eUiQYdqJTrWhVcUgGAPJYEnRk6S71Yrzu5-c-XcVFs4,3243
 vellum/workflows/nodes/displayable/prompt_deployment_node/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vellum/workflows/nodes/displayable/prompt_deployment_node/tests/test_node.py,sha256=mHSecwE8bcwduM5wNKwDTzlLeh7ECdEEuT86BDgByPY,5798
+vellum/workflows/nodes/displayable/prompt_deployment_node/tests/test_node.py,sha256=nOFiv2s8MyRf6c6aQxJPhN6a0mk1dFL2HI8Gkfc09sk,7288
 vellum/workflows/nodes/displayable/search_node/__init__.py,sha256=hpBpvbrDYf43DElRZFLzieSn8weXiwNiiNOJurERQbs,62
 vellum/workflows/nodes/displayable/search_node/node.py,sha256=_VHHuTNN4icZBgc7O5U9SVKrv1zgKipU72fOtxTyrQU,1453
 vellum/workflows/nodes/displayable/search_node/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -1637,12 +1645,12 @@ vellum/workflows/runner/__init__.py,sha256=i1iG5sAhtpdsrlvwgH6B-m49JsINkiWyPWs8v
 vellum/workflows/runner/runner.py,sha256=ww4fjZJBENkB5HJxdj92kTz7k_EyifCeAreupy5qIxs,31813
 vellum/workflows/sandbox.py,sha256=GVJzVjMuYzOBnSrboB0_6MMRZWBluAyQ2o7syeaeBd0,2235
 vellum/workflows/state/__init__.py,sha256=yUUdR-_Vl7UiixNDYQZ-GEM_kJI9dnOia75TtuNEsnE,60
-vellum/workflows/state/base.py,sha256=Vkhneko3VlQrPsMLU1PYSzXU_W1u7_AraJsghiv5O-4,15512
+vellum/workflows/state/base.py,sha256=LOQ2UCnpVLWISryfJwbicFCrRmothJQ7OQGJElgKlvg,15675
 vellum/workflows/state/context.py,sha256=KOAI1wEGn8dGmhmAemJaf4SZbitP3jpIBcwKfznQaRE,3076
 vellum/workflows/state/encoder.py,sha256=TnOQojc5lTQ83g9QbpA4UCqShJvutmTMxbpKt-9gNe4,1911
 vellum/workflows/state/store.py,sha256=uVe-oN73KwGV6M6YLhwZMMUQhzTQomsVfVnb8V91gVo,1147
 vellum/workflows/state/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vellum/workflows/state/tests/test_state.py,sha256=jBynFR4m74Vn51DdmKBLkxb1loTy1CnJPtzPmdAFQUo,5159
+vellum/workflows/state/tests/test_state.py,sha256=m8f0jPTnK3i0W3wj5GTTRcetRrIBqBMklSA7Vev2nsg,6491
 vellum/workflows/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum/workflows/tests/test_sandbox.py,sha256=JKwaluI-lODQo7Ek9sjDstjL_WTdSqUlVik6ZVTfVOA,1826
 vellum/workflows/tests/test_undefined.py,sha256=zMCVliCXVNLrlC6hEGyOWDnQADJ2g83yc5FIM33zuo8,353
@@ -1670,8 +1678,8 @@ vellum/workflows/workflows/event_filters.py,sha256=GSxIgwrX26a1Smfd-6yss2abGCnad
 vellum/workflows/workflows/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum/workflows/workflows/tests/test_base_workflow.py,sha256=tCxrV3QBHL8wfdEO3bvKteDdw32xBlUl1_WxkAwaONw,8344
 vellum/workflows/workflows/tests/test_context.py,sha256=VJBUcyWVtMa_lE5KxdhgMu0WYNYnUQUDvTF7qm89hJ0,2333
-vellum_ai-0.14.34.dist-info/LICENSE,sha256=hOypcdt481qGNISA784bnAGWAE6tyIf9gc2E78mYC3E,1574
-vellum_ai-0.14.34.dist-info/METADATA,sha256=1DTJPYOhbXBtorWcrH9e992hHsfsTsvKtleo96NqcaY,5484
-vellum_ai-0.14.34.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-vellum_ai-0.14.34.dist-info/entry_points.txt,sha256=HCH4yc_V3J_nDv3qJzZ_nYS8llCHZViCDP1ejgCc5Ak,42
-vellum_ai-0.14.34.dist-info/RECORD,,
+vellum_ai-0.14.36.dist-info/LICENSE,sha256=hOypcdt481qGNISA784bnAGWAE6tyIf9gc2E78mYC3E,1574
+vellum_ai-0.14.36.dist-info/METADATA,sha256=8nijTIGNJWT-D2j9VvMW7PARaKyi1lKH76DMnGPzXoY,5484
+vellum_ai-0.14.36.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+vellum_ai-0.14.36.dist-info/entry_points.txt,sha256=HCH4yc_V3J_nDv3qJzZ_nYS8llCHZViCDP1ejgCc5Ak,42
+vellum_ai-0.14.36.dist-info/RECORD,,

vellum_cli/pull.py

@@ -35,6 +35,7 @@ class PullContentsMetadata(UniversalBaseModel):
     runner_config: Optional[RunnerConfig] = None
     deployment_id: Optional[UUID] = None
     deployment_name: Optional[str] = None
+    workflow_sandbox_id: Optional[UUID] = None
 
 
 def _resolve_workflow_config(
@@ -198,6 +199,8 @@ def pull_command(
                     workflow_config.container_image_tag = pull_contents_metadata.runner_config.container_image_tag
                     if workflow_config.container_image_name and not workflow_config.container_image_tag:
                         workflow_config.container_image_tag = "latest"
+                if not workflow_config.workflow_sandbox_id and pull_contents_metadata.workflow_sandbox_id:
+                    workflow_config.workflow_sandbox_id = str(pull_contents_metadata.workflow_sandbox_id)
                 if not workflow_config.module and workflow_deployment and pull_contents_metadata.deployment_name:
                     workflow_config.module = snake_case(pull_contents_metadata.deployment_name)
                 if not workflow_config.module and pull_contents_metadata.label:

vellum_cli/tests/test_pull.py

@@ -1185,7 +1185,7 @@ def test_pull__workflow_deployment_with_name_and_id(vellum_client):
     deployment_id = str(uuid4())  # config will always use the deployment_id return from the API
     deployment_name = "Test Deployment"
     deployment_label = "Test Label"
-
+    workflow_sandbox_id = str(uuid4())
     # AND the workflow pull API call returns a zip file with metadata
     vellum_client.workflows.pull.return_value = iter(
         [
@@ -1197,6 +1197,7 @@ def test_pull__workflow_deployment_with_name_and_id(vellum_client):
                             "deployment_id": deployment_id,
                             "deployment_name": deployment_name,
                             "label": deployment_label,
+                            "workflow_sandbox_id": workflow_sandbox_id,
                         }
                     ),
                 }
@@ -1227,6 +1228,7 @@ def test_pull__workflow_deployment_with_name_and_id(vellum_client):
         assert str(deployment["id"]) == deployment_id
         assert deployment["name"] == deployment_name
         assert deployment["label"] == deployment_label
+        assert lock_data["workflows"][0]["workflow_sandbox_id"] == workflow_sandbox_id
 
     os.chdir(current_dir)
 
@@ -1248,6 +1250,7 @@ def test_pull__workflow_deployment_with_name_and_id(vellum_client):
         ]
     )
 
+    os.chdir(temp_dir)
     result = runner.invoke(cli_main, ["workflows", "pull", "--workflow-deployment", deployment_name])
     assert result.exit_code == 0
     with open(vellum_lock_json) as f: