groundx 2.0.13__tar.gz → 2.0.15__tar.gz

{groundx-2.0.13 → groundx-2.0.15}/PKG-INFO

@@ -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 → groundx-2.0.15}/README.md

@@ -24,16 +24,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",
         )
     ],
@@ -47,8 +49,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",
@@ -58,8 +59,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 → groundx-2.0.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "groundx"
-version = "2.0.13"
+version = "2.0.15"
 description = ""
 readme = "README.md"
 authors = []

{groundx-2.0.13 → groundx-2.0.15}/src/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-2.0.13 → groundx-2.0.15}/src/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-2.0.15/src/groundx/documents/__init__.py

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

{groundx-2.0.13 → groundx-2.0.15}/src/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-2.0.15/src/groundx/documents/types/__init__.py

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

{groundx-2.0.13 → groundx-2.0.15}/src/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-2.0.13 → groundx-2.0.15}/src/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-2.0.13/src/groundx/documents/types/document_remote_ingest_request_documents_item.py → groundx-2.0.15/src/groundx/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/src/groundx/documents/__init__.py

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

groundx-2.0.13/src/groundx/documents/types/__init__.py

@@ -1,11 +0,0 @@
-# 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",
-]