groundx 2.0.14__tar.gz → 2.0.16__tar.gz

{groundx-2.0.14 → groundx-2.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.0.14
+Version: 2.0.16
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -52,15 +52,14 @@ 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",
@@ -78,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",
@@ -89,7 +87,7 @@ 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",

{groundx-2.0.14 → groundx-2.0.16}/README.md

@@ -24,15 +24,14 @@ 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",
@@ -50,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",
@@ -61,7 +59,7 @@ 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",

{groundx-2.0.14 → groundx-2.0.16}/pyproject.toml

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

{groundx-2.0.14 → groundx-2.0.16}/src/groundx/__init__.py

@@ -7,6 +7,7 @@ from .types import (
     BucketResponse,
     BucketUpdateDetail,
     BucketUpdateResponse,
+    CrawlWebsiteSource,
     CustomerDetail,
     CustomerResponse,
     DocumentDetail,
@@ -21,6 +22,8 @@ from .types import (
     HealthResponseHealth,
     HealthService,
     HealthServiceStatus,
+    IngestLocalDocument,
+    IngestRemoteDocument,
     IngestResponse,
     IngestResponseIngest,
     MessageResponse,
@@ -44,11 +47,6 @@ 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 .environment import GroundXEnvironment
 from .search import SearchContentRequestId
 from .version import __version__
@@ -62,15 +60,14 @@ __all__ = [
     "BucketResponse",
     "BucketUpdateDetail",
     "BucketUpdateResponse",
+    "CrawlWebsiteSource",
     "CustomerDetail",
     "CustomerResponse",
     "DocumentDetail",
     "DocumentListResponse",
     "DocumentLookupResponse",
-    "DocumentRemoteIngestRequestDocumentsItem",
     "DocumentResponse",
     "DocumentType",
-    "DocumentsIngestLocalRequestFilesItem",
     "GroundX",
     "GroundXEnvironment",
     "GroupDetail",
@@ -80,6 +77,8 @@ __all__ = [
     "HealthResponseHealth",
     "HealthService",
     "HealthServiceStatus",
+    "IngestLocalDocument",
+    "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",
     "MessageResponse",
@@ -101,7 +100,6 @@ __all__ = [
     "SubscriptionDetail",
     "SubscriptionDetailMeters",
     "UnauthorizedError",
-    "WebsiteCrawlRequestWebsitesItem",
     "__version__",
     "buckets",
     "customer",

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

{groundx-2.0.14 → groundx-2.0.16}/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
@@ -11,8 +11,8 @@ 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.ingest_local_document import IngestLocalDocument
+from ..types.crawl_website_source import CrawlWebsiteSource
 from ..types.process_status_response import ProcessStatusResponse
 from ..core.jsonable_encoder import jsonable_encoder
 from ..types.sort import Sort
@@ -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,15 +56,14 @@ 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",
@@ -79,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={
@@ -125,10 +122,7 @@ class DocumentsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def ingest_local(
-        self,
-        *,
-        files: typing.List[DocumentsIngestLocalRequestFilesItem],
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, files: typing.List[IngestLocalDocument], request_options: typing.Optional[RequestOptions] = None
     ) -> IngestResponse:
         """
         Upload documents hosted on a local file system for ingestion into a GroundX bucket.
@@ -137,7 +131,7 @@ class DocumentsClient:
 
         Parameters
         ----------
-        files : typing.List[DocumentsIngestLocalRequestFilesItem]
+        files : typing.List[IngestLocalDocument]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -149,18 +143,17 @@ class DocumentsClient:
 
         Examples
         --------
-        from groundx import GroundX
-        from groundx.documents import DocumentsIngestLocalRequestFilesItem
+        from groundx import GroundX, IngestLocalDocument
 
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
         client.documents.ingest_local(
             files=[
-                DocumentsIngestLocalRequestFilesItem(
-                    bucket_id=1,
-                    file_data="fileData",
-                    file_name="fileName",
+                IngestLocalDocument(
+                    bucket_id=1234,
+                    file_data="binary data here",
+                    file_name="my_file.txt",
                     file_type="txt",
                 )
             ],
@@ -211,10 +204,7 @@ class DocumentsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def crawl_website(
-        self,
-        *,
-        websites: typing.Sequence[WebsiteCrawlRequestWebsitesItem],
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, websites: typing.Sequence[CrawlWebsiteSource], request_options: typing.Optional[RequestOptions] = None
     ) -> IngestResponse:
         """
         Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages.
@@ -223,7 +213,7 @@ class DocumentsClient:
 
         Parameters
         ----------
-        websites : typing.Sequence[WebsiteCrawlRequestWebsitesItem]
+        websites : typing.Sequence[CrawlWebsiteSource]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -235,15 +225,14 @@ class DocumentsClient:
 
         Examples
         --------
-        from groundx import GroundX
-        from groundx.documents import WebsiteCrawlRequestWebsitesItem
+        from groundx import CrawlWebsiteSource, GroundX
 
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
         client.documents.crawl_website(
             websites=[
-                WebsiteCrawlRequestWebsitesItem(
+                CrawlWebsiteSource(
                     bucket_id=123,
                     source_url="https://my.website.com",
                 )
@@ -255,7 +244,7 @@ class DocumentsClient:
             method="POST",
             json={
                 "websites": convert_and_respect_annotation_metadata(
-                    object_=websites, annotation=typing.Sequence[WebsiteCrawlRequestWebsitesItem], direction="write"
+                    object_=websites, annotation=typing.Sequence[CrawlWebsiteSource], direction="write"
                 ),
             },
             headers={
@@ -778,7 +767,7 @@ class AsyncDocumentsClient:
     async def ingest_remote(
         self,
         *,
-        documents: typing.Sequence[DocumentRemoteIngestRequestDocumentsItem],
+        documents: typing.Sequence[IngestRemoteDocument],
         request_options: typing.Optional[RequestOptions] = None,
     ) -> IngestResponse:
         """
@@ -788,7 +777,7 @@ class AsyncDocumentsClient:
 
         Parameters
         ----------
-        documents : typing.Sequence[DocumentRemoteIngestRequestDocumentsItem]
+        documents : typing.Sequence[IngestRemoteDocument]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -802,8 +791,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",
@@ -813,7 +801,7 @@ 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",
@@ -831,9 +819,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={
@@ -877,10 +863,7 @@ class AsyncDocumentsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def ingest_local(
-        self,
-        *,
-        files: typing.List[DocumentsIngestLocalRequestFilesItem],
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, files: typing.List[IngestLocalDocument], request_options: typing.Optional[RequestOptions] = None
     ) -> IngestResponse:
         """
         Upload documents hosted on a local file system for ingestion into a GroundX bucket.
@@ -889,7 +872,7 @@ class AsyncDocumentsClient:
 
         Parameters
         ----------
-        files : typing.List[DocumentsIngestLocalRequestFilesItem]
+        files : typing.List[IngestLocalDocument]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -903,8 +886,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from groundx import AsyncGroundX
-        from groundx.documents import DocumentsIngestLocalRequestFilesItem
+        from groundx import AsyncGroundX, IngestLocalDocument
 
         client = AsyncGroundX(
             api_key="YOUR_API_KEY",
@@ -914,10 +896,10 @@ class AsyncDocumentsClient:
         async def main() -> None:
             await client.documents.ingest_local(
                 files=[
-                    DocumentsIngestLocalRequestFilesItem(
-                        bucket_id=1,
-                        file_data="fileData",
-                        file_name="fileName",
+                    IngestLocalDocument(
+                        bucket_id=1234,
+                        file_data="binary data here",
+                        file_name="my_file.txt",
                         file_type="txt",
                     )
                 ],
@@ -971,10 +953,7 @@ class AsyncDocumentsClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def crawl_website(
-        self,
-        *,
-        websites: typing.Sequence[WebsiteCrawlRequestWebsitesItem],
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, websites: typing.Sequence[CrawlWebsiteSource], request_options: typing.Optional[RequestOptions] = None
     ) -> IngestResponse:
         """
         Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages.
@@ -983,7 +962,7 @@ class AsyncDocumentsClient:
 
         Parameters
         ----------
-        websites : typing.Sequence[WebsiteCrawlRequestWebsitesItem]
+        websites : typing.Sequence[CrawlWebsiteSource]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -997,8 +976,7 @@ class AsyncDocumentsClient:
         --------
         import asyncio
 
-        from groundx import AsyncGroundX
-        from groundx.documents import WebsiteCrawlRequestWebsitesItem
+        from groundx import AsyncGroundX, CrawlWebsiteSource
 
         client = AsyncGroundX(
             api_key="YOUR_API_KEY",
@@ -1008,7 +986,7 @@ class AsyncDocumentsClient:
         async def main() -> None:
             await client.documents.crawl_website(
                 websites=[
-                    WebsiteCrawlRequestWebsitesItem(
+                    CrawlWebsiteSource(
                         bucket_id=123,
                         source_url="https://my.website.com",
                     )
@@ -1023,7 +1001,7 @@ class AsyncDocumentsClient:
             method="POST",
             json={
                 "websites": convert_and_respect_annotation_metadata(
-                    object_=websites, annotation=typing.Sequence[WebsiteCrawlRequestWebsitesItem], direction="write"
+                    object_=websites, annotation=typing.Sequence[CrawlWebsiteSource], direction="write"
                 ),
             },
             headers={

groundx-2.0.16/src/groundx/health/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

{groundx-2.0.14 → groundx-2.0.16}/src/groundx/types/__init__.py

@@ -6,6 +6,7 @@ from .bucket_list_response import BucketListResponse
 from .bucket_response import BucketResponse
 from .bucket_update_detail import BucketUpdateDetail
 from .bucket_update_response import BucketUpdateResponse
+from .crawl_website_source import CrawlWebsiteSource
 from .customer_detail import CustomerDetail
 from .customer_response import CustomerResponse
 from .document_detail import DocumentDetail
@@ -20,6 +21,8 @@ from .health_response import HealthResponse
 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_remote_document import IngestRemoteDocument
 from .ingest_response import IngestResponse
 from .ingest_response_ingest import IngestResponseIngest
 from .message_response import MessageResponse
@@ -47,6 +50,7 @@ __all__ = [
     "BucketResponse",
     "BucketUpdateDetail",
     "BucketUpdateResponse",
+    "CrawlWebsiteSource",
     "CustomerDetail",
     "CustomerResponse",
     "DocumentDetail",
@@ -61,6 +65,8 @@ __all__ = [
     "HealthResponseHealth",
     "HealthService",
     "HealthServiceStatus",
+    "IngestLocalDocument",
+    "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",
     "MessageResponse",

groundx-2.0.14/src/groundx/documents/types/website_crawl_request_websites_item.py → groundx-2.0.16/src/groundx/types/crawl_website_source.py

@@ -1,14 +1,14 @@
 # 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 ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class WebsiteCrawlRequestWebsitesItem(UniversalBaseModel):
+class CrawlWebsiteSource(UniversalBaseModel):
     bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")] = pydantic.Field()
     """
     the bucketId of the bucket which this website will be ingested to.

groundx-2.0.14/src/groundx/documents/types/documents_ingest_local_request_files_item.py → groundx-2.0.16/src/groundx/types/ingest_local_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
-from ...types.document_type import DocumentType
+from .document_type import DocumentType
 import typing
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class DocumentsIngestLocalRequestFilesItem(UniversalBaseModel):
+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.

groundx-2.0.14/src/groundx/documents/types/document_remote_ingest_request_documents_item.py → groundx-2.0.16/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.14/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.14/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",
-]