vellum-ai 0.6.9__py3-none-any.whl → 0.7.2__py3-none-any.whl

vellum/client.py

@@ -42,6 +42,7 @@ from .types.search_response import SearchResponse
 from .types.submit_completion_actual_request import SubmitCompletionActualRequest
 from .types.submit_workflow_execution_actual_request import SubmitWorkflowExecutionActualRequest
 from .types.workflow_execution_event_type import WorkflowExecutionEventType
+from .types.workflow_expand_meta_request import WorkflowExpandMetaRequest
 from .types.workflow_request_input_request import WorkflowRequestInputRequest
 from .types.workflow_stream_event import WorkflowStreamEvent
 
@@ -121,23 +122,23 @@ class Vellum:
         Executes a deployed Prompt and returns the result.
 
         Parameters:
-            - inputs: typing.Sequence[PromptDeploymentInputRequest]. The list of inputs defined in the Prompt's deployment with their corresponding values.
+            - inputs: typing.Sequence[PromptDeploymentInputRequest]. A list consisting of the Prompt Deployment's input variables and their values.
 
             - prompt_deployment_id: typing.Optional[str]. The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
 
-            - prompt_deployment_name: typing.Optional[str]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - prompt_deployment_name: typing.Optional[str]. The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment.
 
-            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response.
 
-            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest].
+            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest]. Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models.
 
-            - expand_raw: typing.Optional[typing.Sequence[str]]. Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models.
+            - expand_raw: typing.Optional[typing.Sequence[str]]. A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response.
 
-            - metadata: typing.Optional[typing.Dict[str, typing.Any]].
+            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
@@ -164,11 +165,11 @@ class Vellum:
             external_id="string",
             expand_meta=PromptDeploymentExpandMetaRequestRequest(
                 model_name=True,
+                usage=True,
+                finish_reason=True,
                 latency=True,
                 deployment_release_tag=True,
                 prompt_version_id=True,
-                finish_reason=True,
-                usage=True,
             ),
             raw_overrides=RawPromptExecutionOverridesRequest(
                 body={"string": {"key": "value"}},
@@ -256,23 +257,23 @@ class Vellum:
         Executes a deployed Prompt and streams back the results.
 
         Parameters:
-            - inputs: typing.Sequence[PromptDeploymentInputRequest]. The list of inputs defined in the Prompt's deployment with their corresponding values.
+            - inputs: typing.Sequence[PromptDeploymentInputRequest]. A list consisting of the Prompt Deployment's input variables and their values.
 
             - prompt_deployment_id: typing.Optional[str]. The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
 
-            - prompt_deployment_name: typing.Optional[str]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - prompt_deployment_name: typing.Optional[str]. The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment.
 
-            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response.
 
-            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest].
+            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest]. Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models.
 
-            - expand_raw: typing.Optional[typing.Sequence[str]]. Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models.
+            - expand_raw: typing.Optional[typing.Sequence[str]]. A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response.
 
-            - metadata: typing.Optional[typing.Dict[str, typing.Any]].
+            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
@@ -299,11 +300,11 @@ class Vellum:
             external_id="string",
             expand_meta=PromptDeploymentExpandMetaRequestRequest(
                 model_name=True,
+                usage=True,
+                finish_reason=True,
                 latency=True,
                 deployment_release_tag=True,
                 prompt_version_id=True,
-                finish_reason=True,
-                usage=True,
             ),
             raw_overrides=RawPromptExecutionOverridesRequest(
                 body={"string": {"key": "value"}},
@@ -382,6 +383,7 @@ class Vellum:
         self,
         *,
         inputs: typing.Sequence[WorkflowRequestInputRequest],
+        expand_meta: typing.Optional[WorkflowExpandMetaRequest] = OMIT,
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
@@ -394,6 +396,8 @@ class Vellum:
         Parameters:
             - inputs: typing.Sequence[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
 
+            - expand_meta: typing.Optional[WorkflowExpandMetaRequest]. An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the `execution_meta` key within NODE events in the response stream.
+
             - 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.
@@ -404,7 +408,7 @@ class Vellum:
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
-        from vellum import WorkflowRequestInputRequest_String
+        from vellum import WorkflowExpandMetaRequest, WorkflowRequestInputRequest_String
         from vellum.client import Vellum
 
         client = Vellum(
@@ -417,6 +421,9 @@ class Vellum:
                     value="string",
                 )
             ],
+            expand_meta=WorkflowExpandMetaRequest(
+                usage=True,
+            ),
             workflow_deployment_id="string",
             workflow_deployment_name="string",
             release_tag="string",
@@ -424,6 +431,8 @@ class Vellum:
         )
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
+        if expand_meta is not OMIT:
+            _request["expand_meta"] = expand_meta
         if workflow_deployment_id is not OMIT:
             _request["workflow_deployment_id"] = workflow_deployment_id
         if workflow_deployment_name is not OMIT:
@@ -476,6 +485,7 @@ class Vellum:
         self,
         *,
         inputs: typing.Sequence[WorkflowRequestInputRequest],
+        expand_meta: typing.Optional[WorkflowExpandMetaRequest] = OMIT,
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
@@ -489,6 +499,8 @@ class Vellum:
         Parameters:
             - inputs: typing.Sequence[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
 
+            - expand_meta: typing.Optional[WorkflowExpandMetaRequest]. An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the `execution_meta` key within NODE events in the response stream.
+
             - 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.
@@ -501,7 +513,7 @@ class Vellum:
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
-        from vellum import WorkflowRequestInputRequest_String
+        from vellum import WorkflowExpandMetaRequest, WorkflowRequestInputRequest_String
         from vellum.client import Vellum
 
         client = Vellum(
@@ -514,6 +526,9 @@ class Vellum:
                     value="string",
                 )
             ],
+            expand_meta=WorkflowExpandMetaRequest(
+                usage=True,
+            ),
             workflow_deployment_id="string",
             workflow_deployment_name="string",
             release_tag="string",
@@ -522,6 +537,8 @@ class Vellum:
         )
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
+        if expand_meta is not OMIT:
+            _request["expand_meta"] = expand_meta
         if workflow_deployment_id is not OMIT:
             _request["workflow_deployment_id"] = workflow_deployment_id
         if workflow_deployment_name is not OMIT:
@@ -1082,23 +1099,23 @@ class AsyncVellum:
         Executes a deployed Prompt and returns the result.
 
         Parameters:
-            - inputs: typing.Sequence[PromptDeploymentInputRequest]. The list of inputs defined in the Prompt's deployment with their corresponding values.
+            - inputs: typing.Sequence[PromptDeploymentInputRequest]. A list consisting of the Prompt Deployment's input variables and their values.
 
             - prompt_deployment_id: typing.Optional[str]. The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
 
-            - prompt_deployment_name: typing.Optional[str]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - prompt_deployment_name: typing.Optional[str]. The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment.
 
-            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response.
 
-            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest].
+            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest]. Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models.
 
-            - expand_raw: typing.Optional[typing.Sequence[str]]. Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models.
+            - expand_raw: typing.Optional[typing.Sequence[str]]. A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response.
 
-            - metadata: typing.Optional[typing.Dict[str, typing.Any]].
+            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
@@ -1125,11 +1142,11 @@ class AsyncVellum:
             external_id="string",
             expand_meta=PromptDeploymentExpandMetaRequestRequest(
                 model_name=True,
+                usage=True,
+                finish_reason=True,
                 latency=True,
                 deployment_release_tag=True,
                 prompt_version_id=True,
-                finish_reason=True,
-                usage=True,
             ),
             raw_overrides=RawPromptExecutionOverridesRequest(
                 body={"string": {"key": "value"}},
@@ -1217,23 +1234,23 @@ class AsyncVellum:
         Executes a deployed Prompt and streams back the results.
 
         Parameters:
-            - inputs: typing.Sequence[PromptDeploymentInputRequest]. The list of inputs defined in the Prompt's deployment with their corresponding values.
+            - inputs: typing.Sequence[PromptDeploymentInputRequest]. A list consisting of the Prompt Deployment's input variables and their values.
 
             - prompt_deployment_id: typing.Optional[str]. The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
 
-            - prompt_deployment_name: typing.Optional[str]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - prompt_deployment_name: typing.Optional[str]. The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment.
 
-            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
+            - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response.
 
-            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest].
+            - raw_overrides: typing.Optional[RawPromptExecutionOverridesRequest]. Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models.
 
-            - expand_raw: typing.Optional[typing.Sequence[str]]. Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models.
+            - expand_raw: typing.Optional[typing.Sequence[str]]. A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response.
 
-            - metadata: typing.Optional[typing.Dict[str, typing.Any]].
+            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
@@ -1260,11 +1277,11 @@ class AsyncVellum:
             external_id="string",
             expand_meta=PromptDeploymentExpandMetaRequestRequest(
                 model_name=True,
+                usage=True,
+                finish_reason=True,
                 latency=True,
                 deployment_release_tag=True,
                 prompt_version_id=True,
-                finish_reason=True,
-                usage=True,
             ),
             raw_overrides=RawPromptExecutionOverridesRequest(
                 body={"string": {"key": "value"}},
@@ -1343,6 +1360,7 @@ class AsyncVellum:
         self,
         *,
         inputs: typing.Sequence[WorkflowRequestInputRequest],
+        expand_meta: typing.Optional[WorkflowExpandMetaRequest] = OMIT,
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
@@ -1355,6 +1373,8 @@ class AsyncVellum:
         Parameters:
             - inputs: typing.Sequence[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
 
+            - expand_meta: typing.Optional[WorkflowExpandMetaRequest]. An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the `execution_meta` key within NODE events in the response stream.
+
             - 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.
@@ -1365,7 +1385,7 @@ class AsyncVellum:
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
-        from vellum import WorkflowRequestInputRequest_String
+        from vellum import WorkflowExpandMetaRequest, WorkflowRequestInputRequest_String
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
@@ -1378,6 +1398,9 @@ class AsyncVellum:
                     value="string",
                 )
             ],
+            expand_meta=WorkflowExpandMetaRequest(
+                usage=True,
+            ),
             workflow_deployment_id="string",
             workflow_deployment_name="string",
             release_tag="string",
@@ -1385,6 +1408,8 @@ class AsyncVellum:
         )
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
+        if expand_meta is not OMIT:
+            _request["expand_meta"] = expand_meta
         if workflow_deployment_id is not OMIT:
             _request["workflow_deployment_id"] = workflow_deployment_id
         if workflow_deployment_name is not OMIT:
@@ -1437,6 +1462,7 @@ class AsyncVellum:
         self,
         *,
         inputs: typing.Sequence[WorkflowRequestInputRequest],
+        expand_meta: typing.Optional[WorkflowExpandMetaRequest] = OMIT,
         workflow_deployment_id: typing.Optional[str] = OMIT,
         workflow_deployment_name: typing.Optional[str] = OMIT,
         release_tag: typing.Optional[str] = OMIT,
@@ -1450,6 +1476,8 @@ class AsyncVellum:
         Parameters:
             - inputs: typing.Sequence[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
 
+            - expand_meta: typing.Optional[WorkflowExpandMetaRequest]. An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the `execution_meta` key within NODE events in the response stream.
+
             - 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.
@@ -1462,7 +1490,7 @@ class AsyncVellum:
 
             - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
-        from vellum import WorkflowRequestInputRequest_String
+        from vellum import WorkflowExpandMetaRequest, WorkflowRequestInputRequest_String
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
@@ -1475,6 +1503,9 @@ class AsyncVellum:
                     value="string",
                 )
             ],
+            expand_meta=WorkflowExpandMetaRequest(
+                usage=True,
+            ),
             workflow_deployment_id="string",
             workflow_deployment_name="string",
             release_tag="string",
@@ -1483,6 +1514,8 @@ class AsyncVellum:
         )
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
+        if expand_meta is not OMIT:
+            _request["expand_meta"] = expand_meta
         if workflow_deployment_id is not OMIT:
             _request["workflow_deployment_id"] = workflow_deployment_id
         if workflow_deployment_name is not OMIT:

vellum/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.6.9",
+            "X-Fern-SDK-Version": "0.7.2",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

vellum/lib/test_suites/resources.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import logging
 import time
 from functools import cached_property
-from typing import Callable, Generator, List, Any
+from typing import Callable, Generator, List, cast, Iterable
 
 from vellum import TestSuiteRunRead, TestSuiteRunMetricOutput_Number
 from vellum.client import Vellum
@@ -174,7 +174,7 @@ class VellumTestSuiteRunResults:
         self,
         metric_identifier: str | None = None,
         output_identifier: str | None = None,
-    ) -> List[float]:
+    ) -> List[float | None]:
         """Returns the values of a numeric metric output that match the given criteria."""
 
         metric_outputs: list[TestSuiteRunMetricOutput_Number] = []
@@ -198,7 +198,7 @@ class VellumTestSuiteRunResults:
         output_values = self.get_numeric_metric_output_values(
             metric_identifier=metric_identifier, output_identifier=output_identifier
         )
-        return sum(output_values) / len(output_values)
+        return sum(cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values))) / len(output_values)
 
     def get_min_metric_output(
         self, metric_identifier: str | None = None, output_identifier: str | None = None
@@ -207,7 +207,7 @@ class VellumTestSuiteRunResults:
         output_values = self.get_numeric_metric_output_values(
             metric_identifier=metric_identifier, output_identifier=output_identifier
         )
-        return min(output_values)
+        return min(cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values)))
 
     def get_max_metric_output(
         self, metric_identifier: str | None = None, output_identifier: str | None = None
@@ -216,7 +216,7 @@ class VellumTestSuiteRunResults:
         output_values = self.get_numeric_metric_output_values(
             metric_identifier=metric_identifier, output_identifier=output_identifier
         )
-        return max(output_values)
+        return max(cast(Iterable[float], filter(lambda o: isinstance(o, float), output_values)))
 
     def wait_until_complete(self) -> None:
         """Wait until the Test Suite Run is no longer in a QUEUED or RUNNING state."""

vellum/resources/document_indexes/client.py

@@ -458,6 +458,63 @@ class DocumentIndexesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def add_document(
+        self, document_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Adds a previously uploaded Document to the specified Document Index.
+
+        Parameters:
+            - document_id: str. Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.
+
+            - id: str. Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.document_indexes.add_document(
+            document_id="document_id",
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            method="POST",
+            url=urllib.parse.urljoin(
+                f"{self._client_wrapper.get_environment().default}/",
+                f"v1/document-indexes/{jsonable_encoder(id)}/documents/{jsonable_encoder(document_id)}",
+            ),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_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
+        )
+        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 remove_document(
         self, document_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> None:
@@ -950,6 +1007,63 @@ class AsyncDocumentIndexesClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    async def add_document(
+        self, document_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> None:
+        """
+        Adds a previously uploaded Document to the specified Document Index.
+
+        Parameters:
+            - document_id: str. Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.
+
+            - id: str. Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.document_indexes.add_document(
+            document_id="document_id",
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            method="POST",
+            url=urllib.parse.urljoin(
+                f"{self._client_wrapper.get_environment().default}/",
+                f"v1/document-indexes/{jsonable_encoder(id)}/documents/{jsonable_encoder(document_id)}",
+            ),
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            json=jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_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
+        )
+        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 remove_document(
         self, document_id: str, id: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> None: