vellum-ai 1.11.2__py3-none-any.whl → 1.13.5__py3-none-any.whl

vellum/client/resources/workflow_deployments/raw_client.py

@@ -1,5 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import contextlib
+import json
 import typing
 from json.decoder import JSONDecodeError
 
@@ -9,13 +11,19 @@ from ...core.http_response import AsyncHttpResponse, HttpResponse
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.pydantic_utilities import parse_obj_as
 from ...core.request_options import RequestOptions
+from ...errors.bad_request_error import BadRequestError
+from ...errors.internal_server_error import InternalServerError
+from ...errors.misdirected_request_error import MisdirectedRequestError
+from ...errors.not_found_error import NotFoundError
 from ...types.paginated_slim_workflow_deployment_list import PaginatedSlimWorkflowDeploymentList
 from ...types.paginated_workflow_deployment_release_list import PaginatedWorkflowDeploymentReleaseList
 from ...types.paginated_workflow_release_tag_read_list import PaginatedWorkflowReleaseTagReadList
+from ...types.update_active_workspace_response import UpdateActiveWorkspaceResponse
 from ...types.workflow_deployment_event_executions_response import WorkflowDeploymentEventExecutionsResponse
 from ...types.workflow_deployment_history_item import WorkflowDeploymentHistoryItem
 from ...types.workflow_deployment_read import WorkflowDeploymentRead
 from ...types.workflow_deployment_release import WorkflowDeploymentRelease
+from ...types.workflow_event import WorkflowEvent
 from ...types.workflow_event_execution_read import WorkflowEventExecutionRead
 from ...types.workflow_release_tag_read import WorkflowReleaseTagRead
 from .types.list_workflow_release_tags_request_source import ListWorkflowReleaseTagsRequestSource
@@ -130,6 +138,136 @@ class RawWorkflowDeploymentsClient:
             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)
 
+    @contextlib.contextmanager
+    def execute_stream(
+        self,
+        id: str,
+        *,
+        inputs: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        trigger: typing.Optional[str] = OMIT,
+        release_tag: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        previous_execution_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Iterator[HttpResponse[typing.Iterator[WorkflowEvent]]]:
+        """
+        Executes a deployed Workflow and streams back its results.
+
+        Parameters
+        ----------
+        id : str
+            Either the Workflow Deployment's ID or its unique name
+
+        inputs : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A mapping from input name to value.
+
+        trigger : typing.Optional[str]
+            The name or ID of a workflow trigger to use for this execution. If not specified, then a default manual trigger will be chosen.
+
+        release_tag : typing.Optional[str]
+            Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
+
+        external_id : typing.Optional[str]
+            Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.
+
+        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.
+
+        previous_execution_id : typing.Optional[str]
+            The ID of a previous workflow execution to reference for context.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Yields
+        ------
+        typing.Iterator[HttpResponse[typing.Iterator[WorkflowEvent]]]
+
+        """
+        with self._client_wrapper.httpx_client.stream(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}/execute-stream",
+            base_url=self._client_wrapper.get_environment().predict,
+            method="POST",
+            json={
+                "inputs": inputs,
+                "trigger": trigger,
+                "release_tag": release_tag,
+                "external_id": external_id,
+                "metadata": metadata,
+                "previous_execution_id": previous_execution_id,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        ) as _response:
+
+            def _stream() -> HttpResponse[typing.Iterator[WorkflowEvent]]:
+                try:
+                    if 200 <= _response.status_code < 300:
+
+                        def _iter():
+                            for _text in _response.iter_lines():
+                                try:
+                                    if len(_text) == 0:
+                                        continue
+                                    yield typing.cast(
+                                        WorkflowEvent,
+                                        parse_obj_as(
+                                            type_=WorkflowEvent,  # type: ignore
+                                            object_=json.loads(_text),
+                                        ),
+                                    )
+                                except Exception:
+                                    pass
+                            return
+
+                        return HttpResponse(response=_response, data=_iter())
+                    _response.read()
+                    if _response.status_code == 400:
+                        raise BadRequestError(
+                            headers=dict(_response.headers),
+                            body=typing.cast(
+                                typing.Optional[typing.Any],
+                                parse_obj_as(
+                                    type_=typing.Optional[typing.Any],  # type: ignore
+                                    object_=_response.json(),
+                                ),
+                            ),
+                        )
+                    if _response.status_code == 404:
+                        raise NotFoundError(
+                            headers=dict(_response.headers),
+                            body=typing.cast(
+                                typing.Optional[typing.Any],
+                                parse_obj_as(
+                                    type_=typing.Optional[typing.Any],  # type: ignore
+                                    object_=_response.json(),
+                                ),
+                            ),
+                        )
+                    if _response.status_code == 500:
+                        raise InternalServerError(
+                            headers=dict(_response.headers),
+                            body=typing.cast(
+                                typing.Optional[typing.Any],
+                                parse_obj_as(
+                                    type_=typing.Optional[typing.Any],  # type: ignore
+                                    object_=_response.json(),
+                                ),
+                            ),
+                        )
+                    _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)
+
+            yield _stream()
+
     def list_workflow_deployment_event_executions(
         self,
         id: str,
@@ -224,6 +362,39 @@ class RawWorkflowDeploymentsClient:
                     ),
                 )
                 return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 421:
+                raise MisdirectedRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UpdateActiveWorkspaceResponse,
+                        parse_obj_as(
+                            type_=UpdateActiveWorkspaceResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
@@ -647,6 +818,136 @@ class AsyncRawWorkflowDeploymentsClient:
             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)
 
+    @contextlib.asynccontextmanager
+    async def execute_stream(
+        self,
+        id: str,
+        *,
+        inputs: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        trigger: typing.Optional[str] = OMIT,
+        release_tag: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        previous_execution_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[WorkflowEvent]]]:
+        """
+        Executes a deployed Workflow and streams back its results.
+
+        Parameters
+        ----------
+        id : str
+            Either the Workflow Deployment's ID or its unique name
+
+        inputs : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A mapping from input name to value.
+
+        trigger : typing.Optional[str]
+            The name or ID of a workflow trigger to use for this execution. If not specified, then a default manual trigger will be chosen.
+
+        release_tag : typing.Optional[str]
+            Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
+
+        external_id : typing.Optional[str]
+            Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.
+
+        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.
+
+        previous_execution_id : typing.Optional[str]
+            The ID of a previous workflow execution to reference for context.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Yields
+        ------
+        typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[WorkflowEvent]]]
+
+        """
+        async with self._client_wrapper.httpx_client.stream(
+            f"v1/workflow-deployments/{jsonable_encoder(id)}/execute-stream",
+            base_url=self._client_wrapper.get_environment().predict,
+            method="POST",
+            json={
+                "inputs": inputs,
+                "trigger": trigger,
+                "release_tag": release_tag,
+                "external_id": external_id,
+                "metadata": metadata,
+                "previous_execution_id": previous_execution_id,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        ) as _response:
+
+            async def _stream() -> AsyncHttpResponse[typing.AsyncIterator[WorkflowEvent]]:
+                try:
+                    if 200 <= _response.status_code < 300:
+
+                        async def _iter():
+                            async for _text in _response.aiter_lines():
+                                try:
+                                    if len(_text) == 0:
+                                        continue
+                                    yield typing.cast(
+                                        WorkflowEvent,
+                                        parse_obj_as(
+                                            type_=WorkflowEvent,  # type: ignore
+                                            object_=json.loads(_text),
+                                        ),
+                                    )
+                                except Exception:
+                                    pass
+                            return
+
+                        return AsyncHttpResponse(response=_response, data=_iter())
+                    await _response.aread()
+                    if _response.status_code == 400:
+                        raise BadRequestError(
+                            headers=dict(_response.headers),
+                            body=typing.cast(
+                                typing.Optional[typing.Any],
+                                parse_obj_as(
+                                    type_=typing.Optional[typing.Any],  # type: ignore
+                                    object_=_response.json(),
+                                ),
+                            ),
+                        )
+                    if _response.status_code == 404:
+                        raise NotFoundError(
+                            headers=dict(_response.headers),
+                            body=typing.cast(
+                                typing.Optional[typing.Any],
+                                parse_obj_as(
+                                    type_=typing.Optional[typing.Any],  # type: ignore
+                                    object_=_response.json(),
+                                ),
+                            ),
+                        )
+                    if _response.status_code == 500:
+                        raise InternalServerError(
+                            headers=dict(_response.headers),
+                            body=typing.cast(
+                                typing.Optional[typing.Any],
+                                parse_obj_as(
+                                    type_=typing.Optional[typing.Any],  # type: ignore
+                                    object_=_response.json(),
+                                ),
+                            ),
+                        )
+                    _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)
+
+            yield await _stream()
+
     async def list_workflow_deployment_event_executions(
         self,
         id: str,
@@ -741,6 +1042,39 @@ class AsyncRawWorkflowDeploymentsClient:
                     ),
                 )
                 return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 421:
+                raise MisdirectedRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        UpdateActiveWorkspaceResponse,
+                        parse_obj_as(
+                            type_=UpdateActiveWorkspaceResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)

vellum/client/resources/workflows/client.py

@@ -5,11 +5,15 @@ import typing
 from ... import core
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.request_options import RequestOptions
+from ...types.check_workflow_execution_status_response import CheckWorkflowExecutionStatusResponse
 from ...types.dataset_row_push_request import DatasetRowPushRequest
+from ...types.runner_config_request import RunnerConfigRequest
+from ...types.type_checker_enum import TypeCheckerEnum
 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 ...types.workflow_sandbox_execute_node_response import WorkflowSandboxExecuteNodeResponse
 from .raw_client import AsyncRawWorkflowsClient, RawWorkflowsClient
 
 # this is used as the default value for optional parameters
@@ -127,10 +131,87 @@ class WorkflowsClient:
         _response = self._raw_client.retrieve_state(span_id, request_options=request_options)
         return _response.data
 
+    def execute_node(
+        self,
+        *,
+        files: typing.Dict[str, str],
+        node: str,
+        inputs: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkflowSandboxExecuteNodeResponse:
+        """
+        Parameters
+        ----------
+        files : typing.Dict[str, str]
+
+        node : str
+
+        inputs : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowSandboxExecuteNodeResponse
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        client.workflows.execute_node(
+            files={"files": "files"},
+            node="x",
+        )
+        """
+        _response = self._raw_client.execute_node(
+            files=files, node=node, inputs=inputs, request_options=request_options
+        )
+        return _response.data
+
+    def workflow_execution_status(
+        self, execution_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CheckWorkflowExecutionStatusResponse:
+        """
+        Checks if a workflow execution is currently executing (not fulfilled, not rejected, and has no end time).
+        Uses the ClickHouse Prime summary materialized view.
+
+        Parameters
+        ----------
+        execution_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CheckWorkflowExecutionStatusResponse
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        client.workflows.workflow_execution_status(
+            execution_id="execution_id",
+        )
+        """
+        _response = self._raw_client.workflow_execution_status(execution_id, request_options=request_options)
+        return _response.data
+
     def push(
         self,
         *,
-        exec_config: WorkflowPushExecConfig,
+        exec_config: typing.Optional[WorkflowPushExecConfig] = OMIT,
         workflow_sandbox_id: typing.Optional[str] = OMIT,
         deployment_config: typing.Optional[WorkflowPushDeploymentConfigRequest] = OMIT,
         artifact: typing.Optional[core.File] = OMIT,
@@ -142,8 +223,8 @@ class WorkflowsClient:
         """
         Parameters
         ----------
-        exec_config : WorkflowPushExecConfig
-            The execution configuration of the workflow.
+        exec_config : typing.Optional[WorkflowPushExecConfig]
+            The execution configuration of the workflow. If not provided, it will be derived from the artifact.
 
         workflow_sandbox_id : typing.Optional[str]
 
@@ -184,6 +265,8 @@ class WorkflowsClient:
         *,
         files: typing.Dict[str, typing.Optional[typing.Any]],
         module: typing.Optional[str] = OMIT,
+        runner_config: typing.Optional[RunnerConfigRequest] = OMIT,
+        type_checker: typing.Optional[TypeCheckerEnum] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Dict[str, typing.Optional[typing.Any]]:
         """
@@ -195,6 +278,15 @@ class WorkflowsClient:
 
         module : typing.Optional[str]
 
+        runner_config : typing.Optional[RunnerConfigRequest]
+
+        type_checker : typing.Optional[TypeCheckerEnum]
+            Optional type checker to run during serialization. Supported values: mypy, zuban, default.
+
+            * `mypy` - Mypy
+            * `zuban` - Zuban
+            * `default` - Default
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -216,7 +308,11 @@ class WorkflowsClient:
         )
         """
         _response = self._raw_client.serialize_workflow_files(
-            files=files, module=module, request_options=request_options
+            files=files,
+            module=module,
+            runner_config=runner_config,
+            type_checker=type_checker,
+            request_options=request_options,
         )
         return _response.data
 
@@ -337,10 +433,103 @@ class AsyncWorkflowsClient:
         _response = await self._raw_client.retrieve_state(span_id, request_options=request_options)
         return _response.data
 
+    async def execute_node(
+        self,
+        *,
+        files: typing.Dict[str, str],
+        node: str,
+        inputs: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> WorkflowSandboxExecuteNodeResponse:
+        """
+        Parameters
+        ----------
+        files : typing.Dict[str, str]
+
+        node : str
+
+        inputs : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        WorkflowSandboxExecuteNodeResponse
+
+
+        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.execute_node(
+                files={"files": "files"},
+                node="x",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.execute_node(
+            files=files, node=node, inputs=inputs, request_options=request_options
+        )
+        return _response.data
+
+    async def workflow_execution_status(
+        self, execution_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CheckWorkflowExecutionStatusResponse:
+        """
+        Checks if a workflow execution is currently executing (not fulfilled, not rejected, and has no end time).
+        Uses the ClickHouse Prime summary materialized view.
+
+        Parameters
+        ----------
+        execution_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CheckWorkflowExecutionStatusResponse
+
+
+        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.workflow_execution_status(
+                execution_id="execution_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.workflow_execution_status(execution_id, request_options=request_options)
+        return _response.data
+
     async def push(
         self,
         *,
-        exec_config: WorkflowPushExecConfig,
+        exec_config: typing.Optional[WorkflowPushExecConfig] = OMIT,
         workflow_sandbox_id: typing.Optional[str] = OMIT,
         deployment_config: typing.Optional[WorkflowPushDeploymentConfigRequest] = OMIT,
         artifact: typing.Optional[core.File] = OMIT,
@@ -352,8 +541,8 @@ class AsyncWorkflowsClient:
         """
         Parameters
         ----------
-        exec_config : WorkflowPushExecConfig
-            The execution configuration of the workflow.
+        exec_config : typing.Optional[WorkflowPushExecConfig]
+            The execution configuration of the workflow. If not provided, it will be derived from the artifact.
 
         workflow_sandbox_id : typing.Optional[str]
 
@@ -394,6 +583,8 @@ class AsyncWorkflowsClient:
         *,
         files: typing.Dict[str, typing.Optional[typing.Any]],
         module: typing.Optional[str] = OMIT,
+        runner_config: typing.Optional[RunnerConfigRequest] = OMIT,
+        type_checker: typing.Optional[TypeCheckerEnum] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Dict[str, typing.Optional[typing.Any]]:
         """
@@ -405,6 +596,15 @@ class AsyncWorkflowsClient:
 
         module : typing.Optional[str]
 
+        runner_config : typing.Optional[RunnerConfigRequest]
+
+        type_checker : typing.Optional[TypeCheckerEnum]
+            Optional type checker to run during serialization. Supported values: mypy, zuban, default.
+
+            * `mypy` - Mypy
+            * `zuban` - Zuban
+            * `default` - Default
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -434,6 +634,10 @@ class AsyncWorkflowsClient:
         asyncio.run(main())
         """
         _response = await self._raw_client.serialize_workflow_files(
-            files=files, module=module, request_options=request_options
+            files=files,
+            module=module,
+            runner_config=runner_config,
+            type_checker=type_checker,
+            request_options=request_options,
         )
         return _response.data