vellum-ai 0.3.10__tar.gz → 0.3.12__tar.gz

{vellum_ai-0.3.10 → vellum_ai-0.3.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.3.10
+Version: 0.3.12
 Summary: 
 Requires-Python: >=3.7,<4.0
 Classifier: Programming Language :: Python :: 3

{vellum_ai-0.3.10 → vellum_ai-0.3.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vellum-ai"
-version = "0.3.10"
+version = "0.3.12"
 description = ""
 readme = "README.md"
 authors = []

{vellum_ai-0.3.10 → vellum_ai-0.3.12}/src/vellum/__init__.py

@@ -18,6 +18,7 @@ from .types import (
     ArrayVariableValueItem_ChatHistory,
     ArrayVariableValueItem_Error,
     ArrayVariableValueItem_FunctionCall,
+    ArrayVariableValueItem_Image,
     ArrayVariableValueItem_Json,
     ArrayVariableValueItem_Number,
     ArrayVariableValueItem_SearchResults,
@@ -82,6 +83,23 @@ from .types import (
     ExecuteWorkflowWorkflowResultEvent,
     ExecuteWorkflowWorkflowResultEvent_Fulfilled,
     ExecuteWorkflowWorkflowResultEvent_Rejected,
+    ExecutionArrayVellumValue,
+    ExecutionChatHistoryVellumValue,
+    ExecutionErrorVellumValue,
+    ExecutionFunctionCallVellumValue,
+    ExecutionJsonVellumValue,
+    ExecutionNumberVellumValue,
+    ExecutionSearchResultsVellumValue,
+    ExecutionStringVellumValue,
+    ExecutionVellumValue,
+    ExecutionVellumValue_Array,
+    ExecutionVellumValue_ChatHistory,
+    ExecutionVellumValue_Error,
+    ExecutionVellumValue_FunctionCall,
+    ExecutionVellumValue_Json,
+    ExecutionVellumValue_Number,
+    ExecutionVellumValue_SearchResults,
+    ExecutionVellumValue_String,
     FinishReasonEnum,
     FulfilledEnum,
     FulfilledExecutePromptEvent,
@@ -112,6 +130,7 @@ from .types import (
     ImageChatMessageContent,
     ImageChatMessageContentRequest,
     ImageEnum,
+    ImageVariableValue,
     IndexingStateEnum,
     InitiatedEnum,
     InitiatedExecutePromptEvent,
@@ -428,6 +447,7 @@ __all__ = [
     "ArrayVariableValueItem_ChatHistory",
     "ArrayVariableValueItem_Error",
     "ArrayVariableValueItem_FunctionCall",
+    "ArrayVariableValueItem_Image",
     "ArrayVariableValueItem_Json",
     "ArrayVariableValueItem_Number",
     "ArrayVariableValueItem_SearchResults",
@@ -496,6 +516,23 @@ __all__ = [
     "ExecuteWorkflowWorkflowResultEvent",
     "ExecuteWorkflowWorkflowResultEvent_Fulfilled",
     "ExecuteWorkflowWorkflowResultEvent_Rejected",
+    "ExecutionArrayVellumValue",
+    "ExecutionChatHistoryVellumValue",
+    "ExecutionErrorVellumValue",
+    "ExecutionFunctionCallVellumValue",
+    "ExecutionJsonVellumValue",
+    "ExecutionNumberVellumValue",
+    "ExecutionSearchResultsVellumValue",
+    "ExecutionStringVellumValue",
+    "ExecutionVellumValue",
+    "ExecutionVellumValue_Array",
+    "ExecutionVellumValue_ChatHistory",
+    "ExecutionVellumValue_Error",
+    "ExecutionVellumValue_FunctionCall",
+    "ExecutionVellumValue_Json",
+    "ExecutionVellumValue_Number",
+    "ExecutionVellumValue_SearchResults",
+    "ExecutionVellumValue_String",
     "FinishReasonEnum",
     "ForbiddenError",
     "FulfilledEnum",
@@ -527,6 +564,7 @@ __all__ = [
     "ImageChatMessageContent",
     "ImageChatMessageContentRequest",
     "ImageEnum",
+    "ImageVariableValue",
     "IndexingStateEnum",
     "InitiatedEnum",
     "InitiatedExecutePromptEvent",

{vellum_ai-0.3.10 → vellum_ai-0.3.12}/src/vellum/client.py

@@ -233,25 +233,25 @@ class Vellum:
     def execute_workflow(
         self,
         *,
+        inputs: typing.List[WorkflowRequestInputRequest],
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
-        inputs: typing.List[WorkflowRequestInputRequest],
         external_id: typing.Optional[str] = OMIT,
     ) -> ExecuteWorkflowResponse:
         """
         Executes a deployed Workflow and returns its outputs.
 
         Parameters:
+            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
+
             - workflow_deployment_id: typing.Optional[str]. The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
 
             - workflow_deployment_name: typing.Optional[str]. The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
 
-            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
-
-            - external_id: typing.Optional[str]. Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if workflow_deployment_id is not OMIT:
@@ -286,10 +286,10 @@ class Vellum:
     def execute_workflow_stream(
         self,
         *,
+        inputs: typing.List[WorkflowRequestInputRequest],
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
-        inputs: typing.List[WorkflowRequestInputRequest],
         external_id: typing.Optional[str] = OMIT,
         event_types: typing.Optional[typing.List[WorkflowExecutionEventType]] = OMIT,
     ) -> typing.Iterator[WorkflowStreamEvent]:
@@ -297,14 +297,14 @@ class Vellum:
         Executes a deployed Workflow and streams back its results.
 
         Parameters:
+            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
+
             - workflow_deployment_id: typing.Optional[str]. The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
 
             - workflow_deployment_name: typing.Optional[str]. The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
 
-            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's deployment with their corresponding values.
-
             - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
 
             - event_types: typing.Optional[typing.List[WorkflowExecutionEventType]]. Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution.
@@ -816,25 +816,25 @@ class AsyncVellum:
     async def execute_workflow(
         self,
         *,
+        inputs: typing.List[WorkflowRequestInputRequest],
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
-        inputs: typing.List[WorkflowRequestInputRequest],
         external_id: typing.Optional[str] = OMIT,
     ) -> ExecuteWorkflowResponse:
         """
         Executes a deployed Workflow and returns its outputs.
 
         Parameters:
+            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
+
             - workflow_deployment_id: typing.Optional[str]. The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
 
             - workflow_deployment_name: typing.Optional[str]. The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
 
-            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
-
-            - external_id: typing.Optional[str]. Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if workflow_deployment_id is not OMIT:
@@ -869,10 +869,10 @@ class AsyncVellum:
     async def execute_workflow_stream(
         self,
         *,
+        inputs: typing.List[WorkflowRequestInputRequest],
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
-        inputs: typing.List[WorkflowRequestInputRequest],
         external_id: typing.Optional[str] = OMIT,
         event_types: typing.Optional[typing.List[WorkflowExecutionEventType]] = OMIT,
     ) -> typing.AsyncIterator[WorkflowStreamEvent]:
@@ -880,14 +880,14 @@ class AsyncVellum:
         Executes a deployed Workflow and streams back its results.
 
         Parameters:
+            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
+
             - workflow_deployment_id: typing.Optional[str]. The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
 
             - workflow_deployment_name: typing.Optional[str]. The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
 
-            - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's deployment with their corresponding values.
-
             - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
 
             - event_types: typing.Optional[typing.List[WorkflowExecutionEventType]]. Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution.

{vellum_ai-0.3.10 → vellum_ai-0.3.12}/src/vellum/core/client_wrapper.py

@@ -16,7 +16,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.3.10",
+            "X-Fern-SDK-Version": "0.3.12",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

{vellum_ai-0.3.10 → vellum_ai-0.3.12}/src/vellum/resources/deployments/client.py

@@ -8,6 +8,10 @@ from ...core.api_error import ApiError
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.remove_none_from_dict import remove_none_from_dict
+from ...errors.bad_request_error import BadRequestError
+from ...errors.forbidden_error import ForbiddenError
+from ...errors.internal_server_error import InternalServerError
+from ...errors.not_found_error import NotFoundError
 from ...types.deployment_provider_payload_response import DeploymentProviderPayloadResponse
 from ...types.deployment_read import DeploymentRead
 from ...types.paginated_slim_deployment_read_list import PaginatedSlimDeploymentReadList
@@ -103,6 +107,7 @@ class DeploymentsClient:
         deployment_id: typing.Optional[str] = OMIT,
         deployment_name: typing.Optional[str] = OMIT,
         inputs: typing.List[PromptDeploymentInputRequest],
+        release_tag: typing.Optional[str] = OMIT,
     ) -> DeploymentProviderPayloadResponse:
         """
         Parameters:
@@ -111,6 +116,8 @@ class DeploymentsClient:
             - deployment_name: typing.Optional[str]. The name of the deployment. Must provide either this or deployment_id.
 
             - inputs: typing.List[PromptDeploymentInputRequest]. The list of inputs defined in the Prompt's deployment with their corresponding values.
+
+            - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
         ---
         from vellum.client import Vellum
 
@@ -126,6 +133,8 @@ class DeploymentsClient:
             _request["deployment_id"] = deployment_id
         if deployment_name is not OMIT:
             _request["deployment_name"] = deployment_name
+        if release_tag is not OMIT:
+            _request["release_tag"] = release_tag
         _response = self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(
@@ -137,6 +146,14 @@ class DeploymentsClient:
         )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(DeploymentProviderPayloadResponse, _response.json())  # type: ignore
+        if _response.status_code == 400:
+            raise BadRequestError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+        if _response.status_code == 403:
+            raise ForbiddenError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+        if _response.status_code == 404:
+            raise NotFoundError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+        if _response.status_code == 500:
+            raise InternalServerError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -224,6 +241,7 @@ class AsyncDeploymentsClient:
         deployment_id: typing.Optional[str] = OMIT,
         deployment_name: typing.Optional[str] = OMIT,
         inputs: typing.List[PromptDeploymentInputRequest],
+        release_tag: typing.Optional[str] = OMIT,
     ) -> DeploymentProviderPayloadResponse:
         """
         Parameters:
@@ -232,6 +250,8 @@ class AsyncDeploymentsClient:
             - deployment_name: typing.Optional[str]. The name of the deployment. Must provide either this or deployment_id.
 
             - inputs: typing.List[PromptDeploymentInputRequest]. The list of inputs defined in the Prompt's deployment with their corresponding values.
+
+            - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
         ---
         from vellum.client import AsyncVellum
 
@@ -247,6 +267,8 @@ class AsyncDeploymentsClient:
             _request["deployment_id"] = deployment_id
         if deployment_name is not OMIT:
             _request["deployment_name"] = deployment_name
+        if release_tag is not OMIT:
+            _request["release_tag"] = release_tag
         _response = await self._client_wrapper.httpx_client.request(
             "POST",
             urllib.parse.urljoin(
@@ -258,6 +280,14 @@ class AsyncDeploymentsClient:
         )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(DeploymentProviderPayloadResponse, _response.json())  # type: ignore
+        if _response.status_code == 400:
+            raise BadRequestError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+        if _response.status_code == 403:
+            raise ForbiddenError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+        if _response.status_code == 404:
+            raise NotFoundError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+        if _response.status_code == 500:
+            raise InternalServerError(pydantic.parse_obj_as(typing.Any, _response.json()))  # type: ignore
         try:
             _response_json = _response.json()
         except JSONDecodeError:

{vellum_ai-0.3.10 → vellum_ai-0.3.12}/src/vellum/resources/document_indexes/client.py

@@ -187,6 +187,147 @@ class DocumentIndexesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def update(
+        self,
+        id: str,
+        *,
+        label: str,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to fully update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: str. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.update(
+            id="id",
+            label="label",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"label": label}
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = self._client_wrapper.httpx_client.request(
+            "PUT",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _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 destroy(self, id: str) -> None:
+        """
+        Used to delete a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.destroy(
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "DELETE",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _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 partial_update(
+        self,
+        id: str,
+        *,
+        label: typing.Optional[str] = OMIT,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to partial update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: typing.Optional[str]. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.partial_update(
+            id="id",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if label is not OMIT:
+            _request["label"] = label
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = self._client_wrapper.httpx_client.request(
+            "PATCH",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _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 AsyncDocumentIndexesClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -351,3 +492,144 @@ class AsyncDocumentIndexesClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def update(
+        self,
+        id: str,
+        *,
+        label: str,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to fully update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: str. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.update(
+            id="id",
+            label="label",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {"label": label}
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = await self._client_wrapper.httpx_client.request(
+            "PUT",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _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 destroy(self, id: str) -> None:
+        """
+        Used to delete a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.destroy(
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "DELETE",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _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 partial_update(
+        self,
+        id: str,
+        *,
+        label: typing.Optional[str] = OMIT,
+        status: typing.Optional[EntityStatus] = OMIT,
+        environment: typing.Optional[EnvironmentEnum] = OMIT,
+    ) -> DocumentIndexRead:
+        """
+        Used to partial update a Document Index given its ID.
+
+        Parameters:
+            - id: str. A UUID string identifying this document index.
+
+            - label: typing.Optional[str]. A human-readable label for the document index
+
+            - status: typing.Optional[EntityStatus]. The current status of the document index
+
+                                                     * `ACTIVE` - Active
+                                                     * `ARCHIVED` - Archived
+            - environment: typing.Optional[EnvironmentEnum]. The environment this document index is used in
+
+                                                             * `DEVELOPMENT` - Development
+                                                             * `STAGING` - Staging
+                                                             * `PRODUCTION` - Production---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.partial_update(
+            id="id",
+        )
+        """
+        _request: typing.Dict[str, typing.Any] = {}
+        if label is not OMIT:
+            _request["label"] = label
+        if status is not OMIT:
+            _request["status"] = status
+        if environment is not OMIT:
+            _request["environment"] = environment
+        _response = await self._client_wrapper.httpx_client.request(
+            "PATCH",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/document-indexes/{id}"),
+            json=jsonable_encoder(_request),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(DocumentIndexRead, _response.json())  # type: ignore
+        try:
+            _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)