groundx 2.4.0__py3-none-any.whl → 2.4.2__py3-none-any.whl

groundx/buckets/client.py

@@ -62,7 +62,10 @@ class BucketsClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.buckets.list()
+        client.buckets.list(
+            n=1,
+            next_token="nextToken",
+        )
         """
         _response = self._raw_client.list(n=n, next_token=next_token, request_options=request_options)
         return _response.data
@@ -250,7 +253,10 @@ class AsyncBucketsClient:
 
 
         async def main() -> None:
-            await client.buckets.list()
+            await client.buckets.list(
+                n=1,
+                next_token="nextToken",
+            )
 
 
         asyncio.run(main())

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.4.0",
+            "User-Agent": "groundx/2.4.2",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.4.0",
+            "X-Fern-SDK-Version": "2.4.2",
         }
         headers["X-API-Key"] = self.api_key
         return headers

groundx/documents/client.py

@@ -240,7 +240,14 @@ class DocumentsClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.documents.list()
+        client.documents.list(
+            n=1,
+            filter="filter",
+            sort="name",
+            sort_order="asc",
+            status="queued",
+            next_token="nextToken",
+        )
         """
         _response = self._raw_client.list(
             n=n,
@@ -377,6 +384,12 @@ class DocumentsClient:
         )
         client.documents.lookup(
             id=1,
+            n=1,
+            filter="filter",
+            sort="name",
+            sort_order="asc",
+            status="queued",
+            next_token="nextToken",
         )
         """
         _response = self._raw_client.lookup(
@@ -488,7 +501,10 @@ class DocumentsClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.documents.get_processes()
+        client.documents.get_processes(
+            n=1,
+            status="queued",
+        )
         """
         _response = self._raw_client.get_processes(n=n, status=status, request_options=request_options)
         return _response.data
@@ -746,7 +762,14 @@ class AsyncDocumentsClient:
 
 
         async def main() -> None:
-            await client.documents.list()
+            await client.documents.list(
+                n=1,
+                filter="filter",
+                sort="name",
+                sort_order="asc",
+                status="queued",
+                next_token="nextToken",
+            )
 
 
         asyncio.run(main())
@@ -907,6 +930,12 @@ class AsyncDocumentsClient:
         async def main() -> None:
             await client.documents.lookup(
                 id=1,
+                n=1,
+                filter="filter",
+                sort="name",
+                sort_order="asc",
+                status="queued",
+                next_token="nextToken",
             )
 
 
@@ -1044,7 +1073,10 @@ class AsyncDocumentsClient:
 
 
         async def main() -> None:
-            await client.documents.get_processes()
+            await client.documents.get_processes(
+                n=1,
+                status="queued",
+            )
 
 
         asyncio.run(main())

groundx/groups/client.py

@@ -61,7 +61,10 @@ class GroupsClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.groups.list()
+        client.groups.list(
+            n=1,
+            next_token="nextToken",
+        )
         """
         _response = self._raw_client.list(n=n, next_token=next_token, request_options=request_options)
         return _response.data
@@ -333,7 +336,10 @@ class AsyncGroupsClient:
 
 
         async def main() -> None:
-            await client.groups.list()
+            await client.groups.list(
+                n=1,
+                next_token="nextToken",
+            )
 
 
         asyncio.run(main())

groundx/search/client.py

@@ -83,7 +83,9 @@ class SearchClient:
         )
         client.search.content(
             id=1,
+            n=1,
             next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+            verbosity=1,
             query="my search query",
         )
         """
@@ -154,7 +156,9 @@ class SearchClient:
             api_key="YOUR_API_KEY",
         )
         client.search.documents(
+            n=1,
             next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+            verbosity=1,
             query="my search query",
             document_ids=["docUUID1", "docUUID2"],
         )
@@ -248,7 +252,9 @@ class AsyncSearchClient:
         async def main() -> None:
             await client.search.content(
                 id=1,
+                n=1,
                 next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+                verbosity=1,
                 query="my search query",
             )
 
@@ -327,7 +333,9 @@ class AsyncSearchClient:
 
         async def main() -> None:
             await client.search.documents(
+                n=1,
                 next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+                verbosity=1,
                 query="my search query",
                 document_ids=["docUUID1", "docUUID2"],
             )

groundx/types/document_detail.py

@@ -50,6 +50,13 @@ class DocumentDetail(UniversalBaseModel):
 
     status: typing.Optional[ProcessingStatus] = None
     status_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="statusMessage")] = None
+    text_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="textUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    Extracted text URL, if using the extract agent
+    """
+
     xray_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="xrayUrl")] = pydantic.Field(
         default=None
     )

{groundx-2.4.0.dist-info → groundx-2.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.4.0
+Version: 2.4.2
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -20,9 +20,10 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
+Provides-Extra: extract
 Requires-Dist: aiohttp (>=3.8.0)
 Requires-Dist: httpx (>=0.21.2)
-Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic (>=1.9.2) ; extra == "extract"
 Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
 Requires-Dist: requests (>=2.4.0)
 Requires-Dist: tqdm (>=4.60.0)

{groundx-2.4.0.dist-info → groundx-2.4.2.dist-info}/RECORD

@@ -1,11 +1,11 @@
 groundx/__init__.py,sha256=0ysG1bUu9YHhB92o5bZdxvLKTLPzmYb_Lk06fDC-Dww,2945
 groundx/buckets/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
-groundx/buckets/client.py,sha256=OGD9D7SkaeBvS7aWDGTLmTUHt0cgnvn15eJq-5WWGoo,11324
+groundx/buckets/client.py,sha256=F1tcqQoqmrC8lQtRZvmXldIdVxIp1LWfdbAfY8SB5sM,11460
 groundx/buckets/raw_client.py,sha256=T2Ty5obN7eHbaxHGAimzjM8MGOmSOQEckhciyZkzcjE,23873
 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=QiklXbF6c_xTskKuMCQDIYAZpCR8GsNsyoTj-ZZSQ7k,1822
+groundx/core/client_wrapper.py,sha256=UzyUqu9L92Dg3ROxiqzb7bEwZQ2eAlVucZVvFptlpDA,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,14 +22,14 @@ 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=PX6UsmF9-ISORcAjbG3Na-XCY1q1Y1H4C8r5VKBHjkY,33597
+groundx/documents/client.py,sha256=hRPDQnsrr6P3jvEC6lcW3B-_npTGOhcCw_H6gsWdC0U,34453
 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
 groundx/errors/unauthorized_error.py,sha256=mryinHCAaknn5St2VF17R9XybZUcWRRYWEjxg63dQSA,340
 groundx/groups/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
-groundx/groups/client.py,sha256=jPnFPv4FHvYBQxuFxjbQvdUWrhIB8kkKbzUkoosMUP0,16674
+groundx/groups/client.py,sha256=QsZcOXVPHAdUPYPsfuFiPOkyssapSWLZYVD82NWmrSE,16810
 groundx/groups/raw_client.py,sha256=nP9yFh7MexjDUQU8TtB5j-HAmZJjQWOd78hu-KeMnRs,35111
 groundx/health/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
 groundx/health/client.py,sha256=kcGIlqCEzBl6fuwJaf3x-obOagXxyAlEFaPRH3qgdDs,4566
@@ -37,7 +37,7 @@ groundx/health/raw_client.py,sha256=_TDa-O13PtC0RYCAq4bx5FESz1oLDLp9WExyOKjsIjs,
 groundx/ingest.py,sha256=yMX39sDmm0NfdojkBtPxcIBGNXn33djCJO5nlcIKX3c,24780
 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
+groundx/search/client.py,sha256=ArfAbcQGS6eCWuMU5Ld-AQ8nB0Vh-4Jec3tt05QJtuM,13783
 groundx/search/raw_client.py,sha256=_qO5u62e1d0rVbRUeyJFdt85v7WT_bSHcSLf8wJvfgQ,19545
 groundx/search/types/__init__.py,sha256=sy0s9qFdeT4Q3SJxK6hrulnsPirVpKkjxI29OqLTY0s,185
 groundx/search/types/search_content_request_id.py,sha256=us7mYdzR0qPur_wR5I9BhHaLEzC5nLBRna6-xq4M1ec,128
@@ -51,7 +51,7 @@ groundx/types/bucket_update_response.py,sha256=2gSJ77lwb12YPBnDXFflZTtFa6vIen1jd
 groundx/types/customer_detail.py,sha256=yvSzH-6YZviBNGgeAk3uB1Tvrpp5FW1bEI_wmKklF2c,1058
 groundx/types/customer_response.py,sha256=jIU8Q5hAFJA3Bt1-3E4p00blQLbjeNAF5-pfXSiih1w,582
 groundx/types/document.py,sha256=eO1hcklCSp8buUaqjBT6gYQsxVl85HvIEAa4iJdw4ms,2052
-groundx/types/document_detail.py,sha256=ENAeaf6shIHpIsDbOdDjX6DRrC6ButKfLMrgw-vANsM,2506
+groundx/types/document_detail.py,sha256=jrKq3Qjp4qyX6Wx2yeDj5GGX1VKY4N6dcnvks0YBKbw,2715
 groundx/types/document_list_response.py,sha256=n8yfjEA_k-_dPmRxsOAK2vXa7HtDkPNO8FF0dB4LFI4,803
 groundx/types/document_local_ingest_request.py,sha256=y3rIqid4VXWNgb6wTis7zQmxsnKYIwOiFQwv5GLmpsQ,198
 groundx/types/document_lookup_response.py,sha256=-ZXxd5RvE980PbTu_AOiQ-cIcHCG4HVkqphRZjCCd2s,1252
@@ -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.4.0.dist-info/LICENSE,sha256=dFE6nY1bHnSn6NqmdlghlU1gQqLqYNphrceGVehSa7o,1065
-groundx-2.4.0.dist-info/METADATA,sha256=btuoAye6KOgoOgbpAIpdy-d3GlRt3SuYWakOGLCnAN8,5173
-groundx-2.4.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-groundx-2.4.0.dist-info/RECORD,,
+groundx-2.4.2.dist-info/LICENSE,sha256=dFE6nY1bHnSn6NqmdlghlU1gQqLqYNphrceGVehSa7o,1065
+groundx-2.4.2.dist-info/METADATA,sha256=4XQrgHVP9i952MqBSt_p-utOIBYCAROHH_lqjrxKtog,5218
+groundx-2.4.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+groundx-2.4.2.dist-info/RECORD,,