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

groundx/__init__.py

@@ -7,6 +7,7 @@ from .types import (
     BucketResponse,
     BucketUpdateDetail,
     BucketUpdateResponse,
+    CrawlWebsiteSource,
     CustomerDetail,
     CustomerResponse,
     DocumentDetail,
@@ -21,6 +22,7 @@ from .types import (
     HealthResponseHealth,
     HealthService,
     HealthServiceStatus,
+    IngestLocalDocument,
     IngestRemoteDocument,
     IngestResponse,
     IngestResponseIngest,
@@ -45,7 +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 DocumentsIngestLocalRequestFilesItem, WebsiteCrawlRequestWebsitesItem
 from .environment import GroundXEnvironment
 from .search import SearchContentRequestId
 from .version import __version__
@@ -59,6 +60,7 @@ __all__ = [
     "BucketResponse",
     "BucketUpdateDetail",
     "BucketUpdateResponse",
+    "CrawlWebsiteSource",
     "CustomerDetail",
     "CustomerResponse",
     "DocumentDetail",
@@ -66,7 +68,6 @@ __all__ = [
     "DocumentLookupResponse",
     "DocumentResponse",
     "DocumentType",
-    "DocumentsIngestLocalRequestFilesItem",
     "GroundX",
     "GroundXEnvironment",
     "GroupDetail",
@@ -76,6 +77,7 @@ __all__ = [
     "HealthResponseHealth",
     "HealthService",
     "HealthServiceStatus",
+    "IngestLocalDocument",
     "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",
@@ -98,7 +100,6 @@ __all__ = [
     "SubscriptionDetail",
     "SubscriptionDetailMeters",
     "UnauthorizedError",
-    "WebsiteCrawlRequestWebsitesItem",
     "__version__",
     "buckets",
     "customer",

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

groundx/documents/__init__.py

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

groundx/documents/client.py

@@ -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
@@ -124,7 +124,7 @@ class DocumentsClient:
     def ingest_local(
         self,
         *,
-        files: typing.List[DocumentsIngestLocalRequestFilesItem],
+        documents: typing.Optional[typing.List[IngestLocalDocument]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> IngestResponse:
         """
@@ -134,7 +134,7 @@ class DocumentsClient:
 
         Parameters
         ----------
-        files : typing.List[DocumentsIngestLocalRequestFilesItem]
+        documents : typing.Optional[typing.List[IngestLocalDocument]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -146,19 +146,19 @@ 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",
+            documents=[
+                IngestLocalDocument(
+                    bucket_id=1234,
+                    file_data="binary data",
+                    file_name="my_file.txt",
                     file_type="txt",
+                    search_data={"key": "value"},
                 )
             ],
         )
@@ -167,7 +167,7 @@ class DocumentsClient:
             "v1/ingest/documents/local",
             method="POST",
             data={
-                "files": files,
+                "documents": documents,
             },
             files={},
             request_options=request_options,
@@ -208,10 +208,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.
@@ -220,7 +217,7 @@ class DocumentsClient:
 
         Parameters
         ----------
-        websites : typing.Sequence[WebsiteCrawlRequestWebsitesItem]
+        websites : typing.Sequence[CrawlWebsiteSource]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -232,16 +229,18 @@ 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(
-                    bucket_id=123,
+                CrawlWebsiteSource(
+                    bucket_id=1234,
+                    cap=100,
+                    depth=3,
+                    search_data={"key": "value"},
                     source_url="https://my.website.com",
                 )
             ],
@@ -252,7 +251,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={
@@ -873,7 +872,7 @@ class AsyncDocumentsClient:
     async def ingest_local(
         self,
         *,
-        files: typing.List[DocumentsIngestLocalRequestFilesItem],
+        documents: typing.Optional[typing.List[IngestLocalDocument]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> IngestResponse:
         """
@@ -883,7 +882,7 @@ class AsyncDocumentsClient:
 
         Parameters
         ----------
-        files : typing.List[DocumentsIngestLocalRequestFilesItem]
+        documents : typing.Optional[typing.List[IngestLocalDocument]]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -897,8 +896,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",
@@ -907,12 +905,13 @@ class AsyncDocumentsClient:
 
         async def main() -> None:
             await client.documents.ingest_local(
-                files=[
-                    DocumentsIngestLocalRequestFilesItem(
-                        bucket_id=1,
-                        file_data="fileData",
-                        file_name="fileName",
+                documents=[
+                    IngestLocalDocument(
+                        bucket_id=1234,
+                        file_data="binary data",
+                        file_name="my_file.txt",
                         file_type="txt",
+                        search_data={"key": "value"},
                     )
                 ],
             )
@@ -924,7 +923,7 @@ class AsyncDocumentsClient:
             "v1/ingest/documents/local",
             method="POST",
             data={
-                "files": files,
+                "documents": documents,
             },
             files={},
             request_options=request_options,
@@ -965,10 +964,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.
@@ -977,7 +973,7 @@ class AsyncDocumentsClient:
 
         Parameters
         ----------
-        websites : typing.Sequence[WebsiteCrawlRequestWebsitesItem]
+        websites : typing.Sequence[CrawlWebsiteSource]
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -991,8 +987,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",
@@ -1002,8 +997,11 @@ class AsyncDocumentsClient:
         async def main() -> None:
             await client.documents.crawl_website(
                 websites=[
-                    WebsiteCrawlRequestWebsitesItem(
-                        bucket_id=123,
+                    CrawlWebsiteSource(
+                        bucket_id=1234,
+                        cap=100,
+                        depth=3,
+                        search_data={"key": "value"},
                         source_url="https://my.website.com",
                     )
                 ],
@@ -1017,7 +1015,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/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,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_local_document import IngestLocalDocument
 from .ingest_remote_document import IngestRemoteDocument
 from .ingest_response import IngestResponse
 from .ingest_response_ingest import IngestResponseIngest
@@ -48,6 +50,7 @@ __all__ = [
     "BucketResponse",
     "BucketUpdateDetail",
     "BucketUpdateResponse",
+    "CrawlWebsiteSource",
     "CustomerDetail",
     "CustomerResponse",
     "DocumentDetail",
@@ -62,6 +65,7 @@ __all__ = [
     "HealthResponseHealth",
     "HealthService",
     "HealthServiceStatus",
+    "IngestLocalDocument",
     "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",

groundx/{documents/types/website_crawl_request_websites_item.py → 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/{documents/types/documents_ingest_local_request_files_item.py → 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.15.dist-info → groundx-2.0.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.0.15
+Version: 2.0.17
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0

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

@@ -1,10 +1,10 @@
-groundx/__init__.py,sha256=k3hsC7MSufSELpIPOb1-G3Y_-YM2GV61ADC-EwSaPvw,2925
+groundx/__init__.py,sha256=22BLAf5omcgumWGCWHDb8o-ha8TnNbkO8LcEvpcYU6A,2851
 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=66tcEWEACDxQIXDiX5s5Kn5XdmYZETM2b8YUiM7Spgs,1803
+groundx/core/client_wrapper.py,sha256=zY1z1mzje1H39BKU9IR7OxYeBRV-PVvs004iAgfDqxI,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,8 @@ 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=-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/documents/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+groundx/documents/client.py,sha256=_l8K11r-p3qaMd0Qn43JjnSN68stMiaRoTzbbukQxl8,58882
 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
@@ -34,13 +31,14 @@ 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=W5fN6ryfqki0p_bipBi7jKs6SXH2vVsrOe5ORcbngVY,3406
+groundx/types/__init__.py,sha256=yCuwY3aySGDKKYYbxFX_v0kyG_ePu1_M0ZryOwMZJVk,3567
 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
 groundx/types/bucket_response.py,sha256=E8V7H2_TVKdmMsGCBjwzdf2bg4rUjiXFnhXtVGVCqZQ,608
 groundx/types/bucket_update_detail.py,sha256=B4atQMDSXEdx7otcDbvgsrAHtXNz9swMnOsXRe25coc,738
 groundx/types/bucket_update_response.py,sha256=h5RJTEpc4WPI_C4sPvsJZo7IxKppnPR-I9VGEQryRlc,633
+groundx/types/crawl_website_source.py,sha256=K4-IoK__K4OekBwmJhClL2rZD1P4rFPR2-Ck02jP2uw,1581
 groundx/types/customer_detail.py,sha256=RNm0qXvKx6YvVmkVJZeCNIz7n8_siFMXJ_AGtH3i5Z0,1094
 groundx/types/customer_response.py,sha256=_RbuanXhCWQkCeQ0dkwPgsjNBoBgNpixiNfRpXcMew8,618
 groundx/types/document_detail.py,sha256=i1UfcQAGYo9v1HwrrpzQPw_O0qA7IOXwOUuPV1yU8nI,2323
@@ -55,6 +53,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_local_document.py,sha256=2T1HXR2a-BDj5LEOTM98Sl4sgjVMWbVShQLn8MTR6QA,1602
 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 +75,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.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,,
+groundx-2.0.17.dist-info/LICENSE,sha256=8dMPYAFBTA7O4DUxhrEKEks8CL2waCMYM6dHohW4xrI,1065
+groundx-2.0.17.dist-info/METADATA,sha256=HZspuVrfswC62NtJa1cUVkS53KO8stJ8xnqTNfFx4lE,5206
+groundx-2.0.17.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+groundx-2.0.17.dist-info/RECORD,,

groundx/documents/types/__init__.py

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