vellum-ai 0.14.41__py3-none-any.whl → 1.11.2__py3-none-any.whl

vellum/client/resources/document_indexes/types/__init__.py

@@ -1,5 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+
 from .document_indexes_list_request_status import DocumentIndexesListRequestStatus
 
 __all__ = ["DocumentIndexesListRequestStatus"]

vellum/client/resources/documents/__init__.py

@@ -1,2 +1,4 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+

vellum/client/resources/documents/client.py

@@ -1,21 +1,15 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from ...core.client_wrapper import SyncClientWrapper
+
+from ... import core
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.request_options import RequestOptions
-from ...types.paginated_slim_document_list import PaginatedSlimDocumentList
-from ...core.pydantic_utilities import parse_obj_as
-from json.decoder import JSONDecodeError
-from ...core.api_error import ApiError
 from ...types.document_read import DocumentRead
-from ...core.jsonable_encoder import jsonable_encoder
 from ...types.document_status import DocumentStatus
-from ... import core
+from ...types.paginated_slim_document_list import PaginatedSlimDocumentList
 from ...types.upload_document_response import UploadDocumentResponse
-from ...errors.bad_request_error import BadRequestError
-from ...errors.not_found_error import NotFoundError
-from ...errors.internal_server_error import InternalServerError
-from ...core.client_wrapper import AsyncClientWrapper
+from .raw_client import AsyncRawDocumentsClient, RawDocumentsClient
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -23,7 +17,22 @@ OMIT = typing.cast(typing.Any, ...)
 
 class DocumentsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = RawDocumentsClient(client_wrapper=client_wrapper)
+
+    @property
+    def _client_wrapper(self) -> SyncClientWrapper:
+        return self._raw_client._client_wrapper
+
+    @property
+    def with_raw_response(self) -> RawDocumentsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawDocumentsClient
+        """
+        return self._raw_client
 
     def list(
         self,
@@ -68,36 +77,20 @@ class DocumentsClient:
         from vellum import Vellum
 
         client = Vellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
         client.documents.list()
         """
-        _response = self._client_wrapper.httpx_client.request(
-            "v1/documents",
-            base_url=self._client_wrapper.get_environment().default,
-            method="GET",
-            params={
-                "document_index_id": document_index_id,
-                "limit": limit,
-                "offset": offset,
-                "ordering": ordering,
-                "search": search,
-            },
+        _response = self._raw_client.list(
+            document_index_id=document_index_id,
+            limit=limit,
+            offset=offset,
+            ordering=ordering,
+            search=search,
             request_options=request_options,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    PaginatedSlimDocumentList,
-                    parse_obj_as(
-                        type_=PaginatedSlimDocumentList,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
     def retrieve(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DocumentRead:
         """
@@ -106,7 +99,6 @@ class DocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -121,31 +113,15 @@ class DocumentsClient:
         from vellum import Vellum
 
         client = Vellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
         client.documents.retrieve(
             id="id",
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"v1/documents/{jsonable_encoder(id)}",
-            base_url=self._client_wrapper.get_environment().default,
-            method="GET",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    DocumentRead,
-                    parse_obj_as(
-                        type_=DocumentRead,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        _response = self._raw_client.retrieve(id, request_options=request_options)
+        return _response.data
 
     def destroy(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
@@ -154,7 +130,6 @@ class DocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -168,25 +143,15 @@ class DocumentsClient:
         from vellum import Vellum
 
         client = Vellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
         client.documents.destroy(
             id="id",
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"v1/documents/{jsonable_encoder(id)}",
-            base_url=self._client_wrapper.get_environment().documents,
-            method="DELETE",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return
-            _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)
+        _response = self._raw_client.destroy(id, request_options=request_options)
+        return _response.data
 
     def partial_update(
         self,
@@ -194,6 +159,7 @@ class DocumentsClient:
         *,
         label: typing.Optional[str] = OMIT,
         status: typing.Optional[DocumentStatus] = OMIT,
+        keywords: typing.Optional[typing.Sequence[str]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentRead:
@@ -203,7 +169,6 @@ class DocumentsClient:
         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.
@@ -213,6 +178,9 @@ class DocumentsClient:
 
             * `ACTIVE` - Active
 
+        keywords : typing.Optional[typing.Sequence[str]]
+            A list of keywords that'll be associated with the document. Used as part of keyword search.
+
         metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             A JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
@@ -229,37 +197,17 @@ class DocumentsClient:
         from vellum import Vellum
 
         client = Vellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
         client.documents.partial_update(
             id="id",
         )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            f"v1/documents/{jsonable_encoder(id)}",
-            base_url=self._client_wrapper.get_environment().default,
-            method="PATCH",
-            json={
-                "label": label,
-                "status": status,
-                "metadata": metadata,
-            },
-            request_options=request_options,
-            omit=OMIT,
+        _response = self._raw_client.partial_update(
+            id, label=label, status=status, keywords=keywords, metadata=metadata, request_options=request_options
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    DocumentRead,
-                    parse_obj_as(
-                        type_=DocumentRead,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
     def upload(
         self,
@@ -304,83 +252,33 @@ class DocumentsClient:
         -------
         UploadDocumentResponse
 
-
-        Examples
-        --------
-        from vellum import Vellum
-
-        client = Vellum(
-            api_key="YOUR_API_KEY",
-        )
-        client.documents.upload(
-            label="label",
-        )
         """
-        _response = self._client_wrapper.httpx_client.request(
-            "v1/upload-document",
-            base_url=self._client_wrapper.get_environment().documents,
-            method="POST",
-            data={
-                "add_to_index_names": add_to_index_names,
-                "external_id": external_id,
-                "label": label,
-                "keywords": keywords,
-                "metadata": metadata,
-            },
-            files={
-                "contents": contents,
-            },
+        _response = self._raw_client.upload(
+            label=label,
+            contents=contents,
+            add_to_index_names=add_to_index_names,
+            external_id=external_id,
+            keywords=keywords,
+            metadata=metadata,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    UploadDocumentResponse,
-                    parse_obj_as(
-                        type_=UploadDocumentResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            if _response.status_code == 500:
-                raise InternalServerError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
 
 class AsyncDocumentsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = AsyncRawDocumentsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawDocumentsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawDocumentsClient
+        """
+        return self._raw_client
 
     async def list(
         self,
@@ -427,6 +325,7 @@ class AsyncDocumentsClient:
         from vellum import AsyncVellum
 
         client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
 
@@ -437,32 +336,15 @@ class AsyncDocumentsClient:
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            "v1/documents",
-            base_url=self._client_wrapper.get_environment().default,
-            method="GET",
-            params={
-                "document_index_id": document_index_id,
-                "limit": limit,
-                "offset": offset,
-                "ordering": ordering,
-                "search": search,
-            },
+        _response = await self._raw_client.list(
+            document_index_id=document_index_id,
+            limit=limit,
+            offset=offset,
+            ordering=ordering,
+            search=search,
             request_options=request_options,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    PaginatedSlimDocumentList,
-                    parse_obj_as(
-                        type_=PaginatedSlimDocumentList,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
     async def retrieve(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DocumentRead:
         """
@@ -471,7 +353,6 @@ class AsyncDocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -488,6 +369,7 @@ class AsyncDocumentsClient:
         from vellum import AsyncVellum
 
         client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
 
@@ -500,25 +382,8 @@ class AsyncDocumentsClient:
 
         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",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    DocumentRead,
-                    parse_obj_as(
-                        type_=DocumentRead,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        _response = await self._raw_client.retrieve(id, request_options=request_options)
+        return _response.data
 
     async def destroy(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
@@ -527,7 +392,6 @@ class AsyncDocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -543,6 +407,7 @@ class AsyncDocumentsClient:
         from vellum import AsyncVellum
 
         client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
 
@@ -555,19 +420,8 @@ class AsyncDocumentsClient:
 
         asyncio.run(main())
         """
-        _response = await self._client_wrapper.httpx_client.request(
-            f"v1/documents/{jsonable_encoder(id)}",
-            base_url=self._client_wrapper.get_environment().documents,
-            method="DELETE",
-            request_options=request_options,
-        )
-        try:
-            if 200 <= _response.status_code < 300:
-                return
-            _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)
+        _response = await self._raw_client.destroy(id, request_options=request_options)
+        return _response.data
 
     async def partial_update(
         self,
@@ -575,6 +429,7 @@ class AsyncDocumentsClient:
         *,
         label: typing.Optional[str] = OMIT,
         status: typing.Optional[DocumentStatus] = OMIT,
+        keywords: typing.Optional[typing.Sequence[str]] = OMIT,
         metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentRead:
@@ -584,7 +439,6 @@ class AsyncDocumentsClient:
         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.
@@ -594,6 +448,9 @@ class AsyncDocumentsClient:
 
             * `ACTIVE` - Active
 
+        keywords : typing.Optional[typing.Sequence[str]]
+            A list of keywords that'll be associated with the document. Used as part of keyword search.
+
         metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
             A JSON object containing any metadata associated with the document that you'd like to filter upon later.
 
@@ -612,6 +469,7 @@ class AsyncDocumentsClient:
         from vellum import AsyncVellum
 
         client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
             api_key="YOUR_API_KEY",
         )
 
@@ -624,31 +482,10 @@ class AsyncDocumentsClient:
 
         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="PATCH",
-            json={
-                "label": label,
-                "status": status,
-                "metadata": metadata,
-            },
-            request_options=request_options,
-            omit=OMIT,
+        _response = await self._raw_client.partial_update(
+            id, label=label, status=status, keywords=keywords, metadata=metadata, request_options=request_options
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    DocumentRead,
-                    parse_obj_as(
-                        type_=DocumentRead,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
     async def upload(
         self,
@@ -693,83 +530,14 @@ class AsyncDocumentsClient:
         -------
         UploadDocumentResponse
 
-
-        Examples
-        --------
-        import asyncio
-
-        from vellum import AsyncVellum
-
-        client = AsyncVellum(
-            api_key="YOUR_API_KEY",
-        )
-
-
-        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",
-            data={
-                "add_to_index_names": add_to_index_names,
-                "external_id": external_id,
-                "label": label,
-                "keywords": keywords,
-                "metadata": metadata,
-            },
-            files={
-                "contents": contents,
-            },
+        _response = await self._raw_client.upload(
+            label=label,
+            contents=contents,
+            add_to_index_names=add_to_index_names,
+            external_id=external_id,
+            keywords=keywords,
+            metadata=metadata,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    UploadDocumentResponse,
-                    parse_obj_as(
-                        type_=UploadDocumentResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            if _response.status_code == 404:
-                raise NotFoundError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            if _response.status_code == 500:
-                raise InternalServerError(
-                    typing.cast(
-                        typing.Optional[typing.Any],
-                        parse_obj_as(
-                            type_=typing.Optional[typing.Any],  # type: ignore
-                            object_=_response.json(),
-                        ),
-                    )
-                )
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data