vellum-ai 0.14.53__py3-none-any.whl → 0.14.55__py3-none-any.whl

vellum/__init__.py

@@ -65,6 +65,7 @@ from .types import (
     CompilePromptMeta,
     ComponentsSchemasPdfSearchResultMetaSource,
     ComponentsSchemasPdfSearchResultMetaSourceRequest,
+    ComponentsSchemasPromptVersionBuildConfigSandbox,
     ConditionCombinator,
     ConditionalNodeResult,
     ConditionalNodeResultData,
@@ -316,6 +317,7 @@ from .types import (
     PromptRequestJsonInput,
     PromptRequestStringInput,
     PromptSettings,
+    PromptVersionBuildConfigSandbox,
     RawPromptExecutionOverridesRequest,
     ReductoChunkerConfig,
     ReductoChunkerConfigRequest,
@@ -688,6 +690,7 @@ __all__ = [
     "CompilePromptMeta",
     "ComponentsSchemasPdfSearchResultMetaSource",
     "ComponentsSchemasPdfSearchResultMetaSourceRequest",
+    "ComponentsSchemasPromptVersionBuildConfigSandbox",
     "ConditionCombinator",
     "ConditionalNodeResult",
     "ConditionalNodeResultData",
@@ -948,6 +951,7 @@ __all__ = [
     "PromptRequestJsonInput",
     "PromptRequestStringInput",
     "PromptSettings",
+    "PromptVersionBuildConfigSandbox",
     "RawPromptExecutionOverridesRequest",
     "ReductoChunkerConfig",
     "ReductoChunkerConfigRequest",

vellum/client/__init__.py

@@ -7,7 +7,6 @@ from .core.client_wrapper import SyncClientWrapper
 from .resources.ad_hoc.client import AdHocClient
 from .resources.container_images.client import ContainerImagesClient
 from .resources.deployments.client import DeploymentsClient
-from .resources.release_reviews.client import ReleaseReviewsClient
 from .resources.document_indexes.client import DocumentIndexesClient
 from .resources.documents.client import DocumentsClient
 from .resources.folder_entities.client import FolderEntitiesClient
@@ -19,6 +18,7 @@ from .resources.sandboxes.client import SandboxesClient
 from .resources.test_suite_runs.client import TestSuiteRunsClient
 from .resources.test_suites.client import TestSuitesClient
 from .resources.workflow_deployments.client import WorkflowDeploymentsClient
+from .resources.release_reviews.client import ReleaseReviewsClient
 from .resources.workflow_sandboxes.client import WorkflowSandboxesClient
 from .resources.workflows.client import WorkflowsClient
 from .resources.workspace_secrets.client import WorkspaceSecretsClient
@@ -65,7 +65,6 @@ from .core.client_wrapper import AsyncClientWrapper
 from .resources.ad_hoc.client import AsyncAdHocClient
 from .resources.container_images.client import AsyncContainerImagesClient
 from .resources.deployments.client import AsyncDeploymentsClient
-from .resources.release_reviews.client import AsyncReleaseReviewsClient
 from .resources.document_indexes.client import AsyncDocumentIndexesClient
 from .resources.documents.client import AsyncDocumentsClient
 from .resources.folder_entities.client import AsyncFolderEntitiesClient
@@ -77,6 +76,7 @@ from .resources.sandboxes.client import AsyncSandboxesClient
 from .resources.test_suite_runs.client import AsyncTestSuiteRunsClient
 from .resources.test_suites.client import AsyncTestSuitesClient
 from .resources.workflow_deployments.client import AsyncWorkflowDeploymentsClient
+from .resources.release_reviews.client import AsyncReleaseReviewsClient
 from .resources.workflow_sandboxes.client import AsyncWorkflowSandboxesClient
 from .resources.workflows.client import AsyncWorkflowsClient
 from .resources.workspace_secrets.client import AsyncWorkspaceSecretsClient
@@ -143,7 +143,6 @@ class Vellum:
         self.ad_hoc = AdHocClient(client_wrapper=self._client_wrapper)
         self.container_images = ContainerImagesClient(client_wrapper=self._client_wrapper)
         self.deployments = DeploymentsClient(client_wrapper=self._client_wrapper)
-        self.release_reviews = ReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.document_indexes = DocumentIndexesClient(client_wrapper=self._client_wrapper)
         self.documents = DocumentsClient(client_wrapper=self._client_wrapper)
         self.folder_entities = FolderEntitiesClient(client_wrapper=self._client_wrapper)
@@ -155,6 +154,7 @@ class Vellum:
         self.test_suite_runs = TestSuiteRunsClient(client_wrapper=self._client_wrapper)
         self.test_suites = TestSuitesClient(client_wrapper=self._client_wrapper)
         self.workflow_deployments = WorkflowDeploymentsClient(client_wrapper=self._client_wrapper)
+        self.release_reviews = ReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.workflow_sandboxes = WorkflowSandboxesClient(client_wrapper=self._client_wrapper)
         self.workflows = WorkflowsClient(client_wrapper=self._client_wrapper)
         self.workspace_secrets = WorkspaceSecretsClient(client_wrapper=self._client_wrapper)
@@ -1519,7 +1519,6 @@ class AsyncVellum:
         self.ad_hoc = AsyncAdHocClient(client_wrapper=self._client_wrapper)
         self.container_images = AsyncContainerImagesClient(client_wrapper=self._client_wrapper)
         self.deployments = AsyncDeploymentsClient(client_wrapper=self._client_wrapper)
-        self.release_reviews = AsyncReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.document_indexes = AsyncDocumentIndexesClient(client_wrapper=self._client_wrapper)
         self.documents = AsyncDocumentsClient(client_wrapper=self._client_wrapper)
         self.folder_entities = AsyncFolderEntitiesClient(client_wrapper=self._client_wrapper)
@@ -1531,6 +1530,7 @@ class AsyncVellum:
         self.test_suite_runs = AsyncTestSuiteRunsClient(client_wrapper=self._client_wrapper)
         self.test_suites = AsyncTestSuitesClient(client_wrapper=self._client_wrapper)
         self.workflow_deployments = AsyncWorkflowDeploymentsClient(client_wrapper=self._client_wrapper)
+        self.release_reviews = AsyncReleaseReviewsClient(client_wrapper=self._client_wrapper)
         self.workflow_sandboxes = AsyncWorkflowSandboxesClient(client_wrapper=self._client_wrapper)
         self.workflows = AsyncWorkflowsClient(client_wrapper=self._client_wrapper)
         self.workspace_secrets = AsyncWorkspaceSecretsClient(client_wrapper=self._client_wrapper)

vellum/client/core/client_wrapper.py

@@ -18,7 +18,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.14.53",
+            "X-Fern-SDK-Version": "0.14.55",
         }
         headers["X-API-KEY"] = self.api_key
         return headers

vellum/client/reference.md

@@ -1932,7 +1932,8 @@ client.deployments.retrieve(
 <dl>
 <dd>
 
-Retrieve a specific Deployment History Item by either its UUID or the name of a Release Tag that points to it.
+DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
+`retrieve_prompt_deployment_release` xendpoint instead.
 </dd>
 </dl>
 </dd>
@@ -2267,7 +2268,7 @@ client.deployments.update_deployment_release_tag(
 </dl>
 </details>
 
-<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_provider_payload</a>(...)</code></summary>
+<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_prompt_deployment_release</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -2279,16 +2280,7 @@ client.deployments.update_deployment_release_tag(
 <dl>
 <dd>
 
-Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider
-for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
-prompt or make an API call to the model provider.
-
-This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
-to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
-that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
-derive meaning from the response body and instead, should simply pass it directly to the model provider as is.
-
-We encourage you to seek advise from Vellum Support before integrating with this API for production use.
+Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
 </dd>
 </dl>
 </dd>
@@ -2303,18 +2295,14 @@ We encourage you to seek advise from Vellum Support before integrating with this
 <dd>
 
 ```python
-from vellum import StringInputRequest, Vellum
+from vellum import Vellum
 
 client = Vellum(
     api_key="YOUR_API_KEY",
 )
-client.deployments.retrieve_provider_payload(
-    inputs=[
-        StringInputRequest(
-            name="name",
-            value="value",
-        )
-    ],
+client.deployments.retrieve_prompt_deployment_release(
+    id="id",
+    release_id_or_release_tag="release_id_or_release_tag",
 )
 
 ```
@@ -2331,31 +2319,7 @@ client.deployments.retrieve_provider_payload(
 <dl>
 <dd>
 
-**inputs:** `typing.Sequence[PromptDeploymentInputRequest]` — The list of inputs defined in the Prompt's deployment with their corresponding values.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**deployment_id:** `typing.Optional[str]` — The ID of the deployment. Must provide either this or deployment_name.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**deployment_name:** `typing.Optional[str]` — The name of the deployment. Must provide either this or deployment_id.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
+**id:** `str` — A UUID string identifying this deployment.
     
 </dd>
 </dl>
@@ -2363,7 +2327,7 @@ client.deployments.retrieve_provider_payload(
 <dl>
 <dd>
 
-**expand_meta:** `typing.Optional[CompilePromptDeploymentExpandMetaRequest]` 
+**release_id_or_release_tag:** `str` — Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.
     
 </dd>
 </dl>
@@ -2383,8 +2347,7 @@ client.deployments.retrieve_provider_payload(
 </dl>
 </details>
 
-## ReleaseReviews
-<details><summary><code>client.release_reviews.<a href="src/vellum/resources/release_reviews/client.py">retrieve_prompt_deployment_release</a>(...)</code></summary>
+<details><summary><code>client.deployments.<a href="src/vellum/resources/deployments/client.py">retrieve_provider_payload</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -2396,7 +2359,16 @@ client.deployments.retrieve_provider_payload(
 <dl>
 <dd>
 
-Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
+Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider
+for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
+prompt or make an API call to the model provider.
+
+This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
+to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
+that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
+derive meaning from the response body and instead, should simply pass it directly to the model provider as is.
+
+We encourage you to seek advise from Vellum Support before integrating with this API for production use.
 </dd>
 </dl>
 </dd>
@@ -2411,14 +2383,18 @@ Retrieve a specific Prompt Deployment Release by either its UUID or the name of
 <dd>
 
 ```python
-from vellum import Vellum
+from vellum import StringInputRequest, Vellum
 
 client = Vellum(
     api_key="YOUR_API_KEY",
 )
-client.release_reviews.retrieve_prompt_deployment_release(
-    id="id",
-    release_id_or_release_tag="release_id_or_release_tag",
+client.deployments.retrieve_provider_payload(
+    inputs=[
+        StringInputRequest(
+            name="name",
+            value="value",
+        )
+    ],
 )
 
 ```
@@ -2435,7 +2411,7 @@ client.release_reviews.retrieve_prompt_deployment_release(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this deployment.
+**inputs:** `typing.Sequence[PromptDeploymentInputRequest]` — The list of inputs defined in the Prompt's deployment with their corresponding values.
     
 </dd>
 </dl>
@@ -2443,7 +2419,7 @@ client.release_reviews.retrieve_prompt_deployment_release(
 <dl>
 <dd>
 
-**release_id_or_release_tag:** `str` — Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.
+**deployment_id:** `typing.Optional[str]` — The ID of the deployment. Must provide either this or deployment_name.
     
 </dd>
 </dl>
@@ -2451,70 +2427,15 @@ client.release_reviews.retrieve_prompt_deployment_release(
 <dl>
 <dd>
 
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**deployment_name:** `typing.Optional[str]` — The name of the deployment. Must provide either this or deployment_id.
     
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.release_reviews.<a href="src/vellum/resources/release_reviews/client.py">retrieve_workflow_deployment_release</a>(...)</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```python
-from vellum import Vellum
-
-client = Vellum(
-    api_key="YOUR_API_KEY",
-)
-client.release_reviews.retrieve_workflow_deployment_release(
-    id="id",
-    release_id_or_release_tag="release_id_or_release_tag",
-)
-
-```
-</dd>
-</dl>
 </dd>
 </dl>
 
-#### ⚙️ Parameters
-
 <dl>
 <dd>
 
-<dl>
-<dd>
-
-**id:** `str` — A UUID string identifying this workflow deployment.
+**release_tag:** `typing.Optional[str]` — Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
     
 </dd>
 </dl>
@@ -2522,7 +2443,7 @@ client.release_reviews.retrieve_workflow_deployment_release(
 <dl>
 <dd>
 
-**release_id_or_release_tag:** `str` — Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve.
+**expand_meta:** `typing.Optional[CompilePromptDeploymentExpandMetaRequest]` 
     
 </dd>
 </dl>
@@ -5664,7 +5585,8 @@ client.workflow_deployments.workflow_deployment_event_execution(
 <dl>
 <dd>
 
-Retrieve a specific Workflow Deployment History Item by either its UUID or the name of a Release Tag that points to it.
+DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
+`retrieve_workflow_deployment_release` endpoint instead.
 </dd>
 </dl>
 </dd>
@@ -5995,6 +5917,86 @@ client.workflow_deployments.update_workflow_release_tag(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## ReleaseReviews
+<details><summary><code>client.release_reviews.<a href="src/vellum/resources/release_reviews/client.py">retrieve_workflow_deployment_release</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a specific Workflow Deployment Release by either its UUID or the name of a Release Tag that points to it.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import Vellum
+
+client = Vellum(
+    api_key="YOUR_API_KEY",
+)
+client.release_reviews.retrieve_workflow_deployment_release(
+    id="id",
+    release_id_or_release_tag="release_id_or_release_tag",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `str` — A UUID string identifying this workflow deployment.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**release_id_or_release_tag:** `str` — Either the UUID of Workflow Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Workflow Deployment Release you'd like to retrieve.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

vellum/client/resources/deployments/client.py

@@ -14,6 +14,7 @@ from ...types.deployment_history_item import DeploymentHistoryItem
 from .types.list_deployment_release_tags_request_source import ListDeploymentReleaseTagsRequestSource
 from ...types.paginated_deployment_release_tag_read_list import PaginatedDeploymentReleaseTagReadList
 from ...types.deployment_release_tag_read import DeploymentReleaseTagRead
+from ...types.prompt_deployment_release import PromptDeploymentRelease
 from ...types.prompt_deployment_input_request import PromptDeploymentInputRequest
 from ...types.compile_prompt_deployment_expand_meta_request import CompilePromptDeploymentExpandMetaRequest
 from ...types.deployment_provider_payload_response import DeploymentProviderPayloadResponse
@@ -153,7 +154,8 @@ class DeploymentsClient:
         self, history_id_or_release_tag: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> DeploymentHistoryItem:
         """
-        Retrieve a specific Deployment History Item by either its UUID or the name of a Release Tag that points to it.
+        DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
+        `retrieve_prompt_deployment_release` xendpoint instead.
 
         Parameters
         ----------
@@ -400,6 +402,60 @@ class DeploymentsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def retrieve_prompt_deployment_release(
+        self, id: str, release_id_or_release_tag: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PromptDeploymentRelease:
+        """
+        Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
+
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this deployment.
+
+        release_id_or_release_tag : str
+            Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptDeploymentRelease
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.deployments.retrieve_prompt_deployment_release(
+            id="id",
+            release_id_or_release_tag="release_id_or_release_tag",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/deployments/{jsonable_encoder(id)}/releases/{jsonable_encoder(release_id_or_release_tag)}",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptDeploymentRelease,
+                    parse_obj_as(
+                        type_=PromptDeploymentRelease,  # 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)
+
     def retrieve_provider_payload(
         self,
         *,
@@ -679,7 +735,8 @@ class AsyncDeploymentsClient:
         self, history_id_or_release_tag: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> DeploymentHistoryItem:
         """
-        Retrieve a specific Deployment History Item by either its UUID or the name of a Release Tag that points to it.
+        DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the
+        `retrieve_prompt_deployment_release` xendpoint instead.
 
         Parameters
         ----------
@@ -958,6 +1015,68 @@ class AsyncDeploymentsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    async def retrieve_prompt_deployment_release(
+        self, id: str, release_id_or_release_tag: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PromptDeploymentRelease:
+        """
+        Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it.
+
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this deployment.
+
+        release_id_or_release_tag : str
+            Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptDeploymentRelease
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.deployments.retrieve_prompt_deployment_release(
+                id="id",
+                release_id_or_release_tag="release_id_or_release_tag",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/deployments/{jsonable_encoder(id)}/releases/{jsonable_encoder(release_id_or_release_tag)}",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptDeploymentRelease,
+                    parse_obj_as(
+                        type_=PromptDeploymentRelease,  # 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)
+
     async def retrieve_provider_payload(
         self,
         *,