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

vellum/resources/documents/client.py

@@ -1,7 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-import urllib.parse
 from json.decoder import JSONDecodeError
 
 from ... import core
@@ -9,7 +8,6 @@ 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 ...errors.bad_request_error import BadRequestError
 from ...errors.internal_server_error import InternalServerError
@@ -39,17 +37,30 @@ class DocumentsClient:
         """
         Used to list documents. Optionally filter on supported fields.
 
-        Parameters:
-            - document_index_id: typing.Optional[str]. Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
+        Parameters
+        ----------
+        document_index_id : typing.Optional[str]
+            Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
 
-            - limit: typing.Optional[int]. Number of results to return per page.
+        limit : typing.Optional[int]
+            Number of results to return per page.
 
-            - offset: typing.Optional[int]. The initial index from which to return the results.
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
 
-            - ordering: typing.Optional[str]. Which field to use when ordering the results.
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedSlimDocumentList
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -58,40 +69,15 @@ class DocumentsClient:
         client.documents.list()
         """
         _response = self._client_wrapper.httpx_client.request(
+            "v1/documents",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/documents"),
-            params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "document_index_id": document_index_id,
-                        "limit": limit,
-                        "offset": offset,
-                        "ordering": ordering,
-                        **(
-                            request_options.get("additional_query_parameters", {})
-                            if request_options is not None
-                            else {}
-                        ),
-                    }
-                )
-            ),
-            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
+            params={"document_index_id": document_index_id, "limit": limit, "offset": offset, "ordering": ordering},
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(PaginatedSlimDocumentList, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(PaginatedSlimDocumentList, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -101,11 +87,21 @@ class DocumentsClient:
         """
         Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.
 
-        Parameters:
-            - id: str. A UUID string identifying this document.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this document.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DocumentRead
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -116,30 +112,14 @@ class DocumentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/documents/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/documents/{jsonable_encoder(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 pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -149,11 +129,20 @@ class DocumentsClient:
         """
         Delete a Document, keying off of either its Vellum-generated ID or its external ID.
 
-        Parameters:
-            - id: str. A UUID string identifying this document.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this document.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -164,30 +153,14 @@ class DocumentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/documents/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="DELETE",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/documents/{jsonable_encoder(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)
@@ -205,18 +178,32 @@ class DocumentsClient:
         """
         Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.
 
-        Parameters:
-            - id: str. A UUID string identifying this document.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this document.
+
+        label : typing.Optional[str]
+            A human-readable label for the document. Defaults to the originally uploaded file's file name.
+
+        status : typing.Optional[DocumentStatus]
+            The current status of the document
 
-            - label: typing.Optional[str]. A human-readable label for the document. Defaults to the originally uploaded file's file name.
+            * `ACTIVE` - Active
 
-            - status: typing.Optional[DocumentStatus]. The current status of the document
+        metadata : typing.Optional[typing.Dict[str, typing.Any]]
+            A JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
-                                                       * `ACTIVE` - Active
-            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Returns
+        -------
+        DocumentRead
+
+
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -226,44 +213,17 @@ class DocumentsClient:
             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 metadata is not OMIT:
-            _request["metadata"] = metadata
         _response = self._client_wrapper.httpx_client.request(
+            f"v1/documents/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/documents/{jsonable_encoder(id)}"
-            ),
-            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, "status": status, "metadata": metadata},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -272,10 +232,10 @@ class DocumentsClient:
     def upload(
         self,
         *,
-        add_to_index_names: typing.Optional[typing.List[str]] = None,
-        external_id: typing.Optional[str] = None,
         label: str,
         contents: core.File,
+        add_to_index_names: typing.Optional[typing.List[str]] = None,
+        external_id: typing.Optional[str] = None,
         keywords: typing.Optional[typing.List[str]] = None,
         metadata: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
@@ -293,21 +253,36 @@ class DocumentsClient:
         - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
         - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
-        Parameters:
-            - add_to_index_names: typing.Optional[typing.List[str]]. Optionally include the names of all indexes that you'd like this document to be included in
+        Parameters
+        ----------
+        label : str
+            A human-friendly name for this document. Typically the filename.
+
+        contents : core.File
+            See core.File for more documentation
+
+        add_to_index_names : typing.Optional[typing.List[str]]
+            Optionally include the names of all indexes that you'd like this document to be included in
+
+        external_id : typing.Optional[str]
+            Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
 
-            - external_id: typing.Optional[str]. Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+        keywords : typing.Optional[typing.List[str]]
+            Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
 
-            - label: str. A human-friendly name for this document. Typically the filename.
+        metadata : typing.Optional[str]
+            A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
-            - contents: core.File. See core.File for more documentation
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - keywords: typing.Optional[typing.List[str]]. Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+        Returns
+        -------
+        UploadDocumentResponse
 
-            - metadata: typing.Optional[str]. A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
         from vellum.client import Vellum
 
         client = Vellum(
@@ -318,61 +293,29 @@ class DocumentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
+            "v1/upload-document",
+            base_url=self._client_wrapper.get_environment().documents,
             method="POST",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().documents}/", "v1/upload-document"),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            data=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "add_to_index_names": add_to_index_names,
-                        "external_id": external_id,
-                        "label": label,
-                        "keywords": keywords,
-                        "metadata": metadata,
-                    }
-                )
-            )
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(
-                    remove_none_from_dict(
-                        {
-                            "add_to_index_names": add_to_index_names,
-                            "external_id": external_id,
-                            "label": label,
-                            "keywords": keywords,
-                            "metadata": metadata,
-                        }
-                    )
-                ),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            data={
+                "add_to_index_names": add_to_index_names,
+                "external_id": external_id,
+                "label": label,
+                "keywords": keywords,
+                "metadata": metadata,
             },
-            files=core.convert_file_dict_to_httpx_tuples(remove_none_from_dict({"contents": contents})),
-            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
+            files={"contents": contents},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(UploadDocumentResponse, _response.json())  # type: ignore
-        if _response.status_code == 400:
-            raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
-        if _response.status_code == 404:
-            raise NotFoundError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
-        if _response.status_code == 500:
-            raise InternalServerError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(UploadDocumentResponse, _response.json())  # type: ignore
+            if _response.status_code == 400:
+                raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+            if _response.status_code == 404:
+                raise NotFoundError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+            if _response.status_code == 500:
+                raise InternalServerError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -395,59 +338,55 @@ class AsyncDocumentsClient:
         """
         Used to list documents. Optionally filter on supported fields.
 
-        Parameters:
-            - document_index_id: typing.Optional[str]. Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
+        Parameters
+        ----------
+        document_index_id : typing.Optional[str]
+            Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
+
+        limit : typing.Optional[int]
+            Number of results to return per page.
+
+        offset : typing.Optional[int]
+            The initial index from which to return the results.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - limit: typing.Optional[int]. Number of results to return per page.
+        Returns
+        -------
+        PaginatedSlimDocumentList
 
-            - offset: typing.Optional[int]. The initial index from which to return the results.
 
-            - ordering: typing.Optional[str]. Which field to use when ordering the results.
+        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.documents.list()
+
+
+        async def main() -> None:
+            await client.documents.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            "v1/documents",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", "v1/documents"),
-            params=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "document_index_id": document_index_id,
-                        "limit": limit,
-                        "offset": offset,
-                        "ordering": ordering,
-                        **(
-                            request_options.get("additional_query_parameters", {})
-                            if request_options is not None
-                            else {}
-                        ),
-                    }
-                )
-            ),
-            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
+            params={"document_index_id": document_index_id, "limit": limit, "offset": offset, "ordering": ordering},
+            request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(PaginatedSlimDocumentList, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(PaginatedSlimDocumentList, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -457,45 +396,47 @@ class AsyncDocumentsClient:
         """
         Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.
 
-        Parameters:
-            - id: str. A UUID string identifying this document.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this document.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DocumentRead
+
+
+        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.documents.retrieve(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.documents.retrieve(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/documents/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/documents/{jsonable_encoder(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 pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -505,45 +446,46 @@ class AsyncDocumentsClient:
         """
         Delete a Document, keying off of either its Vellum-generated ID or its external ID.
 
-        Parameters:
-            - id: str. A UUID string identifying this document.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this document.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        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.documents.destroy(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.documents.destroy(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/documents/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="DELETE",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/documents/{jsonable_encoder(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)
@@ -561,65 +503,60 @@ class AsyncDocumentsClient:
         """
         Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.
 
-        Parameters:
-            - id: str. A UUID string identifying this document.
+        Parameters
+        ----------
+        id : str
+            A UUID string identifying this document.
 
-            - label: typing.Optional[str]. A human-readable label for the document. Defaults to the originally uploaded file's file name.
+        label : typing.Optional[str]
+            A human-readable label for the document. Defaults to the originally uploaded file's file name.
 
-            - status: typing.Optional[DocumentStatus]. The current status of the document
+        status : typing.Optional[DocumentStatus]
+            The current status of the document
 
-                                                       * `ACTIVE` - Active
-            - metadata: typing.Optional[typing.Dict[str, typing.Any]]. A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+            * `ACTIVE` - Active
+
+        metadata : typing.Optional[typing.Dict[str, typing.Any]]
+            A JSON object containing any metadata associated with the document that you'd like to filter upon later.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DocumentRead
+
+
+        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.documents.partial_update(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.documents.partial_update(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
-        _request: typing.Dict[str, typing.Any] = {}
-        if label is not OMIT:
-            _request["label"] = label
-        if status is not OMIT:
-            _request["status"] = status
-        if metadata is not OMIT:
-            _request["metadata"] = metadata
         _response = await self._client_wrapper.httpx_client.request(
+            f"v1/documents/{jsonable_encoder(id)}",
+            base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            url=urllib.parse.urljoin(
-                f"{self._client_wrapper.get_environment().default}/", f"v1/documents/{jsonable_encoder(id)}"
-            ),
-            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, "status": status, "metadata": metadata},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -628,10 +565,10 @@ class AsyncDocumentsClient:
     async def upload(
         self,
         *,
-        add_to_index_names: typing.Optional[typing.List[str]] = None,
-        external_id: typing.Optional[str] = None,
         label: str,
         contents: core.File,
+        add_to_index_names: typing.Optional[typing.List[str]] = None,
+        external_id: typing.Optional[str] = None,
         keywords: typing.Optional[typing.List[str]] = None,
         metadata: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
@@ -649,86 +586,77 @@ class AsyncDocumentsClient:
         - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
         - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
-        Parameters:
-            - add_to_index_names: typing.Optional[typing.List[str]]. Optionally include the names of all indexes that you'd like this document to be included in
+        Parameters
+        ----------
+        label : str
+            A human-friendly name for this document. Typically the filename.
+
+        contents : core.File
+            See core.File for more documentation
+
+        add_to_index_names : typing.Optional[typing.List[str]]
+            Optionally include the names of all indexes that you'd like this document to be included in
+
+        external_id : typing.Optional[str]
+            Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
 
-            - external_id: typing.Optional[str]. Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
+        keywords : typing.Optional[typing.List[str]]
+            Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
 
-            - label: str. A human-friendly name for this document. Typically the filename.
+        metadata : typing.Optional[str]
+            A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
-            - contents: core.File. See core.File for more documentation
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
 
-            - keywords: typing.Optional[typing.List[str]]. Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
+        Returns
+        -------
+        UploadDocumentResponse
 
-            - metadata: typing.Optional[str]. A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
-            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
-        ---
+        Examples
+        --------
+        import asyncio
+
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
         )
-        await client.documents.upload(
-            label="label",
-        )
+
+
+        async def main() -> None:
+            await client.documents.upload(
+                label="label",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
+            "v1/upload-document",
+            base_url=self._client_wrapper.get_environment().documents,
             method="POST",
-            url=urllib.parse.urljoin(f"{self._client_wrapper.get_environment().documents}/", "v1/upload-document"),
-            params=jsonable_encoder(
-                request_options.get("additional_query_parameters") if request_options is not None else None
-            ),
-            data=jsonable_encoder(
-                remove_none_from_dict(
-                    {
-                        "add_to_index_names": add_to_index_names,
-                        "external_id": external_id,
-                        "label": label,
-                        "keywords": keywords,
-                        "metadata": metadata,
-                    }
-                )
-            )
-            if request_options is None or request_options.get("additional_body_parameters") is None
-            else {
-                **jsonable_encoder(
-                    remove_none_from_dict(
-                        {
-                            "add_to_index_names": add_to_index_names,
-                            "external_id": external_id,
-                            "label": label,
-                            "keywords": keywords,
-                            "metadata": metadata,
-                        }
-                    )
-                ),
-                **(jsonable_encoder(remove_none_from_dict(request_options.get("additional_body_parameters", {})))),
+            data={
+                "add_to_index_names": add_to_index_names,
+                "external_id": external_id,
+                "label": label,
+                "keywords": keywords,
+                "metadata": metadata,
             },
-            files=core.convert_file_dict_to_httpx_tuples(remove_none_from_dict({"contents": contents})),
-            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
+            files={"contents": contents},
+            request_options=request_options,
+            omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(UploadDocumentResponse, _response.json())  # type: ignore
-        if _response.status_code == 400:
-            raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
-        if _response.status_code == 404:
-            raise NotFoundError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
-        if _response.status_code == 500:
-            raise InternalServerError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(UploadDocumentResponse, _response.json())  # type: ignore
+            if _response.status_code == 400:
+                raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+            if _response.status_code == 404:
+                raise NotFoundError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+            if _response.status_code == 500:
+                raise InternalServerError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)