groundx 2.0.20__py3-none-any.whl → 2.0.21__py3-none-any.whl

groundx/types/__init__.py

@@ -8,9 +8,9 @@ from .bucket_update_detail import BucketUpdateDetail
 from .bucket_update_response import BucketUpdateResponse
 from .customer_detail import CustomerDetail
 from .customer_response import CustomerResponse
-from .document import Document
 from .document_detail import DocumentDetail
 from .document_list_response import DocumentListResponse
+from .document_local_ingest_request import DocumentLocalIngestRequest
 from .document_lookup_response import DocumentLookupResponse
 from .document_response import DocumentResponse
 from .document_type import DocumentType
@@ -22,6 +22,7 @@ from .health_response_health import HealthResponseHealth
 from .health_service import HealthService
 from .health_service_status import HealthServiceStatus
 from .ingest_local_document import IngestLocalDocument
+from .ingest_local_document_metadata import IngestLocalDocumentMetadata
 from .ingest_remote_document import IngestRemoteDocument
 from .ingest_response import IngestResponse
 from .ingest_response_ingest import IngestResponseIngest
@@ -53,9 +54,9 @@ __all__ = [
     "BucketUpdateResponse",
     "CustomerDetail",
     "CustomerResponse",
-    "Document",
     "DocumentDetail",
     "DocumentListResponse",
+    "DocumentLocalIngestRequest",
     "DocumentLookupResponse",
     "DocumentResponse",
     "DocumentType",
@@ -67,6 +68,7 @@ __all__ = [
     "HealthService",
     "HealthServiceStatus",
     "IngestLocalDocument",
+    "IngestLocalDocumentMetadata",
     "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",

groundx/types/document_local_ingest_request.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .ingest_local_document import IngestLocalDocument
+
+DocumentLocalIngestRequest = typing.List[IngestLocalDocument]

groundx/types/ingest_local_document.py

@@ -1,37 +1,19 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
-from ..core.serialization import FieldMetadata
 import pydantic
-from .document_type import DocumentType
-import typing
+from .ingest_local_document_metadata import IngestLocalDocumentMetadata
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
 
 
 class IngestLocalDocument(UniversalBaseModel):
-    bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")] = pydantic.Field()
-    """
-    the bucketId of the bucket which this local file will be ingested to.
-    """
-
-    file_data: typing_extensions.Annotated[str, FieldMetadata(alias="fileData")] = pydantic.Field()
+    blob: str = pydantic.Field()
     """
-    Binary data for the file being ingested.
+    The binary file data being ingested.
     """
 
-    file_name: typing_extensions.Annotated[str, FieldMetadata(alias="fileName")] = pydantic.Field()
-    """
-    The name of the file being ingested
-    """
-
-    file_type: typing_extensions.Annotated[DocumentType, FieldMetadata(alias="fileType")]
-    search_data: typing_extensions.Annotated[
-        typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="searchData")
-    ] = pydantic.Field(default=None)
-    """
-    Custom metadata which can be used to influence GroundX's search functionality. This data can be used to further hone GroundX search.
-    """
+    metadata: IngestLocalDocumentMetadata
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

groundx/types/{document.py → ingest_local_document_metadata.py}

@@ -2,17 +2,19 @@
 
 from ..core.pydantic_utilities import UniversalBaseModel
 import typing_extensions
+import typing
 from ..core.serialization import FieldMetadata
 import pydantic
-import typing
 from .document_type import DocumentType
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Document(UniversalBaseModel):
-    bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")] = pydantic.Field()
+class IngestLocalDocumentMetadata(UniversalBaseModel):
+    bucket_id: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="bucketId")] = pydantic.Field(
+        default=None
+    )
     """
-    the bucketId of the bucket which this remote file will be ingested to.
+    The bucketId of the bucket which this local file will be ingested to.
     """
 
     file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fileName")] = pydantic.Field(
@@ -22,11 +24,6 @@ class Document(UniversalBaseModel):
     The name of the file being ingested
     """
 
-    file_path: typing_extensions.Annotated[str, FieldMetadata(alias="filePath")] = pydantic.Field()
-    """
-    The local file path or remote URL of the document being ingested by GroundX.
-    """
-
     file_type: typing_extensions.Annotated[typing.Optional[DocumentType], FieldMetadata(alias="fileType")] = None
     search_data: typing_extensions.Annotated[
         typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="searchData")

{groundx-2.0.20.dist-info → groundx-2.0.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.0.20
+Version: 2.0.21
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -52,26 +52,19 @@ A full reference for this library is available [here](./reference.md).
 Instantiate and use the client with the following:
 
 ```python
-from groundx import Document, GroundX
+from groundx import GroundX, IngestRemoteDocument
 
 client = GroundX(
     api_key="YOUR_API_KEY",
 )
-client.documents.ingest(
+client.documents.ingest_remote(
     documents=[
-        Document(
+        IngestRemoteDocument(
             bucket_id=1234,
             file_name="my_file1.txt",
-            file_path="https://my.source.url.com/file1.txt",
             file_type="txt",
-            search_data={"key": "value"},
-        ),
-        Document(
-            bucket_id=1234,
-            file_name="my_file2.pdf",
-            file_path="/local/path/file2.pdf",
-            file_type="pdf",
-        ),
+            source_url="https://my.source.url.com/file1.txt",
+        )
     ],
 )
 ```
@@ -83,7 +76,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 ```python
 import asyncio
 
-from groundx import AsyncGroundX, Document
+from groundx import AsyncGroundX, IngestRemoteDocument
 
 client = AsyncGroundX(
     api_key="YOUR_API_KEY",
@@ -91,21 +84,14 @@ client = AsyncGroundX(
 
 
 async def main() -> None:
-    await client.documents.ingest(
+    await client.documents.ingest_remote(
         documents=[
-            Document(
+            IngestRemoteDocument(
                 bucket_id=1234,
                 file_name="my_file1.txt",
-                file_path="https://my.source.url.com/file1.txt",
                 file_type="txt",
-                search_data={"key": "value"},
-            ),
-            Document(
-                bucket_id=1234,
-                file_name="my_file2.pdf",
-                file_path="/local/path/file2.pdf",
-                file_type="pdf",
-            ),
+                source_url="https://my.source.url.com/file1.txt",
+            )
         ],
     )
 
@@ -122,7 +108,7 @@ will be thrown.
 from groundx.core.api_error import ApiError
 
 try:
-    client.documents.ingest(...)
+    client.documents.ingest_remote(...)
 except ApiError as e:
     print(e.status_code)
     print(e.body)
@@ -145,7 +131,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `max_retries` request option to configure this behavior.
 
 ```python
-client.documents.ingest(..., request_options={
+client.documents.ingest_remote(..., request_options={
     "max_retries": 1
 })
 ```
@@ -165,7 +151,7 @@ client = GroundX(
 
 
 # Override timeout for a specific method
-client.documents.ingest(..., request_options={
+client.documents.ingest_remote(..., request_options={
     "timeout_in_seconds": 1
 })
 ```

{groundx-2.0.20.dist-info → groundx-2.0.21.dist-info}/RECORD

@@ -1,10 +1,10 @@
-groundx/__init__.py,sha256=2Y4vdNS7OptGTx8PNJ_qeKmTNn8CLwFTPLyGJ-pcMfI,2871
+groundx/__init__.py,sha256=_IGBowwyPGd2Yc8c-X8b4FRu5rNA_SoTj4e3bhtB69Y,2975
 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=T6AlQ_t_YWnf52XrIQ5Tmv36AxaJQ0LuLIXcq7IZSno,1803
+groundx/core/client_wrapper.py,sha256=ZCThAGYPgh2zcfTO99ZP-m7Fdgqktuyv7kfz-Y1Q6FY,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
@@ -17,7 +17,7 @@ groundx/core/serialization.py,sha256=D9h_t-RQON3-CHWs1C4ESY9B-Yd5d-l5lnTLb_X896g
 groundx/customer/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 groundx/customer/client.py,sha256=C_JANeDewRD1Kg-q7LPxdiOSWbYSTOiYlBYZLRYPI44,3467
 groundx/documents/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-groundx/documents/client.py,sha256=XWAATHLbU3FV3L7YEQ5ftQu_fn-iILJzXdQogrvgMh8,64975
+groundx/documents/client.py,sha256=94t45T3Z9RHj4OBh454qYbjke8HdW1ad_-TPiocPmeE,58853
 groundx/environment.py,sha256=CInm1_DKtZ1mrxutmKb1qqv82P33r_S87hZD3Hc1VB0,159
 groundx/errors/__init__.py,sha256=-prNYsFd8xxM4va0vR1raZjcd10tllOJKyEWjX_pwdU,214
 groundx/errors/bad_request_error.py,sha256=_EbO8mWqN9kFZPvIap8qa1lL_EWkRcsZe1HKV9GDWJY,264
@@ -31,7 +31,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=xKjmTkCby1yXYF0Nk4XR-NMBKMrh3ayvlNmeTWiB6o8,3598
+groundx/types/__init__.py,sha256=ViqDRA9l-OWZP4_Zl7nVOvd_EZKpTFFvyYkxdHB9vco,3762
 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
@@ -40,9 +40,9 @@ groundx/types/bucket_update_detail.py,sha256=B4atQMDSXEdx7otcDbvgsrAHtXNz9swMnOs
 groundx/types/bucket_update_response.py,sha256=h5RJTEpc4WPI_C4sPvsJZo7IxKppnPR-I9VGEQryRlc,633
 groundx/types/customer_detail.py,sha256=RNm0qXvKx6YvVmkVJZeCNIz7n8_siFMXJ_AGtH3i5Z0,1094
 groundx/types/customer_response.py,sha256=_RbuanXhCWQkCeQ0dkwPgsjNBoBgNpixiNfRpXcMew8,618
-groundx/types/document.py,sha256=NxhkpwlW9jskS6RyhLNPrgrgZBAj4Ag8wGAa7jThuMw,1695
 groundx/types/document_detail.py,sha256=i1UfcQAGYo9v1HwrrpzQPw_O0qA7IOXwOUuPV1yU8nI,2323
 groundx/types/document_list_response.py,sha256=Z0Hm5VBwI0qatbSp6nYHh0RrGwJN3Gqh2D72FfDseZk,839
+groundx/types/document_local_ingest_request.py,sha256=zqaT_QgYcEc8AfVwZm-O5jLTEiYSsO-i3VVgZ_7xl7w,197
 groundx/types/document_lookup_response.py,sha256=hZBwUO2pI6xFfeh7DmX_l1xRoh-5oaVNgUVxd00ml14,1097
 groundx/types/document_response.py,sha256=EBDrYhTYoA3Q3ZpqwFEYmTgE3tY86TScFPhBnc3_ItI,642
 groundx/types/document_type.py,sha256=NgsbSUXopTkzkut1AwXgthxWjsFzlKNnUhyfYqU_IM4,216
@@ -53,7 +53,8 @@ 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_local_document.py,sha256=2T1HXR2a-BDj5LEOTM98Sl4sgjVMWbVShQLn8MTR6QA,1602
+groundx/types/ingest_local_document.py,sha256=am6TPgHu40S4Lzo9hMkDRauYnc-AWBuYL0Lgk85Fseg,753
+groundx/types/ingest_local_document_metadata.py,sha256=I4CSafx8kLSHLbU5_TkU6igy2plevkzUzdsR7vhovHg,1558
 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
@@ -76,7 +77,7 @@ groundx/types/subscription_detail.py,sha256=WNfUw2EMVECIvNYcV2s51zZ6T3Utc4zYXw63
 groundx/types/subscription_detail_meters.py,sha256=lBa8-1QlMVHjr5RLGqhiTKnD1KMM0AAHTWvz9TVtG8w,830
 groundx/types/website_source.py,sha256=0TYZqyR16bUO9dfVrNwmph-ICmRzgje02aim1M17x7k,1576
 groundx/version.py,sha256=1yVogKaq260fQfckM2RYN2144SEw0QROsZW8ICtkG4U,74
-groundx-2.0.20.dist-info/LICENSE,sha256=8dMPYAFBTA7O4DUxhrEKEks8CL2waCMYM6dHohW4xrI,1065
-groundx-2.0.20.dist-info/METADATA,sha256=5w2zG2q5tkHlBjww5M4H1b7gvC8z-QCes56_-Z3MKfM,5493
-groundx-2.0.20.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-groundx-2.0.20.dist-info/RECORD,,
+groundx-2.0.21.dist-info/LICENSE,sha256=8dMPYAFBTA7O4DUxhrEKEks8CL2waCMYM6dHohW4xrI,1065
+groundx-2.0.21.dist-info/METADATA,sha256=4SvJFYtth9J6AYAv5SuzIsB-KGtAaLYVGiqCv_CZD90,5122
+groundx-2.0.21.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+groundx-2.0.21.dist-info/RECORD,,