groundx 2.0.12__py3-none-any.whl → 2.0.14__py3-none-any.whl

groundx/__init__.py

@@ -44,7 +44,11 @@ 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, WebsiteCrawlRequestWebsitesItem
+from .documents import (
+    DocumentRemoteIngestRequestDocumentsItem,
+    DocumentsIngestLocalRequestFilesItem,
+    WebsiteCrawlRequestWebsitesItem,
+)
 from .environment import GroundXEnvironment
 from .search import SearchContentRequestId
 from .version import __version__
@@ -66,6 +70,7 @@ __all__ = [
     "DocumentRemoteIngestRequestDocumentsItem",
     "DocumentResponse",
     "DocumentType",
+    "DocumentsIngestLocalRequestFilesItem",
     "GroundX",
     "GroundXEnvironment",
     "GroupDetail",

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.12",
+            "X-Fern-SDK-Version": "2.0.14",
         }
         headers["X-API-Key"] = self.api_key
         return headers

groundx/documents/__init__.py

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

groundx/documents/client.py

@@ -11,6 +11,7 @@ from ..errors.bad_request_error import BadRequestError
 from ..errors.unauthorized_error import UnauthorizedError
 from json.decoder import JSONDecodeError
 from ..core.api_error import ApiError
+from .types.documents_ingest_local_request_files_item import DocumentsIngestLocalRequestFilesItem
 from .types.website_crawl_request_websites_item import WebsiteCrawlRequestWebsitesItem
 from ..types.process_status_response import ProcessStatusResponse
 from ..core.jsonable_encoder import jsonable_encoder
@@ -65,6 +66,9 @@ class DocumentsClient:
             documents=[
                 DocumentRemoteIngestRequestDocumentsItem(
                     bucket_id=1234,
+                    file_name="my_file.txt",
+                    file_type="txt",
+                    search_data={"key": "value"},
                     source_url="https://my.source.url.com/file.txt",
                 )
             ],
@@ -120,7 +124,12 @@ class DocumentsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def ingest_local(self, *, request_options: typing.Optional[RequestOptions] = None) -> IngestResponse:
+    def ingest_local(
+        self,
+        *,
+        files: typing.List[DocumentsIngestLocalRequestFilesItem],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> IngestResponse:
         """
         Upload documents hosted on a local file system for ingestion into a GroundX bucket.
 
@@ -128,6 +137,8 @@ class DocumentsClient:
 
         Parameters
         ----------
+        files : typing.List[DocumentsIngestLocalRequestFilesItem]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -139,16 +150,28 @@ class DocumentsClient:
         Examples
         --------
         from groundx import GroundX
+        from groundx.documents import DocumentsIngestLocalRequestFilesItem
 
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.documents.ingest_local()
+        client.documents.ingest_local(
+            files=[
+                DocumentsIngestLocalRequestFilesItem(
+                    bucket_id=1,
+                    file_data="fileData",
+                    file_name="fileName",
+                    file_type="txt",
+                )
+            ],
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "v1/ingest/documents/local",
             method="POST",
-            data={},
+            data={
+                "files": files,
+            },
             files={},
             request_options=request_options,
             omit=OMIT,
@@ -792,6 +815,9 @@ class AsyncDocumentsClient:
                 documents=[
                     DocumentRemoteIngestRequestDocumentsItem(
                         bucket_id=1234,
+                        file_name="my_file.txt",
+                        file_type="txt",
+                        search_data={"key": "value"},
                         source_url="https://my.source.url.com/file.txt",
                     )
                 ],
@@ -850,7 +876,12 @@ class AsyncDocumentsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def ingest_local(self, *, request_options: typing.Optional[RequestOptions] = None) -> IngestResponse:
+    async def ingest_local(
+        self,
+        *,
+        files: typing.List[DocumentsIngestLocalRequestFilesItem],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> IngestResponse:
         """
         Upload documents hosted on a local file system for ingestion into a GroundX bucket.
 
@@ -858,6 +889,8 @@ class AsyncDocumentsClient:
 
         Parameters
         ----------
+        files : typing.List[DocumentsIngestLocalRequestFilesItem]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -871,6 +904,7 @@ class AsyncDocumentsClient:
         import asyncio
 
         from groundx import AsyncGroundX
+        from groundx.documents import DocumentsIngestLocalRequestFilesItem
 
         client = AsyncGroundX(
             api_key="YOUR_API_KEY",
@@ -878,7 +912,16 @@ class AsyncDocumentsClient:
 
 
         async def main() -> None:
-            await client.documents.ingest_local()
+            await client.documents.ingest_local(
+                files=[
+                    DocumentsIngestLocalRequestFilesItem(
+                        bucket_id=1,
+                        file_data="fileData",
+                        file_name="fileName",
+                        file_type="txt",
+                    )
+                ],
+            )
 
 
         asyncio.run(main())
@@ -886,7 +929,9 @@ class AsyncDocumentsClient:
         _response = await self._client_wrapper.httpx_client.request(
             "v1/ingest/documents/local",
             method="POST",
-            data={},
+            data={
+                "files": files,
+            },
             files={},
             request_options=request_options,
             omit=OMIT,

groundx/documents/types/__init__.py

@@ -1,6 +1,11 @@
 # 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", "WebsiteCrawlRequestWebsitesItem"]
+__all__ = [
+    "DocumentRemoteIngestRequestDocumentsItem",
+    "DocumentsIngestLocalRequestFilesItem",
+    "WebsiteCrawlRequestWebsitesItem",
+]

groundx/documents/types/documents_ingest_local_request_files_item.py

@@ -0,0 +1,43 @@
+# 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 ...types.document_type import DocumentType
+import typing
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class DocumentsIngestLocalRequestFilesItem(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()
+    """
+    Binary data for the file 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.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

{groundx-2.0.12.dist-info → groundx-2.0.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.0.12
+Version: 2.0.14
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -62,6 +62,9 @@ client.documents.ingest_remote(
     documents=[
         DocumentRemoteIngestRequestDocumentsItem(
             bucket_id=1234,
+            file_name="my_file.txt",
+            file_type="txt",
+            search_data={"key": "value"},
             source_url="https://my.source.url.com/file.txt",
         )
     ],
@@ -88,6 +91,9 @@ async def main() -> None:
         documents=[
             DocumentRemoteIngestRequestDocumentsItem(
                 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.12.dist-info → groundx-2.0.14.dist-info}/RECORD

@@ -1,10 +1,10 @@
-groundx/__init__.py,sha256=RFV2n0_4MD5vG1VNsUGoDaZrF7b4SDG5k_jrp000BwE,2879
+groundx/__init__.py,sha256=LoqXol72hAjLcTlZd2VfzvZJ_BVWAUPHqub4fwkY0pE,2978
 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=noNxzRVz03rrlI9qNAsNjKF3LSeJjyt2a-v-MDSIbXY,1803
+groundx/core/client_wrapper.py,sha256=tGKKsvVuRWrBfZBKCMnZ8-HLxQceh8itn0sJcf9G4Y8,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,10 +16,11 @@ 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=PErZSfUvOyPkEahdMLXRVhGRyynH7vRzSb9P4lM3i28,249
-groundx/documents/client.py,sha256=hBVLfMbPqIdKo1picLIR3EWCfUFh65TXeLC7wRNW4QU,57815
-groundx/documents/types/__init__.py,sha256=KYBZuTtGW9281sSUh2ooszTt4wonIHQUEHyWAJp5IaI,337
+groundx/documents/__init__.py,sha256=H7q_UJJyRsjDdapoH7WeMtB89eUL6G3Pq3UQLCbvqgc,359
+groundx/documents/client.py,sha256=eNQxQQAof1eYv2qQ0uY0B81LdF9U1zJdLm2jtlZppwY,59333
+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=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
@@ -75,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.12.dist-info/LICENSE,sha256=8dMPYAFBTA7O4DUxhrEKEks8CL2waCMYM6dHohW4xrI,1065
-groundx-2.0.12.dist-info/METADATA,sha256=emaSDR_C5OWRYFnUlYZpdCM72gOjPAH66cjZJt3sS1o,5116
-groundx-2.0.12.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-groundx-2.0.12.dist-info/RECORD,,
+groundx-2.0.14.dist-info/LICENSE,sha256=8dMPYAFBTA7O4DUxhrEKEks8CL2waCMYM6dHohW4xrI,1065
+groundx-2.0.14.dist-info/METADATA,sha256=17yAs5nZtJR8qqezCNlXAfPBUTwMaUYWjgzM90Af0Kk,5344
+groundx-2.0.14.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+groundx-2.0.14.dist-info/RECORD,,