vellum-ai 0.7.3__py3-none-any.whl → 0.7.5__py3-none-any.whl

vellum/resources/sandboxes/client.py

@@ -1,14 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-import urllib.parse
 from json.decoder import JSONDecodeError
 
 from ...core.api_error import ApiError
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.pydantic_utilities import pydantic_v1
-from ...core.remove_none_from_dict import remove_none_from_dict
 from ...core.request_options import RequestOptions
 from ...types.deployment_read import DeploymentRead
 from ...types.named_scenario_input_request import NamedScenarioInputRequest
@@ -25,7 +23,7 @@ class SandboxesClient:
     def deploy_prompt(
         self,
         id: str,
-        prompt_id: str,
+        prompt_variant_id: str,
         *,
         prompt_deployment_id: typing.Optional[str] = OMIT,
         prompt_deployment_name: typing.Optional[str] = OMIT,
@@ -34,21 +32,36 @@ class SandboxesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DeploymentRead:
         """
-        Parameters:
-            - id: str. A UUID string identifying this sandbox.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this sandbox.
 
-            - prompt_id: str. An ID identifying the Prompt you'd like to deploy.
+        prompt_variant_id : str
+            An ID identifying the Prompt you'd like to deploy.
 
-            - prompt_deployment_id: typing.Optional[str]. The Vellum-generated ID of the Prompt Deployment you'd like to update. Cannot specify both this and prompt_deployment_name. Leave null to create a new Prompt Deployment.
+        prompt_deployment_id : typing.Optional[str]
+            The Vellum-generated ID of the Prompt Deployment you'd like to update. Cannot specify both this and prompt_deployment_name. Leave null to create a new Prompt Deployment.
 
-            - prompt_deployment_name: typing.Optional[str]. The unique name of the Prompt Deployment you'd like to either create or update. Cannot specify both this and prompt_deployment_id. If provided and matches an existing Prompt Deployment, that Prompt Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
+        prompt_deployment_name : typing.Optional[str]
+            The unique name of the Prompt Deployment you'd like to either create or update. Cannot specify both this and prompt_deployment_id. If provided and matches an existing Prompt Deployment, that Prompt Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
 
-            - label: typing.Optional[str]. In the event that a new Prompt Deployment is created, this will be the label it's given.
+        label : typing.Optional[str]
+            In the event that a new Prompt 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_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.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeploymentRead
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -56,50 +69,25 @@ class SandboxesClient:
         )
         client.sandboxes.deploy_prompt(
             id="id",
-            prompt_id="prompt_id",
+            prompt_variant_id="prompt_variant_id",
         )
         """
-        _request: typing.Dict[str, typing.Any] = {}
-        if prompt_deployment_id is not OMIT:
-            _request["prompt_deployment_id"] = prompt_deployment_id
-        if prompt_deployment_name is not OMIT:
-            _request["prompt_deployment_name"] = prompt_deployment_name
-        if label is not OMIT:
-            _request["label"] = label
-        if release_tags is not OMIT:
-            _request["release_tags"] = release_tags
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/sandboxes/{jsonable_encoder(id)}/prompts/{jsonable_encoder(prompt_variant_id)}/deploy",
+            base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/sandboxes/{jsonable_encoder(id)}/prompts/{jsonable_encoder(prompt_id)}/deploy",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder(_request)
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(_request),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            json={
+                "prompt_deployment_id": prompt_deployment_id,
+                "prompt_deployment_name": prompt_deployment_name,
+                "label": label,
+                "release_tags": release_tags,
             },
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(DeploymentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DeploymentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -109,8 +97,8 @@ class SandboxesClient:
         self,
         id: str,
         *,
-        label: typing.Optional[str] = OMIT,
         inputs: typing.Sequence[NamedScenarioInputRequest],
+        label: typing.Optional[str] = OMIT,
         scenario_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SandboxScenario:
@@ -123,17 +111,29 @@ class SandboxesClient:
         Note that a full replacement of the scenario is performed, so any fields not provided will be removed
         or overwritten with default values.
 
-        Parameters:
-            - id: str. A UUID string identifying this sandbox.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this sandbox.
+
+        inputs : typing.Sequence[NamedScenarioInputRequest]
+            The inputs for the scenario
 
-            - label: typing.Optional[str].
+        label : typing.Optional[str]
 
-            - inputs: typing.Sequence[NamedScenarioInputRequest]. The inputs for the scenario
+        scenario_id : typing.Optional[str]
+            The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.
 
-            - scenario_id: typing.Optional[str]. The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Returns
+        -------
+        SandboxScenario
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -145,42 +145,17 @@ class SandboxesClient:
             inputs=[],
         )
         """
-        _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
-        if label is not OMIT:
-            _request["label"] = label
-        if scenario_id is not OMIT:
-            _request["scenario_id"] = scenario_id
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/sandboxes/{jsonable_encoder(id)}/scenarios",
+            base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/sandboxes/{jsonable_encoder(id)}/scenarios"
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder(_request)
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(_request),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
-            },
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            json={"label": label, "inputs": inputs, "scenario_id": scenario_id},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(SandboxScenario, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(SandboxScenario, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -192,13 +167,23 @@ class SandboxesClient:
         """
         Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
 
-        Parameters:
-            - id: str. A UUID string identifying this sandbox.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this sandbox.
 
-            - scenario_id: str. An id identifying the scenario that you'd like to delete
+        scenario_id : str
+            An id identifying the scenario that you'd like to delete
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -210,31 +195,14 @@ class SandboxesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/sandboxes/{jsonable_encoder(id)}/scenarios/{jsonable_encoder(scenario_id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="DELETE",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/sandboxes/{jsonable_encoder(id)}/scenarios/{jsonable_encoder(scenario_id)}",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -248,7 +216,7 @@ class AsyncSandboxesClient:
     async def deploy_prompt(
         self,
         id: str,
-        prompt_id: str,
+        prompt_variant_id: str,
         *,
         prompt_deployment_id: typing.Optional[str] = OMIT,
         prompt_deployment_name: typing.Optional[str] = OMIT,
@@ -257,72 +225,70 @@ class AsyncSandboxesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DeploymentRead:
         """
-        Parameters:
-            - id: str. A UUID string identifying this sandbox.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this sandbox.
+
+        prompt_variant_id : str
+            An ID identifying the Prompt you'd like to deploy.
 
-            - prompt_id: str. An ID identifying the Prompt you'd like to deploy.
+        prompt_deployment_id : typing.Optional[str]
+            The Vellum-generated ID of the Prompt Deployment you'd like to update. Cannot specify both this and prompt_deployment_name. Leave null to create a new Prompt Deployment.
 
-            - prompt_deployment_id: typing.Optional[str]. The Vellum-generated ID of the Prompt Deployment you'd like to update. Cannot specify both this and prompt_deployment_name. Leave null to create a new Prompt Deployment.
+        prompt_deployment_name : typing.Optional[str]
+            The unique name of the Prompt Deployment you'd like to either create or update. Cannot specify both this and prompt_deployment_id. If provided and matches an existing Prompt Deployment, that Prompt Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
 
-            - prompt_deployment_name: typing.Optional[str]. The unique name of the Prompt Deployment you'd like to either create or update. Cannot specify both this and prompt_deployment_id. If provided and matches an existing Prompt Deployment, that Prompt Deployment will be updated. Otherwise, a new Prompt Deployment will be created.
+        label : typing.Optional[str]
+            In the event that a new Prompt Deployment is created, this will be the label it's given.
 
-            - label: typing.Optional[str]. In the event that a new Prompt 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_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.
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeploymentRead
+
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.sandboxes.deploy_prompt(
-            id="id",
-            prompt_id="prompt_id",
-        )
+
+
+        async def main() -> None:
+            await client.sandboxes.deploy_prompt(
+                id="id",
+                prompt_variant_id="prompt_variant_id",
+            )
+
+
+        asyncio.run(main())
         """
-        _request: typing.Dict[str, typing.Any] = {}
-        if prompt_deployment_id is not OMIT:
-            _request["prompt_deployment_id"] = prompt_deployment_id
-        if prompt_deployment_name is not OMIT:
-            _request["prompt_deployment_name"] = prompt_deployment_name
-        if label is not OMIT:
-            _request["label"] = label
-        if release_tags is not OMIT:
-            _request["release_tags"] = release_tags
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/sandboxes/{jsonable_encoder(id)}/prompts/{jsonable_encoder(prompt_variant_id)}/deploy",
+            base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/sandboxes/{jsonable_encoder(id)}/prompts/{jsonable_encoder(prompt_id)}/deploy",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder(_request)
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(_request),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            json={
+                "prompt_deployment_id": prompt_deployment_id,
+                "prompt_deployment_name": prompt_deployment_name,
+                "label": label,
+                "release_tags": release_tags,
             },
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(DeploymentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DeploymentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -332,8 +298,8 @@ class AsyncSandboxesClient:
         self,
         id: str,
         *,
-        label: typing.Optional[str] = OMIT,
         inputs: typing.Sequence[NamedScenarioInputRequest],
+        label: typing.Optional[str] = OMIT,
         scenario_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SandboxScenario:
@@ -346,64 +312,59 @@ class AsyncSandboxesClient:
         Note that a full replacement of the scenario is performed, so any fields not provided will be removed
         or overwritten with default values.
 
-        Parameters:
-            - id: str. A UUID string identifying this sandbox.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this sandbox.
 
-            - label: typing.Optional[str].
+        inputs : typing.Sequence[NamedScenarioInputRequest]
+            The inputs for the scenario
 
-            - inputs: typing.Sequence[NamedScenarioInputRequest]. The inputs for the scenario
+        label : typing.Optional[str]
 
-            - scenario_id: typing.Optional[str]. The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.
+        scenario_id : typing.Optional[str]
+            The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SandboxScenario
+
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.sandboxes.upsert_sandbox_scenario(
-            id="id",
-            label="Scenario 1",
-            inputs=[],
-        )
+
+
+        async def main() -> None:
+            await client.sandboxes.upsert_sandbox_scenario(
+                id="id",
+                label="Scenario 1",
+                inputs=[],
+            )
+
+
+        asyncio.run(main())
         """
-        _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
-        if label is not OMIT:
-            _request["label"] = label
-        if scenario_id is not OMIT:
-            _request["scenario_id"] = scenario_id
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/sandboxes/{jsonable_encoder(id)}/scenarios",
+            base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/sandboxes/{jsonable_encoder(id)}/scenarios"
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            json=jsonable_encoder(_request)
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(_request),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
-            },
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            json={"label": label, "inputs": inputs, "scenario_id": scenario_id},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(SandboxScenario, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(SandboxScenario, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -415,49 +376,50 @@ class AsyncSandboxesClient:
         """
         Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
 
-        Parameters:
-            - id: str. A UUID string identifying this sandbox.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this sandbox.
+
+        scenario_id : str
+            An id identifying the scenario that you'd like to delete
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - scenario_id: str. An id identifying the scenario that you'd like to delete
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.sandboxes.delete_sandbox_scenario(
-            id="id",
-            scenario_id="scenario_id",
-        )
+
+
+        async def main() -> None:
+            await client.sandboxes.delete_sandbox_scenario(
+                id="id",
+                scenario_id="scenario_id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/sandboxes/{jsonable_encoder(id)}/scenarios/{jsonable_encoder(scenario_id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="DELETE",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/",
-                f"v1/sandboxes/{jsonable_encoder(id)}/scenarios/{jsonable_encoder(scenario_id)}",
-            ),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            headers=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        **self._client_wrapper.get_headers(),
-                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                    }
-                )
-            ),
-            timeout=request_options.get("timeout_in_seconds")
-            if request_options is not None and request_options.get("timeout_in_seconds") is not None
-            else self._client_wrapper.get_timeout(),
-            retries=0,
-            max_retries=request_options.get("max_retries") if request_options is not None else 0,  # type: ignore
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)