vellum-ai 1.1.0__py3-none-any.whl → 1.1.2__py3-none-any.whl

vellum/client/resources/workflow_sandboxes/raw_client.py

@@ -0,0 +1,300 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...core.client_wrapper import SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...core.http_response import HttpResponse
+from ...types.workflow_deployment_read import WorkflowDeploymentRead
+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.list_workflow_sandbox_examples_request_tag import ListWorkflowSandboxExamplesRequestTag
+from ...types.paginated_workflow_sandbox_example_list import PaginatedWorkflowSandboxExampleList
+from ...core.client_wrapper import AsyncClientWrapper
+from ...core.http_response import AsyncHttpResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawWorkflowSandboxesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def deploy_workflow(
+        self,
+        id: str,
+        workflow_id: str,
+        *,
+        workflow_deployment_id: typing.Optional[str] = OMIT,
+        workflow_deployment_name: typing.Optional[str] = OMIT,
+        label: typing.Optional[str] = OMIT,
+        release_tags: typing.Optional[typing.Sequence[str]] = OMIT,
+        release_description: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[WorkflowDeploymentRead]:
+        """
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this workflow sandbox.
+
+        workflow_id : str
+            An ID identifying the Workflow you'd like to deploy.
+
+        workflow_deployment_id : typing.Optional[str]
+            The Vellum-generated ID of the Workflow Deployment you'd like to update. Cannot specify both this and workflow_deployment_name. Leave null to create a new Workflow Deployment.
+
+        workflow_deployment_name : typing.Optional[str]
+            The unique name of the Workflow Deployment you'd like to either create or update. Cannot specify both this and workflow_deployment_id. If provided and matches an existing Workflow Deployment, that Workflow Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
+
+        label : typing.Optional[str]
+            In the event that a new Workflow Deployment is created, this will be the label it's given.
+
+        release_tags : typing.Optional[typing.Sequence[str]]
+            Optionally provide the release tags that you'd like to be associated with the latest release of the created/updated Prompt Deployment.
+
+        release_description : typing.Optional[str]
+            Optionally provide a description that details what's new in this Release.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[WorkflowDeploymentRead]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/workflow-sandboxes/{jsonable_encoder(id)}/workflows/{jsonable_encoder(workflow_id)}/deploy",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "workflow_deployment_id": workflow_deployment_id,
+                "workflow_deployment_name": workflow_deployment_name,
+                "label": label,
+                "release_tags": release_tags,
+                "release_description": release_description,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    WorkflowDeploymentRead,
+                    parse_obj_as(
+                        type_=WorkflowDeploymentRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _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 list_workflow_sandbox_examples(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        tag: typing.Optional[ListWorkflowSandboxExamplesRequestTag] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[PaginatedWorkflowSandboxExampleList]:
+        """
+        List Workflow Sandbox examples that were previously cloned into the User's Workspace
+
+        Parameters
+        ----------
+        limit : typing.Optional[int]
+            Number of results to return per page.
+
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        tag : typing.Optional[ListWorkflowSandboxExamplesRequestTag]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[PaginatedWorkflowSandboxExampleList]
+
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/workflow-sandboxes/examples",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            params={
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "tag": tag,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaginatedWorkflowSandboxExampleList,
+                    parse_obj_as(
+                        type_=PaginatedWorkflowSandboxExampleList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _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)
+
+
+class AsyncRawWorkflowSandboxesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def deploy_workflow(
+        self,
+        id: str,
+        workflow_id: str,
+        *,
+        workflow_deployment_id: typing.Optional[str] = OMIT,
+        workflow_deployment_name: typing.Optional[str] = OMIT,
+        label: typing.Optional[str] = OMIT,
+        release_tags: typing.Optional[typing.Sequence[str]] = OMIT,
+        release_description: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[WorkflowDeploymentRead]:
+        """
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this workflow sandbox.
+
+        workflow_id : str
+            An ID identifying the Workflow you'd like to deploy.
+
+        workflow_deployment_id : typing.Optional[str]
+            The Vellum-generated ID of the Workflow Deployment you'd like to update. Cannot specify both this and workflow_deployment_name. Leave null to create a new Workflow Deployment.
+
+        workflow_deployment_name : typing.Optional[str]
+            The unique name of the Workflow Deployment you'd like to either create or update. Cannot specify both this and workflow_deployment_id. If provided and matches an existing Workflow Deployment, that Workflow Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
+
+        label : typing.Optional[str]
+            In the event that a new Workflow Deployment is created, this will be the label it's given.
+
+        release_tags : typing.Optional[typing.Sequence[str]]
+            Optionally provide the release tags that you'd like to be associated with the latest release of the created/updated Prompt Deployment.
+
+        release_description : typing.Optional[str]
+            Optionally provide a description that details what's new in this Release.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[WorkflowDeploymentRead]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/workflow-sandboxes/{jsonable_encoder(id)}/workflows/{jsonable_encoder(workflow_id)}/deploy",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "workflow_deployment_id": workflow_deployment_id,
+                "workflow_deployment_name": workflow_deployment_name,
+                "label": label,
+                "release_tags": release_tags,
+                "release_description": release_description,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    WorkflowDeploymentRead,
+                    parse_obj_as(
+                        type_=WorkflowDeploymentRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _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 list_workflow_sandbox_examples(
+        self,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        tag: typing.Optional[ListWorkflowSandboxExamplesRequestTag] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[PaginatedWorkflowSandboxExampleList]:
+        """
+        List Workflow Sandbox examples that were previously cloned into the User's Workspace
+
+        Parameters
+        ----------
+        limit : typing.Optional[int]
+            Number of results to return per page.
+
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        tag : typing.Optional[ListWorkflowSandboxExamplesRequestTag]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[PaginatedWorkflowSandboxExampleList]
+
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/workflow-sandboxes/examples",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            params={
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "tag": tag,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    PaginatedWorkflowSandboxExampleList,
+                    parse_obj_as(
+                        type_=PaginatedWorkflowSandboxExampleList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _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)

vellum/client/resources/workflows/client.py

@@ -2,17 +2,14 @@
 
 import typing
 from ...core.client_wrapper import SyncClientWrapper
+from .raw_client import RawWorkflowsClient
 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.workflow_push_deployment_config_request import WorkflowPushDeploymentConfigRequest
 from ... import core
 from ...types.workflow_push_response import WorkflowPushResponse
 from ...core.client_wrapper import AsyncClientWrapper
+from .raw_client import AsyncRawWorkflowsClient
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -20,7 +17,22 @@ 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,
@@ -52,45 +64,21 @@ class WorkflowsClient:
         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,
-                "exclude_display": exclude_display,
-                "include_json": include_json,
-                "include_sandbox": include_sandbox,
-                "strict": strict,
-            },
+        response = self._raw_client.pull(
+            id,
+            exclude_code=exclude_code,
+            exclude_display=exclude_display,
+            include_json=include_json,
+            include_sandbox=include_sandbox,
+            strict=strict,
             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)
+        )
+        return response.data
 
     def push(
         self,
@@ -128,41 +116,32 @@ class WorkflowsClient:
         WorkflowPushResponse
 
         """
-        _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.push(
+            exec_config=exec_config,
+            workflow_sandbox_id=workflow_sandbox_id,
+            deployment_config=deployment_config,
+            artifact=artifact,
+            dry_run=dry_run,
+            strict=strict,
             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,
@@ -194,45 +173,21 @@ class AsyncWorkflowsClient:
         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,
-                "exclude_display": exclude_display,
-                "include_json": include_json,
-                "include_sandbox": include_sandbox,
-                "strict": strict,
-            },
+        response = await self._raw_client.pull(
+            id,
+            exclude_code=exclude_code,
+            exclude_display=exclude_display,
+            include_json=include_json,
+            include_sandbox=include_sandbox,
+            strict=strict,
             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)
+        )
+        return response.data
 
     async def push(
         self,
@@ -270,33 +225,13 @@ class AsyncWorkflowsClient:
         WorkflowPushResponse
 
         """
-        _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.push(
+            exec_config=exec_config,
+            workflow_sandbox_id=workflow_sandbox_id,
+            deployment_config=deployment_config,
+            artifact=artifact,
+            dry_run=dry_run,
+            strict=strict,
             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