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

vellum/client/resources/workflows/client.py

@@ -1,18 +1,20 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from ...core.client_wrapper import SyncClientWrapper
+
+from ... import core
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.request_options import RequestOptions
-from ...core.jsonable_encoder import jsonable_encoder
-from ...errors.bad_request_error import BadRequestError
-from ...core.pydantic_utilities import parse_obj_as
-from json.decoder import JSONDecodeError
-from ...core.api_error import ApiError
-from ...types.workflow_push_exec_config import WorkflowPushExecConfig
+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 ... import core
+from ...types.workflow_push_exec_config import WorkflowPushExecConfig
 from ...types.workflow_push_response import WorkflowPushResponse
-from ...core.client_wrapper import AsyncClientWrapper
+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
 OMIT = typing.cast(typing.Any, ...)
@@ -20,16 +22,34 @@ OMIT = typing.cast(typing.Any, ...)
 
 class WorkflowsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = RawWorkflowsClient(client_wrapper=client_wrapper)
+
+    @property
+    def _client_wrapper(self) -> SyncClientWrapper:
+        return self._raw_client._client_wrapper
+
+    @property
+    def with_raw_response(self) -> RawWorkflowsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWorkflowsClient
+        """
+        return self._raw_client
 
     def pull(
         self,
         id: str,
         *,
         exclude_code: typing.Optional[bool] = None,
+        exclude_display: typing.Optional[bool] = None,
         include_json: typing.Optional[bool] = None,
         include_sandbox: typing.Optional[bool] = None,
+        release_tag: typing.Optional[str] = None,
         strict: typing.Optional[bool] = None,
+        version: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[bytes]:
         """
@@ -40,61 +60,162 @@ class WorkflowsClient:
 
         exclude_code : typing.Optional[bool]
 
+        exclude_display : typing.Optional[bool]
+
         include_json : typing.Optional[bool]
 
         include_sandbox : typing.Optional[bool]
 
+        release_tag : typing.Optional[str]
+            Release tag to use when pulling from deployment (implies deployment-only lookup)
+
         strict : typing.Optional[bool]
 
+        version : typing.Optional[str]
+            Semantic version range to validate against the Workflow SDK version (e.g., '>=1.0.0,<1.2.3')
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
-        Yields
-        ------
+        Returns
+        -------
         typing.Iterator[bytes]
 
         """
-        with self._client_wrapper.httpx_client.stream(
-            f"v1/workflows/{jsonable_encoder(id)}/pull",
-            base_url=self._client_wrapper.get_environment().default,
-            method="GET",
-            params={
-                "exclude_code": exclude_code,
-                "include_json": include_json,
-                "include_sandbox": include_sandbox,
-                "strict": strict,
-            },
+        with self._raw_client.pull(
+            id,
+            exclude_code=exclude_code,
+            exclude_display=exclude_display,
+            include_json=include_json,
+            include_sandbox=include_sandbox,
+            release_tag=release_tag,
+            strict=strict,
+            version=version,
             request_options=request_options,
-        ) as _response:
-            try:
-                if 200 <= _response.status_code < 300:
-                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
-                    for _chunk in _response.iter_bytes(chunk_size=_chunk_size):
-                        yield _chunk
-                    return
-                _response.read()
-                if _response.status_code == 400:
-                    raise BadRequestError(
-                        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, body=_response.text)
-            raise ApiError(status_code=_response.status_code, body=_response_json)
+        ) 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 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,
+        dataset: typing.Optional[typing.List[DatasetRowPushRequest]] = OMIT,
         dry_run: typing.Optional[bool] = OMIT,
         strict: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
@@ -102,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]
 
@@ -112,6 +233,9 @@ class WorkflowsClient:
         artifact : typing.Optional[core.File]
             See core.File for more documentation
 
+        dataset : typing.Optional[typing.List[DatasetRowPushRequest]]
+            List of dataset rows with inputs for scenarios.
+
         dry_run : typing.Optional[bool]
 
         strict : typing.Optional[bool]
@@ -123,62 +247,102 @@ class WorkflowsClient:
         -------
         WorkflowPushResponse
 
+        """
+        _response = self._raw_client.push(
+            exec_config=exec_config,
+            workflow_sandbox_id=workflow_sandbox_id,
+            deployment_config=deployment_config,
+            artifact=artifact,
+            dataset=dataset,
+            dry_run=dry_run,
+            strict=strict,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def serialize_workflow_files(
+        self,
+        *,
+        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]]:
+        """
+        Serialize files
+
+        Parameters
+        ----------
+        files : typing.Dict[str, typing.Optional[typing.Any]]
+
+        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.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+
 
         Examples
         --------
         from vellum import Vellum
 
         client = Vellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
-        client.workflows.push(
-            exec_config="exec_config",
+        client.workflows.serialize_workflow_files(
+            files={"files": {"key": "value"}},
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            "v1/workflows/push",
-            base_url=self._client_wrapper.get_environment().default,
-            method="POST",
-            data={
-                "exec_config": exec_config,
-                "workflow_sandbox_id": workflow_sandbox_id,
-                "deployment_config": deployment_config,
-                "dry_run": dry_run,
-                "strict": strict,
-            },
-            files={
-                "artifact": artifact,
-            },
+        _response = self._raw_client.serialize_workflow_files(
+            files=files,
+            module=module,
+            runner_config=runner_config,
+            type_checker=type_checker,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    WorkflowPushResponse,
-                    parse_obj_as(
-                        type_=WorkflowPushResponse,  # 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)
+        return _response.data
 
 
 class AsyncWorkflowsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = AsyncRawWorkflowsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWorkflowsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWorkflowsClient
+        """
+        return self._raw_client
 
     async def pull(
         self,
         id: str,
         *,
         exclude_code: typing.Optional[bool] = None,
+        exclude_display: typing.Optional[bool] = None,
         include_json: typing.Optional[bool] = None,
         include_sandbox: typing.Optional[bool] = None,
+        release_tag: typing.Optional[str] = None,
         strict: typing.Optional[bool] = None,
+        version: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[bytes]:
         """
@@ -189,61 +353,187 @@ class AsyncWorkflowsClient:
 
         exclude_code : typing.Optional[bool]
 
+        exclude_display : typing.Optional[bool]
+
         include_json : typing.Optional[bool]
 
         include_sandbox : typing.Optional[bool]
 
+        release_tag : typing.Optional[str]
+            Release tag to use when pulling from deployment (implies deployment-only lookup)
+
         strict : typing.Optional[bool]
 
+        version : typing.Optional[str]
+            Semantic version range to validate against the Workflow SDK version (e.g., '>=1.0.0,<1.2.3')
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
 
-        Yields
-        ------
+        Returns
+        -------
         typing.AsyncIterator[bytes]
 
         """
-        async with self._client_wrapper.httpx_client.stream(
-            f"v1/workflows/{jsonable_encoder(id)}/pull",
-            base_url=self._client_wrapper.get_environment().default,
-            method="GET",
-            params={
-                "exclude_code": exclude_code,
-                "include_json": include_json,
-                "include_sandbox": include_sandbox,
-                "strict": strict,
-            },
+        async with self._raw_client.pull(
+            id,
+            exclude_code=exclude_code,
+            exclude_display=exclude_display,
+            include_json=include_json,
+            include_sandbox=include_sandbox,
+            release_tag=release_tag,
+            strict=strict,
+            version=version,
             request_options=request_options,
-        ) as _response:
-            try:
-                if 200 <= _response.status_code < 300:
-                    _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
-                    async for _chunk in _response.aiter_bytes(chunk_size=_chunk_size):
-                        yield _chunk
-                    return
-                await _response.aread()
-                if _response.status_code == 400:
-                    raise BadRequestError(
-                        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, body=_response.text)
-            raise ApiError(status_code=_response.status_code, body=_response_json)
+        ) as r:
+            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 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,
+        dataset: typing.Optional[typing.List[DatasetRowPushRequest]] = OMIT,
         dry_run: typing.Optional[bool] = OMIT,
         strict: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
@@ -251,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]
 
@@ -261,6 +551,9 @@ class AsyncWorkflowsClient:
         artifact : typing.Optional[core.File]
             See core.File for more documentation
 
+        dataset : typing.Optional[typing.List[DatasetRowPushRequest]]
+            List of dataset rows with inputs for scenarios.
+
         dry_run : typing.Optional[bool]
 
         strict : typing.Optional[bool]
@@ -272,6 +565,53 @@ class AsyncWorkflowsClient:
         -------
         WorkflowPushResponse
 
+        """
+        _response = await self._raw_client.push(
+            exec_config=exec_config,
+            workflow_sandbox_id=workflow_sandbox_id,
+            deployment_config=deployment_config,
+            artifact=artifact,
+            dataset=dataset,
+            dry_run=dry_run,
+            strict=strict,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def serialize_workflow_files(
+        self,
+        *,
+        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]]:
+        """
+        Serialize files
+
+        Parameters
+        ----------
+        files : typing.Dict[str, typing.Optional[typing.Any]]
+
+        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.
+
+        Returns
+        -------
+        typing.Dict[str, typing.Optional[typing.Any]]
+
 
         Examples
         --------
@@ -280,45 +620,24 @@ class AsyncWorkflowsClient:
         from vellum import AsyncVellum
 
         client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
 
 
         async def main() -> None:
-            await client.workflows.push(
-                exec_config="exec_config",
+            await client.workflows.serialize_workflow_files(
+                files={"files": {"key": "value"}},
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            "v1/workflows/push",
-            base_url=self._client_wrapper.get_environment().default,
-            method="POST",
-            data={
-                "exec_config": exec_config,
-                "workflow_sandbox_id": workflow_sandbox_id,
-                "deployment_config": deployment_config,
-                "dry_run": dry_run,
-                "strict": strict,
-            },
-            files={
-                "artifact": artifact,
-            },
+        _response = await self._raw_client.serialize_workflow_files(
+            files=files,
+            module=module,
+            runner_config=runner_config,
+            type_checker=type_checker,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    WorkflowPushResponse,
-                    parse_obj_as(
-                        type_=WorkflowPushResponse,  # 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)
+        return _response.data