vellum-ai 1.6.4__py3-none-any.whl → 1.7.0__py3-none-any.whl

vellum/__init__.py

@@ -679,6 +679,7 @@ from .client.types import (
     WorkflowRequestNumberInputRequest,
     WorkflowRequestStringInputRequest,
     WorkflowRequestVideoInputRequest,
+    WorkflowResolvedState,
     WorkflowResultEvent,
     WorkflowResultEventOutputData,
     WorkflowResultEventOutputDataArray,
@@ -1429,6 +1430,7 @@ __all__ = [
     "WorkflowRequestNumberInputRequest",
     "WorkflowRequestStringInputRequest",
     "WorkflowRequestVideoInputRequest",
+    "WorkflowResolvedState",
     "WorkflowResultEvent",
     "WorkflowResultEventOutputData",
     "WorkflowResultEventOutputDataArray",

vellum/client/core/client_wrapper.py

@@ -27,10 +27,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "vellum-ai/1.6.4",
+            "User-Agent": "vellum-ai/1.7.0",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "1.6.4",
+            "X-Fern-SDK-Version": "1.7.0",
             **(self.get_custom_headers() or {}),
         }
         if self._api_version is not None:

vellum/client/reference.md

@@ -2279,6 +2279,14 @@ client.container_images.push_container_image(
 <dl>
 <dd>
 
+**force:** `typing.Optional[bool]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>
@@ -7088,6 +7096,79 @@ client.workflow_sandboxes.list_workflow_sandbox_examples()
 </details>
 
 ## Workflows
+<details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">retrieve_state</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve the current state of a workflow execution.
+
+**Note:** Uses a base url of `https://predict.vellum.ai`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import Vellum
+
+client = Vellum(
+    api_version="YOUR_API_VERSION",
+    api_key="YOUR_API_KEY",
+)
+client.workflows.retrieve_state(
+    span_id="span_id",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**span_id:** `str` — The span ID of the workflow execution to retrieve state for
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.workflows.<a href="src/vellum/resources/workflows/client.py">serialize_workflow_files</a>(...)</code></summary>
 <dl>
 <dd>

vellum/client/resources/container_images/client.py

@@ -140,6 +140,7 @@ class ContainerImagesClient:
         name: str,
         sha: str,
         tags: typing.Sequence[str],
+        force: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ContainerImageRead:
         """
@@ -151,6 +152,8 @@ class ContainerImagesClient:
 
         tags : typing.Sequence[str]
 
+        force : typing.Optional[bool]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -174,7 +177,7 @@ class ContainerImagesClient:
         )
         """
         _response = self._raw_client.push_container_image(
-            name=name, sha=sha, tags=tags, request_options=request_options
+            name=name, sha=sha, tags=tags, force=force, request_options=request_options
         )
         return _response.data
 
@@ -328,6 +331,7 @@ class AsyncContainerImagesClient:
         name: str,
         sha: str,
         tags: typing.Sequence[str],
+        force: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ContainerImageRead:
         """
@@ -339,6 +343,8 @@ class AsyncContainerImagesClient:
 
         tags : typing.Sequence[str]
 
+        force : typing.Optional[bool]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -370,6 +376,6 @@ class AsyncContainerImagesClient:
         asyncio.run(main())
         """
         _response = await self._raw_client.push_container_image(
-            name=name, sha=sha, tags=tags, request_options=request_options
+            name=name, sha=sha, tags=tags, force=force, request_options=request_options
         )
         return _response.data

vellum/client/resources/container_images/raw_client.py

@@ -158,6 +158,7 @@ class RawContainerImagesClient:
         name: str,
         sha: str,
         tags: typing.Sequence[str],
+        force: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ContainerImageRead]:
         """
@@ -169,6 +170,8 @@ class RawContainerImagesClient:
 
         tags : typing.Sequence[str]
 
+        force : typing.Optional[bool]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -185,6 +188,7 @@ class RawContainerImagesClient:
                 "name": name,
                 "sha": sha,
                 "tags": tags,
+                "force": force,
             },
             headers={
                 "content-type": "application/json",
@@ -349,6 +353,7 @@ class AsyncRawContainerImagesClient:
         name: str,
         sha: str,
         tags: typing.Sequence[str],
+        force: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ContainerImageRead]:
         """
@@ -360,6 +365,8 @@ class AsyncRawContainerImagesClient:
 
         tags : typing.Sequence[str]
 
+        force : typing.Optional[bool]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -376,6 +383,7 @@ class AsyncRawContainerImagesClient:
                 "name": name,
                 "sha": sha,
                 "tags": tags,
+                "force": force,
             },
             headers={
                 "content-type": "application/json",

vellum/client/resources/workflows/client.py

@@ -8,6 +8,7 @@ from ...core.request_options import RequestOptions
 from ...types.workflow_push_deployment_config_request import WorkflowPushDeploymentConfigRequest
 from ...types.workflow_push_exec_config import WorkflowPushExecConfig
 from ...types.workflow_push_response import WorkflowPushResponse
+from ...types.workflow_resolved_state import WorkflowResolvedState
 from .raw_client import AsyncRawWorkflowsClient, RawWorkflowsClient
 
 # this is used as the default value for optional parameters
@@ -89,6 +90,42 @@ class WorkflowsClient:
         ) as r:
             yield from r.data
 
+    def retrieve_state(
+        self, span_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> WorkflowResolvedState:
+        """
+        Retrieve the current state of a workflow execution.
+
+        **Note:** Uses a base url of `https://predict.vellum.ai`.
+
+        Parameters
+        ----------
+        span_id : str
+            The span ID of the workflow execution to retrieve state for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResolvedState
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        client.workflows.retrieve_state(
+            span_id="span_id",
+        )
+        """
+        _response = self._raw_client.retrieve_state(span_id, request_options=request_options)
+        return _response.data
+
     def push(
         self,
         *,
@@ -245,6 +282,50 @@ class AsyncWorkflowsClient:
             async for _chunk in r.data:
                 yield _chunk
 
+    async def retrieve_state(
+        self, span_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> WorkflowResolvedState:
+        """
+        Retrieve the current state of a workflow execution.
+
+        **Note:** Uses a base url of `https://predict.vellum.ai`.
+
+        Parameters
+        ----------
+        span_id : str
+            The span ID of the workflow execution to retrieve state for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowResolvedState
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.workflows.retrieve_state(
+                span_id="span_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.retrieve_state(span_id, request_options=request_options)
+        return _response.data
+
     async def push(
         self,
         *,

vellum/client/resources/workflows/raw_client.py

@@ -15,6 +15,7 @@ from ...errors.bad_request_error import BadRequestError
 from ...types.workflow_push_deployment_config_request import WorkflowPushDeploymentConfigRequest
 from ...types.workflow_push_exec_config import WorkflowPushExecConfig
 from ...types.workflow_push_response import WorkflowPushResponse
+from ...types.workflow_resolved_state import WorkflowResolvedState
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -112,6 +113,48 @@ class RawWorkflowsClient:
 
             yield _stream()
 
+    def retrieve_state(
+        self, span_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[WorkflowResolvedState]:
+        """
+        Retrieve the current state of a workflow execution.
+
+        **Note:** Uses a base url of `https://predict.vellum.ai`.
+
+        Parameters
+        ----------
+        span_id : str
+            The span ID of the workflow execution to retrieve state for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[WorkflowResolvedState]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/workflows/{jsonable_encoder(span_id)}/state",
+            base_url=self._client_wrapper.get_environment().predict,
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    WorkflowResolvedState,
+                    parse_obj_as(
+                        type_=WorkflowResolvedState,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     def push(
         self,
         *,
@@ -324,6 +367,48 @@ class AsyncRawWorkflowsClient:
 
             yield await _stream()
 
+    async def retrieve_state(
+        self, span_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[WorkflowResolvedState]:
+        """
+        Retrieve the current state of a workflow execution.
+
+        **Note:** Uses a base url of `https://predict.vellum.ai`.
+
+        Parameters
+        ----------
+        span_id : str
+            The span ID of the workflow execution to retrieve state for
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[WorkflowResolvedState]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/workflows/{jsonable_encoder(span_id)}/state",
+            base_url=self._client_wrapper.get_environment().predict,
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    WorkflowResolvedState,
+                    parse_obj_as(
+                        type_=WorkflowResolvedState,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     async def push(
         self,
         *,

vellum/client/types/__init__.py

@@ -703,6 +703,7 @@ from .workflow_request_json_input_request import WorkflowRequestJsonInputRequest
 from .workflow_request_number_input_request import WorkflowRequestNumberInputRequest
 from .workflow_request_string_input_request import WorkflowRequestStringInputRequest
 from .workflow_request_video_input_request import WorkflowRequestVideoInputRequest
+from .workflow_resolved_state import WorkflowResolvedState
 from .workflow_result_event import WorkflowResultEvent
 from .workflow_result_event_output_data import WorkflowResultEventOutputData
 from .workflow_result_event_output_data_array import WorkflowResultEventOutputDataArray
@@ -1393,6 +1394,7 @@ __all__ = [
     "WorkflowRequestNumberInputRequest",
     "WorkflowRequestStringInputRequest",
     "WorkflowRequestVideoInputRequest",
+    "WorkflowResolvedState",
     "WorkflowResultEvent",
     "WorkflowResultEventOutputData",
     "WorkflowResultEventOutputDataArray",

vellum/client/types/workflow_resolved_state.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class WorkflowResolvedState(UniversalBaseModel):
+    """
+    The latest execution state of a given Workflow Execution
+    """
+
+    trace_id: str
+    timestamp: dt.datetime
+    span_id: str
+    state: typing.Dict[str, typing.Optional[typing.Any]]
+    previous_span_id: typing.Optional[str] = None
+    previous_trace_id: typing.Optional[str] = None
+    root_span_id: typing.Optional[str] = None
+    root_trace_id: typing.Optional[str] = None
+
+    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/workflow_resolved_state.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_resolved_state import *

vellum/workflows/descriptors/base.py

@@ -135,6 +135,9 @@ class BaseDescriptor(Generic[_T]):
 
         return AccessorExpression(base=self, field=field)
 
+    def __iter__(self) -> None:
+        raise TypeError(f"'{type(self).__name__}' object is not iterable")
+
     @overload
     def equals(self, other: "BaseDescriptor[_O]") -> "EqualsExpression[_T, _O]": ...
 

vellum/workflows/errors/types.py

@@ -25,6 +25,7 @@ class WorkflowErrorCode(Enum):
     PROVIDER_ERROR = "PROVIDER_ERROR"
     USER_DEFINED_ERROR = "USER_DEFINED_ERROR"
     WORKFLOW_CANCELLED = "WORKFLOW_CANCELLED"
+    NODE_CANCELLED = "NODE_CANCELLED"
 
 
 @dataclass(frozen=True)

vellum/workflows/inputs/base.py

@@ -41,7 +41,10 @@ class _BaseInputsMeta(type):
             else:
                 return WorkflowInputReference(name=name, types=types, instance=instance, inputs_class=cls)
 
-        return super().__getattribute__(name)
+        if getattr(cls, "__descriptor_class__", None) is ExternalInputReference:
+            return ExternalInputReference(name=name, types=(), instance=undefined, inputs_class=cls)
+        else:
+            return WorkflowInputReference(name=name, types=(), instance=undefined, inputs_class=cls)
 
     def __iter__(cls) -> Iterator[InputReference]:
         # We iterate through the inheritance hierarchy to find all the WorkflowInputReference attached to this

vellum/workflows/inputs/tests/test_inputs.py

@@ -62,3 +62,24 @@ def test_base_inputs__supports_inherited_inputs():
     assert BottomInputs.first.name == "first"
     assert BottomInputs.second.name == "second"
     assert len([ref for ref in BottomInputs]) == 2
+
+
+def test_base_inputs__iterating_over_descriptor_is_finite():
+    """
+    Tests that iterating over a descriptor (like Inputs.image_url) creates a finite generator.
+    This was the bug reported in Slack where AB sometimes generates code that iterates over descriptors.
+    """
+
+    class Inputs(BaseInputs):
+        image_url: str
+
+    iteration_count = 0
+    try:
+        for idx, x in enumerate(Inputs.image_url):  # type: ignore[arg-type,var-annotated]
+            iteration_count += 1
+            if idx > 100:
+                break
+    except (TypeError, IndexError):
+        pass
+
+    assert iteration_count < 100

vellum/workflows/runner/runner.py

@@ -847,6 +847,22 @@ class WorkflowRunner(Generic[StateType]):
                 rejection_event = self._handle_work_item_event(event)
 
             if rejection_event:
+                failed_node_name = rejection_event.body.node_definition.__name__
+                for active_span_id, active_node_data in list(self._active_nodes_by_execution_id.items()):
+                    cancellation_event = NodeExecutionRejectedEvent(
+                        trace_id=self._execution_context.trace_id,
+                        span_id=active_span_id,
+                        body=NodeExecutionRejectedBody(
+                            node_definition=active_node_data.node.__class__,
+                            error=WorkflowError(
+                                message=f"Node execution cancelled due to {failed_node_name} failure",
+                                code=WorkflowErrorCode.NODE_CANCELLED,
+                            ),
+                        ),
+                        parent=self._execution_context.parent_context,
+                    )
+                    self._workflow_event_outer_queue.put(cancellation_event)
+                    self._active_nodes_by_execution_id.pop(active_span_id)
                 break
 
         # Handle any remaining events

vellum/workflows/workflows/base.py

@@ -692,6 +692,8 @@ class BaseWorkflow(Generic[InputsType, StateType], BaseExecutable, metaclass=_Ba
                 ) from e
             else:
                 raise
+        except (SyntaxError, ImportError, ModuleNotFoundError) as e:
+            raise WorkflowInitializationException(message=f"Failed to load workflow module: {e}") from e
         workflows: List[Type[BaseWorkflow]] = []
         for name in dir(module):
             if name.startswith("__"):

{vellum_ai-1.6.4.dist-info → vellum_ai-1.7.0.dist-info}/METADATA

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