groundx 2.3.6__py3-none-any.whl → 2.3.8__py3-none-any.whl

groundx/core/client_wrapper.py

@@ -14,10 +14,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "groundx/2.3.6",
+            "User-Agent": "groundx/2.3.8",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.3.6",
+            "X-Fern-SDK-Version": "2.3.8",
         }
         headers["X-API-Key"] = self.api_key
         return headers

groundx/documents/client.py

@@ -40,6 +40,8 @@ class DocumentsClient:
         self,
         *,
         documents: typing.Sequence[IngestRemoteDocument],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> IngestResponse:
         """
@@ -51,6 +53,12 @@ class DocumentsClient:
         ----------
         documents : typing.Sequence[IngestRemoteDocument]
 
+        callback_url : typing.Optional[str]
+            An endpoint that will receive processing event updates as POST.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -77,7 +85,9 @@ class DocumentsClient:
             ],
         )
         """
-        _response = self._raw_client.ingest_remote(documents=documents, request_options=request_options)
+        _response = self._raw_client.ingest_remote(
+            documents=documents, callback_url=callback_url, callback_data=callback_data, request_options=request_options
+        )
         return _response.data
 
     def ingest_local(
@@ -124,7 +134,12 @@ class DocumentsClient:
         return _response.data
 
     def crawl_website(
-        self, *, websites: typing.Sequence[WebsiteSource], request_options: typing.Optional[RequestOptions] = None
+        self,
+        *,
+        websites: typing.Sequence[WebsiteSource],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
+        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.
@@ -138,6 +153,12 @@ class DocumentsClient:
         ----------
         websites : typing.Sequence[WebsiteSource]
 
+        callback_url : typing.Optional[str]
+            The URL that will receive processing event updates.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -165,7 +186,9 @@ class DocumentsClient:
             ],
         )
         """
-        _response = self._raw_client.crawl_website(websites=websites, request_options=request_options)
+        _response = self._raw_client.crawl_website(
+            websites=websites, callback_url=callback_url, callback_data=callback_data, request_options=request_options
+        )
         return _response.data
 
     def list(
@@ -490,6 +513,8 @@ class AsyncDocumentsClient:
         self,
         *,
         documents: typing.Sequence[IngestRemoteDocument],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> IngestResponse:
         """
@@ -501,6 +526,12 @@ class AsyncDocumentsClient:
         ----------
         documents : typing.Sequence[IngestRemoteDocument]
 
+        callback_url : typing.Optional[str]
+            An endpoint that will receive processing event updates as POST.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -535,7 +566,9 @@ class AsyncDocumentsClient:
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.ingest_remote(documents=documents, request_options=request_options)
+        _response = await self._raw_client.ingest_remote(
+            documents=documents, callback_url=callback_url, callback_data=callback_data, request_options=request_options
+        )
         return _response.data
 
     async def ingest_local(
@@ -594,7 +627,12 @@ class AsyncDocumentsClient:
         return _response.data
 
     async def crawl_website(
-        self, *, websites: typing.Sequence[WebsiteSource], request_options: typing.Optional[RequestOptions] = None
+        self,
+        *,
+        websites: typing.Sequence[WebsiteSource],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
+        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.
@@ -608,6 +646,12 @@ class AsyncDocumentsClient:
         ----------
         websites : typing.Sequence[WebsiteSource]
 
+        callback_url : typing.Optional[str]
+            The URL that will receive processing event updates.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -643,7 +687,9 @@ class AsyncDocumentsClient:
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.crawl_website(websites=websites, request_options=request_options)
+        _response = await self._raw_client.crawl_website(
+            websites=websites, callback_url=callback_url, callback_data=callback_data, request_options=request_options
+        )
         return _response.data
 
     async def list(

groundx/documents/raw_client.py

@@ -36,6 +36,8 @@ class RawDocumentsClient:
         self,
         *,
         documents: typing.Sequence[IngestRemoteDocument],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[IngestResponse]:
         """
@@ -47,6 +49,12 @@ class RawDocumentsClient:
         ----------
         documents : typing.Sequence[IngestRemoteDocument]
 
+        callback_url : typing.Optional[str]
+            An endpoint that will receive processing event updates as POST.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -62,6 +70,8 @@ class RawDocumentsClient:
                 "documents": convert_and_respect_annotation_metadata(
                     object_=documents, annotation=typing.Sequence[IngestRemoteDocument], direction="write"
                 ),
+                "callbackUrl": callback_url,
+                "callbackData": callback_data,
             },
             headers={
                 "content-type": "application/json",
@@ -176,7 +186,12 @@ class RawDocumentsClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     def crawl_website(
-        self, *, websites: typing.Sequence[WebsiteSource], request_options: typing.Optional[RequestOptions] = None
+        self,
+        *,
+        websites: typing.Sequence[WebsiteSource],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[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.
@@ -190,6 +205,12 @@ class RawDocumentsClient:
         ----------
         websites : typing.Sequence[WebsiteSource]
 
+        callback_url : typing.Optional[str]
+            The URL that will receive processing event updates.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -205,6 +226,8 @@ class RawDocumentsClient:
                 "websites": convert_and_respect_annotation_metadata(
                     object_=websites, annotation=typing.Sequence[WebsiteSource], direction="write"
                 ),
+                "callbackUrl": callback_url,
+                "callbackData": callback_data,
             },
             headers={
                 "content-type": "application/json",
@@ -724,6 +747,8 @@ class AsyncRawDocumentsClient:
         self,
         *,
         documents: typing.Sequence[IngestRemoteDocument],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[IngestResponse]:
         """
@@ -735,6 +760,12 @@ class AsyncRawDocumentsClient:
         ----------
         documents : typing.Sequence[IngestRemoteDocument]
 
+        callback_url : typing.Optional[str]
+            An endpoint that will receive processing event updates as POST.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -750,6 +781,8 @@ class AsyncRawDocumentsClient:
                 "documents": convert_and_respect_annotation_metadata(
                     object_=documents, annotation=typing.Sequence[IngestRemoteDocument], direction="write"
                 ),
+                "callbackUrl": callback_url,
+                "callbackData": callback_data,
             },
             headers={
                 "content-type": "application/json",
@@ -864,7 +897,12 @@ class AsyncRawDocumentsClient:
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
     async def crawl_website(
-        self, *, websites: typing.Sequence[WebsiteSource], request_options: typing.Optional[RequestOptions] = None
+        self,
+        *,
+        websites: typing.Sequence[WebsiteSource],
+        callback_url: typing.Optional[str] = OMIT,
+        callback_data: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[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.
@@ -878,6 +916,12 @@ class AsyncRawDocumentsClient:
         ----------
         websites : typing.Sequence[WebsiteSource]
 
+        callback_url : typing.Optional[str]
+            The URL that will receive processing event updates.
+
+        callback_data : typing.Optional[str]
+            A string that is returned, along with processing event updates, to the callback URL.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -893,6 +937,8 @@ class AsyncRawDocumentsClient:
                 "websites": convert_and_respect_annotation_metadata(
                     object_=websites, annotation=typing.Sequence[WebsiteSource], direction="write"
                 ),
+                "callbackUrl": callback_url,
+                "callbackData": callback_data,
             },
             headers={
                 "content-type": "application/json",

groundx/ingest.py

@@ -111,6 +111,7 @@ def prep_documents(
                 bucket_id=document.bucket_id,
                 file_name=document.file_name,
                 file_type=document.file_type,
+                filter=document.filter,
                 process_level=document.process_level,
                 search_data=document.search_data,
                 source_url=document.file_path,
@@ -431,6 +432,7 @@ class GroundX(GroundXBase):
                         bucket_id=d.bucket_id,
                         file_name=fn,
                         file_type=ft,
+                        filter=d.filter,
                         process_level=d.process_level,
                         search_data=d.search_data,
                         source_url=url,
@@ -610,6 +612,7 @@ class AsyncGroundX(AsyncGroundXBase):
                         bucket_id=d.bucket_id,
                         file_name=fn,
                         file_type=ft,
+                        filter=d.filter,
                         process_level=d.process_level,
                         search_data=d.search_data,
                         source_url=url,

{groundx-2.3.6.dist-info → groundx-2.3.8.dist-info}/METADATA

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

{groundx-2.3.6.dist-info → groundx-2.3.8.dist-info}/RECORD

@@ -5,7 +5,7 @@ groundx/buckets/raw_client.py,sha256=T2Ty5obN7eHbaxHGAimzjM8MGOmSOQEckhciyZkzcjE
 groundx/client.py,sha256=FsVhPSZ1kd70pOVv37zTbNSwBM7XdttSx4aEPobPoew,6412
 groundx/core/__init__.py,sha256=lTcqUPXcx4112yLDd70RAPeqq6tu3eFMe1pKOqkW9JQ,1562
 groundx/core/api_error.py,sha256=44vPoTyWN59gonCIZMdzw7M1uspygiLnr3GNFOoVL2Q,614
-groundx/core/client_wrapper.py,sha256=Pc236_8QSvkPW0XDXxHE4N4ot7DhDL4O4795nIu-ES0,1822
+groundx/core/client_wrapper.py,sha256=6kt4UKqg0xo6rR-WTr5MysDjueo-vbjqXq2vVg_sXWs,1822
 groundx/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 groundx/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
 groundx/core/force_multipart.py,sha256=awxh5MtcRYe74ehY8U76jzv6fYM_w_D3Rur7KQQzSDk,429
@@ -22,8 +22,8 @@ groundx/customer/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,
 groundx/customer/client.py,sha256=OAW3fJcOjvSvmGBbQEiNRlPE-dt15yFZHYXq9qrSXnw,2710
 groundx/customer/raw_client.py,sha256=7qz8GU8Qe4G16YzeZ2Rz_cHNODPMTevOt4toPqCe0io,3403
 groundx/documents/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
-groundx/documents/client.py,sha256=bZ5AcpWNQgWsbFNM3hT1a-Ox4t42nzmZSjbimGkCSYo,31791
-groundx/documents/raw_client.py,sha256=FGR_u0FUoRUYJJmpEYVxntsgpx1tkMGO0l284UBHTzM,57493
+groundx/documents/client.py,sha256=PX6UsmF9-ISORcAjbG3Na-XCY1q1Y1H4C8r5VKBHjkY,33597
+groundx/documents/raw_client.py,sha256=u_qX6LSVsb2HxzNGC3DguCLqSZbGvSsQcStj1PyCoDA,59355
 groundx/environment.py,sha256=CInm1_DKtZ1mrxutmKb1qqv82P33r_S87hZD3Hc1VB0,159
 groundx/errors/__init__.py,sha256=Ua3Z6OWyRhcgrq0FSXOpwmOc4RxyTgzP2LXbkzGbMhk,234
 groundx/errors/bad_request_error.py,sha256=PnE3v3kETCXm9E3LiNcHLNtjPEUvpe98-r59q-kQb78,338
@@ -34,7 +34,7 @@ groundx/groups/raw_client.py,sha256=nP9yFh7MexjDUQU8TtB5j-HAmZJjQWOd78hu-KeMnRs,
 groundx/health/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
 groundx/health/client.py,sha256=kcGIlqCEzBl6fuwJaf3x-obOagXxyAlEFaPRH3qgdDs,4566
 groundx/health/raw_client.py,sha256=_TDa-O13PtC0RYCAq4bx5FESz1oLDLp9WExyOKjsIjs,7430
-groundx/ingest.py,sha256=GbCpuzqipBARt3FOTxTk9PpLxkQ4IS1SYnwlZBBcy7s,22399
+groundx/ingest.py,sha256=Tg2tQXJ5WtfyktMXMIM6qXgEYlRHXiC6-mXx58-bcxQ,22521
 groundx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 groundx/search/__init__.py,sha256=Y1EKHPBEh-ebo1YOikCHTHU9E8kBP2s7K4J_kZGzcOA,165
 groundx/search/client.py,sha256=P4-oektRdgtfxoi_NiGDSOrB2dDWfO9M5kVy61CnCPQ,13599
@@ -90,7 +90,7 @@ groundx/types/subscription_detail.py,sha256=GEEivqyiLsZtd8Ow7mqqwF1y0m0tHD-t9r9d
 groundx/types/subscription_detail_meters.py,sha256=vGqiR2uupVh5177DfOghjoe5mwzVhoWljKzPF-twUc0,794
 groundx/types/website_source.py,sha256=53jWDBtSrJVOsBVtVbZbjhEAsd0QGkXa7IuKO4AooLs,1542
 groundx/version.py,sha256=1yVogKaq260fQfckM2RYN2144SEw0QROsZW8ICtkG4U,74
-groundx-2.3.6.dist-info/LICENSE,sha256=dFE6nY1bHnSn6NqmdlghlU1gQqLqYNphrceGVehSa7o,1065
-groundx-2.3.6.dist-info/METADATA,sha256=aCP4OnU8XjmPzQTkeuSYoLKXY01o4MLnqss5eldwAbc,5173
-groundx-2.3.6.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-groundx-2.3.6.dist-info/RECORD,,
+groundx-2.3.8.dist-info/LICENSE,sha256=dFE6nY1bHnSn6NqmdlghlU1gQqLqYNphrceGVehSa7o,1065
+groundx-2.3.8.dist-info/METADATA,sha256=-QQUskjzs6nFZm4McDzrqSZKRVULQqNyNCawYRYuGk0,5173
+groundx-2.3.8.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+groundx-2.3.8.dist-info/RECORD,,