groundx 2.0.13__py3-none-any.whl → 2.0.15__py3-none-any.whl

groundx/__init__.py

@@ -21,6 +21,7 @@ from .types import (
     HealthResponseHealth,
     HealthService,
     HealthServiceStatus,
+    IngestRemoteDocument,
     IngestResponse,
     IngestResponseIngest,
     MessageResponse,
@@ -44,11 +45,7 @@ from .types import (
 from .errors import BadRequestError, UnauthorizedError
 from . import buckets, customer, documents, groups, health, search
 from .client import AsyncGroundX, GroundX
-from .documents import (
-    DocumentRemoteIngestRequestDocumentsItem,
-    DocumentsIngestLocalRequestFilesItem,
-    WebsiteCrawlRequestWebsitesItem,
-)
+from .documents import DocumentsIngestLocalRequestFilesItem, WebsiteCrawlRequestWebsitesItem
 from .environment import GroundXEnvironment
 from .search import SearchContentRequestId
 from .version import __version__
@@ -67,7 +64,6 @@ __all__ = [
     "DocumentDetail",
     "DocumentListResponse",
     "DocumentLookupResponse",
-    "DocumentRemoteIngestRequestDocumentsItem",
     "DocumentResponse",
     "DocumentType",
     "DocumentsIngestLocalRequestFilesItem",
@@ -80,6 +76,7 @@ __all__ = [
     "HealthResponseHealth",
     "HealthService",
     "HealthServiceStatus",
+    "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",
     "MessageResponse",

groundx/core/client_wrapper.py

@@ -16,7 +16,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.0.13",
+            "X-Fern-SDK-Version": "2.0.15",
         }
         headers["X-API-Key"] = self.api_key
         return headers

groundx/documents/__init__.py

@@ -1,13 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import (
-    DocumentRemoteIngestRequestDocumentsItem,
-    DocumentsIngestLocalRequestFilesItem,
-    WebsiteCrawlRequestWebsitesItem,
-)
+from .types import DocumentsIngestLocalRequestFilesItem, WebsiteCrawlRequestWebsitesItem
 
-__all__ = [
-    "DocumentRemoteIngestRequestDocumentsItem",
-    "DocumentsIngestLocalRequestFilesItem",
-    "WebsiteCrawlRequestWebsitesItem",
-]
+__all__ = ["DocumentsIngestLocalRequestFilesItem", "WebsiteCrawlRequestWebsitesItem"]

groundx/documents/client.py

@@ -2,7 +2,7 @@
 
 import typing
 from ..core.client_wrapper import SyncClientWrapper
-from .types.document_remote_ingest_request_documents_item import DocumentRemoteIngestRequestDocumentsItem
+from ..types.ingest_remote_document import IngestRemoteDocument
 from ..core.request_options import RequestOptions
 from ..types.ingest_response import IngestResponse
 from ..core.serialization import convert_and_respect_annotation_metadata
@@ -34,7 +34,7 @@ class DocumentsClient:
     def ingest_remote(
         self,
         *,
-        documents: typing.Sequence[DocumentRemoteIngestRequestDocumentsItem],
+        documents: typing.Sequence[IngestRemoteDocument],
         request_options: typing.Optional[RequestOptions] = None,
     ) -> IngestResponse:
         """
@@ -44,7 +44,7 @@ class DocumentsClient:
 
         Parameters
         ----------
-        documents : typing.Sequence[DocumentRemoteIngestRequestDocumentsItem]
+        documents : typing.Sequence[IngestRemoteDocument]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -56,16 +56,18 @@ class DocumentsClient:
 
         Examples
         --------
-        from groundx import GroundX
-        from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+        from groundx import GroundX, IngestRemoteDocument
 
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
         client.documents.ingest_remote(
             documents=[
-                DocumentRemoteIngestRequestDocumentsItem(
+                IngestRemoteDocument(
                     bucket_id=1234,
+                    file_name="my_file.txt",
+                    file_type="txt",
+                    search_data={"key": "value"},
                     source_url="https://my.source.url.com/file.txt",
                 )
             ],
@@ -76,9 +78,7 @@ class DocumentsClient:
             method="POST",
             json={
                 "documents": convert_and_respect_annotation_metadata(
-                    object_=documents,
-                    annotation=typing.Sequence[DocumentRemoteIngestRequestDocumentsItem],
-                    direction="write",
+                    object_=documents, annotation=typing.Sequence[IngestRemoteDocument], direction="write"
                 ),
             },
             headers={
@@ -775,7 +775,7 @@ class AsyncDocumentsClient:
     async def ingest_remote(
         self,
         *,
-        documents: typing.Sequence[DocumentRemoteIngestRequestDocumentsItem],
+        documents: typing.Sequence[IngestRemoteDocument],
         request_options: typing.Optional[RequestOptions] = None,
     ) -> IngestResponse:
         """
@@ -785,7 +785,7 @@ class AsyncDocumentsClient:
 
         Parameters
         ----------
-        documents : typing.Sequence[DocumentRemoteIngestRequestDocumentsItem]
+        documents : typing.Sequence[IngestRemoteDocument]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -799,8 +799,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from groundx import AsyncGroundX
-        from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+        from groundx import AsyncGroundX, IngestRemoteDocument
 
         client = AsyncGroundX(
             api_key="YOUR_API_KEY",
@@ -810,8 +809,11 @@ class AsyncDocumentsClient:
         async def main() -> None:
             await client.documents.ingest_remote(
                 documents=[
-                    DocumentRemoteIngestRequestDocumentsItem(
+                    IngestRemoteDocument(
                         bucket_id=1234,
+                        file_name="my_file.txt",
+                        file_type="txt",
+                        search_data={"key": "value"},
                         source_url="https://my.source.url.com/file.txt",
                     )
                 ],
@@ -825,9 +827,7 @@ class AsyncDocumentsClient:
             method="POST",
             json={
                 "documents": convert_and_respect_annotation_metadata(
-                    object_=documents,
-                    annotation=typing.Sequence[DocumentRemoteIngestRequestDocumentsItem],
-                    direction="write",
+                    object_=documents, annotation=typing.Sequence[IngestRemoteDocument], direction="write"
                 ),
             },
             headers={

groundx/documents/types/__init__.py

@@ -1,11 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .document_remote_ingest_request_documents_item import DocumentRemoteIngestRequestDocumentsItem
 from .documents_ingest_local_request_files_item import DocumentsIngestLocalRequestFilesItem
 from .website_crawl_request_websites_item import WebsiteCrawlRequestWebsitesItem
 
-__all__ = [
-    "DocumentRemoteIngestRequestDocumentsItem",
-    "DocumentsIngestLocalRequestFilesItem",
-    "WebsiteCrawlRequestWebsitesItem",
-]
+__all__ = ["DocumentsIngestLocalRequestFilesItem", "WebsiteCrawlRequestWebsitesItem"]

groundx/documents/types/documents_ingest_local_request_files_item.py

@@ -17,7 +17,7 @@ class DocumentsIngestLocalRequestFilesItem(UniversalBaseModel):
 
     file_data: typing_extensions.Annotated[str, FieldMetadata(alias="fileData")] = pydantic.Field()
     """
-    The actual file being ingested.
+    Binary data for the file being ingested.
     """
 
     file_name: typing_extensions.Annotated[str, FieldMetadata(alias="fileName")] = pydantic.Field()

groundx/types/__init__.py

@@ -20,6 +20,7 @@ from .health_response import HealthResponse
 from .health_response_health import HealthResponseHealth
 from .health_service import HealthService
 from .health_service_status import HealthServiceStatus
+from .ingest_remote_document import IngestRemoteDocument
 from .ingest_response import IngestResponse
 from .ingest_response_ingest import IngestResponseIngest
 from .message_response import MessageResponse
@@ -61,6 +62,7 @@ __all__ = [
     "HealthResponseHealth",
     "HealthService",
     "HealthServiceStatus",
+    "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",
     "MessageResponse",

groundx/{documents/types/document_remote_ingest_request_documents_item.py → types/ingest_remote_document.py}

@@ -1,15 +1,15 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
+from ..core.pydantic_utilities import UniversalBaseModel
 import typing_extensions
-from ...core.serialization import FieldMetadata
+from ..core.serialization import FieldMetadata
 import pydantic
 import typing
-from ...types.document_type import DocumentType
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from .document_type import DocumentType
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class DocumentRemoteIngestRequestDocumentsItem(UniversalBaseModel):
+class IngestRemoteDocument(UniversalBaseModel):
     bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")] = pydantic.Field()
     """
     the bucketId of the bucket which this remote file will be ingested to.

{groundx-2.0.13.dist-info → groundx-2.0.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.0.13
+Version: 2.0.15
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -52,16 +52,18 @@ A full reference for this library is available [here](./reference.md).
 Instantiate and use the client with the following:
 
 ```python
-from groundx import GroundX
-from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+from groundx import GroundX, IngestRemoteDocument
 
 client = GroundX(
     api_key="YOUR_API_KEY",
 )
 client.documents.ingest_remote(
     documents=[
-        DocumentRemoteIngestRequestDocumentsItem(
+        IngestRemoteDocument(
             bucket_id=1234,
+            file_name="my_file.txt",
+            file_type="txt",
+            search_data={"key": "value"},
             source_url="https://my.source.url.com/file.txt",
         )
     ],
@@ -75,8 +77,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 ```python
 import asyncio
 
-from groundx import AsyncGroundX
-from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+from groundx import AsyncGroundX, IngestRemoteDocument
 
 client = AsyncGroundX(
     api_key="YOUR_API_KEY",
@@ -86,8 +87,11 @@ client = AsyncGroundX(
 async def main() -> None:
     await client.documents.ingest_remote(
         documents=[
-            DocumentRemoteIngestRequestDocumentsItem(
+            IngestRemoteDocument(
                 bucket_id=1234,
+                file_name="my_file.txt",
+                file_type="txt",
+                search_data={"key": "value"},
                 source_url="https://my.source.url.com/file.txt",
             )
         ],

{groundx-2.0.13.dist-info → groundx-2.0.15.dist-info}/RECORD

@@ -1,10 +1,10 @@
-groundx/__init__.py,sha256=LoqXol72hAjLcTlZd2VfzvZJ_BVWAUPHqub4fwkY0pE,2978
+groundx/__init__.py,sha256=k3hsC7MSufSELpIPOb1-G3Y_-YM2GV61ADC-EwSaPvw,2925
 groundx/buckets/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 groundx/buckets/client.py,sha256=TofNrkej1AC_-FU5rf_y8KG8ubFUpHtLa8PQ7rqax6E,26537
 groundx/client.py,sha256=Q1Kw0z6K-z-ShhNyuuPe5fYonM9M2I_55-ukUrUWk1U,6507
 groundx/core/__init__.py,sha256=SQ85PF84B9MuKnBwHNHWemSGuy-g_515gFYNFhvEE0I,1438
 groundx/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-groundx/core/client_wrapper.py,sha256=i0qvc0BaD5Rv4EK4VI6BX08eaNMa4_xNY8TJAVTiovA,1803
+groundx/core/client_wrapper.py,sha256=66tcEWEACDxQIXDiX5s5Kn5XdmYZETM2b8YUiM7Spgs,1803
 groundx/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 groundx/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
 groundx/core/http_client.py,sha256=siUQ6UV0ARZALlxubqWSSAAPC9B4VW8y6MGlHStfaeo,19552
@@ -16,11 +16,10 @@ groundx/core/request_options.py,sha256=h0QUNCFVdCW_7GclVySCAY2w4NhtXVBUCmHgmzaxp
 groundx/core/serialization.py,sha256=D9h_t-RQON3-CHWs1C4ESY9B-Yd5d-l5lnTLb_X896g,9601
 groundx/customer/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 groundx/customer/client.py,sha256=C_JANeDewRD1Kg-q7LPxdiOSWbYSTOiYlBYZLRYPI44,3467
-groundx/documents/__init__.py,sha256=H7q_UJJyRsjDdapoH7WeMtB89eUL6G3Pq3UQLCbvqgc,359
-groundx/documents/client.py,sha256=6XLEcOUMxN5ZByBic_oBU_IpR-OPod_dsy9LjvLT4H4,59057
-groundx/documents/types/__init__.py,sha256=2hClhaZpkoWywGLA1VeO9Ht81soK1x3bdFg74jQFZfo,484
-groundx/documents/types/document_remote_ingest_request_documents_item.py,sha256=IjZu1L3MGUxW2qydZlns5_DsMgOLNyAWDvKpy9VL6iE,1714
-groundx/documents/types/documents_ingest_local_request_files_item.py,sha256=036fSQOj8DMPCMFVQSXqZwuS25IjW3lVnR8JAez9Bao,1621
+groundx/documents/__init__.py,sha256=-Z5Vjus4Uq29lfATYXWLh5zC9DvDMu-FLGWcm8chMdY,241
+groundx/documents/client.py,sha256=Ah3LPoJmo7H1vNb2b2xfQ6zRVmnrihdYJBhcriEgcEw,58935
+groundx/documents/types/__init__.py,sha256=fmIT0AisC1K0-EQIa1GDcYr70wpsi7QuXBeyqWiZD14,325
+groundx/documents/types/documents_ingest_local_request_files_item.py,sha256=EpD7TE1us1DAXdcPvI1li-AGUNpEy_f13bBXidmCAL8,1630
 groundx/documents/types/website_crawl_request_websites_item.py,sha256=6So4stWecfZYPbiQWg6-FgsfIqV4g2ujFXXgn70evNI,1597
 groundx/environment.py,sha256=CInm1_DKtZ1mrxutmKb1qqv82P33r_S87hZD3Hc1VB0,159
 groundx/errors/__init__.py,sha256=-prNYsFd8xxM4va0vR1raZjcd10tllOJKyEWjX_pwdU,214
@@ -35,7 +34,7 @@ groundx/search/__init__.py,sha256=RagVzjShP33mDg9o4N3kGzV0egL1RYNjCpXPE8VzMYE,14
 groundx/search/client.py,sha256=10ifg9GyIwIZF13ULfCXF8iFIydq6H6QRDrGPDjpanw,19756
 groundx/search/types/__init__.py,sha256=fNFXQloPa1PHHO8VZim6KQNMA9N5EZtfSkissdxtY_c,165
 groundx/search/types/search_content_request_id.py,sha256=us7mYdzR0qPur_wR5I9BhHaLEzC5nLBRna6-xq4M1ec,128
-groundx/types/__init__.py,sha256=2GTGHb5P0h2dTD-FzF-G6ViIhdICL2DMgTBhB9WNH8g,3321
+groundx/types/__init__.py,sha256=W5fN6ryfqki0p_bipBi7jKs6SXH2vVsrOe5ORcbngVY,3406
 groundx/types/bounding_box_detail.py,sha256=51qcen326NTHY2ZqH1cFXut0_MCmk39EbLoDAwotdq4,1832
 groundx/types/bucket_detail.py,sha256=bQjCvfyWydjItmzNNTvH-iWxNDOggd7R7X1alFZzlEY,1511
 groundx/types/bucket_list_response.py,sha256=jC0NBsLCYDSwQrBzuW0g3PWFycjtKl8YRkKhic_-1DA,650
@@ -56,6 +55,7 @@ groundx/types/health_response.py,sha256=3UpYL2IZb56tTo-fOpSU-0OTRyWgpYiB3pMU3sfj
 groundx/types/health_response_health.py,sha256=I0QeEljFp6l5LCJbCTArW031Om84egePgnGdtE6WXlI,632
 groundx/types/health_service.py,sha256=M1-h1EJSpAXw-j3pY-09_g_WKkO0spdj8e7pgPzSGf0,1083
 groundx/types/health_service_status.py,sha256=ugKJXlx8QGi83n_J6s1frFrW1hYfOn3Dlb_pPNexwMA,185
+groundx/types/ingest_remote_document.py,sha256=xlPA4SYoUgoGXpxZhyORdezxIPGmr4wneav2ZEVmmOY,1683
 groundx/types/ingest_response.py,sha256=139rn8wpT44jlUzYXiy0r8XzN2U_OtdLltpSbRU0TyA,633
 groundx/types/ingest_response_ingest.py,sha256=8FKApYNvS6KFxEKm05pKpKJ0BAagxoE0cWeTt-qjm1g,781
 groundx/types/message_response.py,sha256=g_FJJyXYg_3fjZQueXkcy11q-qUfZGdVdALddHBieh4,585
@@ -76,7 +76,7 @@ groundx/types/sort_order.py,sha256=hfJkStz6zHf3iWQFaVLkNCZPdyj5JS7TsQlN4Ij8Q5A,1
 groundx/types/subscription_detail.py,sha256=WNfUw2EMVECIvNYcV2s51zZ6T3Utc4zYXw63bPaeM6U,768
 groundx/types/subscription_detail_meters.py,sha256=lBa8-1QlMVHjr5RLGqhiTKnD1KMM0AAHTWvz9TVtG8w,830
 groundx/version.py,sha256=1yVogKaq260fQfckM2RYN2144SEw0QROsZW8ICtkG4U,74
-groundx-2.0.13.dist-info/LICENSE,sha256=8dMPYAFBTA7O4DUxhrEKEks8CL2waCMYM6dHohW4xrI,1065
-groundx-2.0.13.dist-info/METADATA,sha256=JwUuwvHoY3noQ3J-KT-r3Vq2CYspM6KlfhkdENZgEHg,5116
-groundx-2.0.13.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-groundx-2.0.13.dist-info/RECORD,,
+groundx-2.0.15.dist-info/LICENSE,sha256=8dMPYAFBTA7O4DUxhrEKEks8CL2waCMYM6dHohW4xrI,1065
+groundx-2.0.15.dist-info/METADATA,sha256=7SUu2d02VHGaZCu06RSUl3dlZJ4Kuh-1Z3VBea6QNrg,5206
+groundx-2.0.15.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+groundx-2.0.15.dist-info/RECORD,,