vellum-ai 0.7.11__py3-none-any.whl → 0.8.5__py3-none-any.whl

vellum/resources/documents/client.py

@@ -1,21 +1,21 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ...core.client_wrapper import 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 ... import core
 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.request_options import RequestOptions
-from ...errors.bad_request_error import BadRequestError
-from ...errors.internal_server_error import InternalServerError
-from ...errors.not_found_error import NotFoundError
 from ...types.document_read import DocumentRead
+from ...core.jsonable_encoder import jsonable_encoder
 from ...types.document_status import DocumentStatus
-from ...types.paginated_slim_document_list import PaginatedSlimDocumentList
+from ... import core
 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
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -61,7 +61,7 @@ class DocumentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -72,12 +72,23 @@ class DocumentsClient:
             "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},
+            params={
+                "document_index_id": document_index_id,
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PaginatedSlimDocumentList, _response.json())  # type: ignore
+                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)
@@ -102,7 +113,7 @@ class DocumentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -119,7 +130,13 @@ class DocumentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
+                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)
@@ -143,7 +160,7 @@ class DocumentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -172,7 +189,7 @@ class DocumentsClient:
         *,
         label: typing.Optional[str] = OMIT,
         status: typing.Optional[DocumentStatus] = OMIT,
-        metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentRead:
         """
@@ -191,7 +208,7 @@ class DocumentsClient:
 
             * `ACTIVE` - Active
 
-        metadata : typing.Optional[typing.Dict[str, typing.Any]]
+        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.
 
         request_options : typing.Optional[RequestOptions]
@@ -204,7 +221,7 @@ class DocumentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -217,13 +234,23 @@ class DocumentsClient:
             f"v1/documents/{jsonable_encoder(id)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            json={"label": label, "status": status, "metadata": metadata},
+            json={
+                "label": label,
+                "status": status,
+                "metadata": metadata,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
+                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)
@@ -283,7 +310,7 @@ class DocumentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -303,19 +330,51 @@ class DocumentsClient:
                 "keywords": keywords,
                 "metadata": metadata,
             },
-            files={"contents": contents},
+            files={
+                "contents": contents,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(UploadDocumentResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    UploadDocumentResponse,
+                    parse_obj_as(
+                        type_=UploadDocumentResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             if _response.status_code == 400:
-                raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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)
@@ -364,7 +423,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -381,12 +440,23 @@ class AsyncDocumentsClient:
             "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},
+            params={
+                "document_index_id": document_index_id,
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PaginatedSlimDocumentList, _response.json())  # type: ignore
+                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)
@@ -413,7 +483,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -436,7 +506,13 @@ class AsyncDocumentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
+                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)
@@ -462,7 +538,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -497,7 +573,7 @@ class AsyncDocumentsClient:
         *,
         label: typing.Optional[str] = OMIT,
         status: typing.Optional[DocumentStatus] = OMIT,
-        metadata: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> DocumentRead:
         """
@@ -516,7 +592,7 @@ class AsyncDocumentsClient:
 
             * `ACTIVE` - Active
 
-        metadata : typing.Optional[typing.Dict[str, typing.Any]]
+        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.
 
         request_options : typing.Optional[RequestOptions]
@@ -531,7 +607,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -550,13 +626,23 @@ class AsyncDocumentsClient:
             f"v1/documents/{jsonable_encoder(id)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            json={"label": label, "status": status, "metadata": metadata},
+            json={
+                "label": label,
+                "status": status,
+                "metadata": metadata,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DocumentRead, _response.json())  # type: ignore
+                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)
@@ -618,7 +704,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -644,19 +730,51 @@ class AsyncDocumentsClient:
                 "keywords": keywords,
                 "metadata": metadata,
             },
-            files={"contents": contents},
+            files={
+                "contents": contents,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(UploadDocumentResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    UploadDocumentResponse,
+                    parse_obj_as(
+                        type_=UploadDocumentResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             if _response.status_code == 400:
-                raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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)

vellum/resources/folder_entities/client.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ...core.client_wrapper import SyncClientWrapper
+from ...core.request_options import RequestOptions
+from ...core.jsonable_encoder import jsonable_encoder
 from json.decoder import JSONDecodeError
-
 from ...core.api_error import ApiError
-from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ...core.jsonable_encoder import jsonable_encoder
-from ...core.request_options import RequestOptions
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -41,7 +41,7 @@ class FolderEntitiesClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -55,7 +55,9 @@ class FolderEntitiesClient:
             f"v1/folders/{jsonable_encoder(folder_id)}/add-entity",
             base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            json={"entity_id": entity_id},
+            json={
+                "entity_id": entity_id,
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -99,7 +101,7 @@ class AsyncFolderEntitiesClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -119,7 +121,9 @@ class AsyncFolderEntitiesClient:
             f"v1/folders/{jsonable_encoder(folder_id)}/add-entity",
             base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            json={"entity_id": entity_id},
+            json={
+                "entity_id": entity_id,
+            },
             request_options=request_options,
             omit=OMIT,
         )