groundx 2.0.29__tar.gz → 2.2.0__tar.gz

{groundx-2.0.29 → groundx-2.2.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Eyelevel.
+Copyright (c) 2025 Eyelevel.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{groundx-2.0.29 → groundx-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.0.29
+Version: 2.2.0
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -37,7 +37,7 @@ The GroundX Python library provides convenient access to the GroundX API from Py
 
 ## Documentation
 
-API reference documentation is available [here](https://docs.groundx.ai/reference).
+API reference documentation is available [here](https://docs.eyelevel.ai/reference).
 
 ## Installation
 

{groundx-2.0.29 → groundx-2.2.0}/README.md

@@ -7,7 +7,7 @@ The GroundX Python library provides convenient access to the GroundX API from Py
 
 ## Documentation
 
-API reference documentation is available [here](https://docs.groundx.ai/reference).
+API reference documentation is available [here](https://docs.eyelevel.ai/reference).
 
 ## Installation
 

{groundx-2.0.29 → groundx-2.2.0}/pyproject.toml

@@ -1,6 +1,9 @@
+[project]
+name = "groundx"
+
 [tool.poetry]
 name = "groundx"
-version = "2.0.29"
+version = "2.2.0"
 description = ""
 readme = "README.md"
 authors = []

{groundx-2.0.29 → groundx-2.2.0}/src/groundx/buckets/client.py

@@ -33,8 +33,6 @@ class BucketsClient:
         """
         List all buckets within your GroundX account
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         n : typing.Optional[int]
@@ -87,8 +85,6 @@ class BucketsClient:
         """
         Create a new bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         name : str
@@ -152,8 +148,6 @@ class BucketsClient:
         """
         Look up a specific bucket by its bucketId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         bucket_id : int
@@ -223,8 +217,6 @@ class BucketsClient:
         """
         Rename a bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         bucket_id : int
@@ -303,8 +295,6 @@ class BucketsClient:
         """
         Delete a bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         bucket_id : int
@@ -383,8 +373,6 @@ class AsyncBucketsClient:
         """
         List all buckets within your GroundX account
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         n : typing.Optional[int]
@@ -445,8 +433,6 @@ class AsyncBucketsClient:
         """
         Create a new bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         name : str
@@ -518,8 +504,6 @@ class AsyncBucketsClient:
         """
         Look up a specific bucket by its bucketId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         bucket_id : int
@@ -597,8 +581,6 @@ class AsyncBucketsClient:
         """
         Rename a bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         bucket_id : int
@@ -687,8 +669,6 @@ class AsyncBucketsClient:
         """
         Delete a bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         bucket_id : int

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

{groundx-2.0.29 → groundx-2.2.0}/src/groundx/documents/client.py

@@ -40,8 +40,6 @@ class DocumentsClient:
         """
         Ingest documents hosted on public URLs into a GroundX bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         documents : typing.Sequence[IngestRemoteDocument]
@@ -126,8 +124,6 @@ class DocumentsClient:
         """
         Upload documents hosted on a local file system into a GroundX bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         request : DocumentLocalIngestRequest
@@ -208,8 +204,8 @@ class DocumentsClient:
     ) -> 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.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        Note1: This endpoint is currently not supported for on-prem deployments.
+        Note2: The `source_url` must include the protocol, http:// or https://.
 
         Parameters
         ----------
@@ -234,8 +230,8 @@ class DocumentsClient:
             websites=[
                 WebsiteSource(
                     bucket_id=1234,
-                    cap=100,
-                    depth=3,
+                    cap=10,
+                    depth=2,
                     search_data={"key": "value"},
                     source_url="https://my.website.com",
                 )
@@ -304,8 +300,6 @@ class DocumentsClient:
         """
         lookup all documents across all resources which are currently on GroundX
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         n : typing.Optional[int]
@@ -379,8 +373,6 @@ class DocumentsClient:
         """
         Delete multiple documents hosted on GroundX
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         document_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
@@ -401,7 +393,9 @@ class DocumentsClient:
         client = GroundX(
             api_key="YOUR_API_KEY",
         )
-        client.documents.delete()
+        client.documents.delete(
+            document_ids="123e4567-e89b-12d3-a456-426614174000,9f7c11a6-24b8-4d52-a9f3-90a7e70a9e49",
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "v1/ingest/documents",
@@ -451,8 +445,6 @@ class DocumentsClient:
         """
         Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions).
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         process_id : str
@@ -531,8 +523,6 @@ class DocumentsClient:
         """
         lookup the document(s) associated with a processId, bucketId, groupId, or projectId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         id : int
@@ -626,8 +616,6 @@ class DocumentsClient:
         """
         Look up an existing document by documentId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         document_id : str
@@ -697,8 +685,6 @@ class DocumentsClient:
         """
         Delete a single document hosted on GroundX
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         document_id : str
@@ -776,8 +762,6 @@ class AsyncDocumentsClient:
         """
         Ingest documents hosted on public URLs into a GroundX bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         documents : typing.Sequence[IngestRemoteDocument]
@@ -870,8 +854,6 @@ class AsyncDocumentsClient:
         """
         Upload documents hosted on a local file system into a GroundX bucket.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         request : DocumentLocalIngestRequest
@@ -964,8 +946,8 @@ class AsyncDocumentsClient:
     ) -> 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.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        Note1: This endpoint is currently not supported for on-prem deployments.
+        Note2: The `source_url` must include the protocol, http:// or https://.
 
         Parameters
         ----------
@@ -995,8 +977,8 @@ class AsyncDocumentsClient:
                 websites=[
                     WebsiteSource(
                         bucket_id=1234,
-                        cap=100,
-                        depth=3,
+                        cap=10,
+                        depth=2,
                         search_data={"key": "value"},
                         source_url="https://my.website.com",
                     )
@@ -1068,8 +1050,6 @@ class AsyncDocumentsClient:
         """
         lookup all documents across all resources which are currently on GroundX
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         n : typing.Optional[int]
@@ -1151,8 +1131,6 @@ class AsyncDocumentsClient:
         """
         Delete multiple documents hosted on GroundX
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         document_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
@@ -1178,7 +1156,9 @@ class AsyncDocumentsClient:
 
 
         async def main() -> None:
-            await client.documents.delete()
+            await client.documents.delete(
+                document_ids="123e4567-e89b-12d3-a456-426614174000,9f7c11a6-24b8-4d52-a9f3-90a7e70a9e49",
+            )
 
 
         asyncio.run(main())
@@ -1231,8 +1211,6 @@ class AsyncDocumentsClient:
         """
         Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions).
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         process_id : str
@@ -1319,8 +1297,6 @@ class AsyncDocumentsClient:
         """
         lookup the document(s) associated with a processId, bucketId, groupId, or projectId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         id : int
@@ -1424,8 +1400,6 @@ class AsyncDocumentsClient:
         """
         Look up an existing document by documentId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         document_id : str
@@ -1503,8 +1477,6 @@ class AsyncDocumentsClient:
         """
         Delete a single document hosted on GroundX
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         document_id : str

{groundx-2.0.29 → groundx-2.2.0}/src/groundx/groups/client.py

@@ -32,8 +32,6 @@ class GroupsClient:
         """
         list all groups within your GroundX account.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         n : typing.Optional[int]
@@ -92,8 +90,6 @@ class GroupsClient:
         """
         create a new group, a group being a collection of buckets which can be searched.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         name : str
@@ -162,8 +158,6 @@ class GroupsClient:
         """
         look up a specific group by its groupId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -233,8 +227,6 @@ class GroupsClient:
         """
         Rename a group
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -313,8 +305,6 @@ class GroupsClient:
         """
         Delete a group.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -384,8 +374,6 @@ class GroupsClient:
         """
         Add an existing bucket to an existing group. Buckets and groups can be associated many to many.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -459,8 +447,6 @@ class GroupsClient:
         """
         remove a bucket from a group. Buckets and groups can be associated many to many, this removes one bucket to group association without disturbing others.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -543,8 +529,6 @@ class AsyncGroupsClient:
         """
         list all groups within your GroundX account.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         n : typing.Optional[int]
@@ -611,8 +595,6 @@ class AsyncGroupsClient:
         """
         create a new group, a group being a collection of buckets which can be searched.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         name : str
@@ -689,8 +671,6 @@ class AsyncGroupsClient:
         """
         look up a specific group by its groupId.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -768,8 +748,6 @@ class AsyncGroupsClient:
         """
         Rename a group
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -858,8 +836,6 @@ class AsyncGroupsClient:
         """
         Delete a group.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -937,8 +913,6 @@ class AsyncGroupsClient:
         """
         Add an existing bucket to an existing group. Buckets and groups can be associated many to many.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int
@@ -1020,8 +994,6 @@ class AsyncGroupsClient:
         """
         remove a bucket from a group. Buckets and groups can be associated many to many, this removes one bucket to group association without disturbing others.
 
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
-
         Parameters
         ----------
         group_id : int

{groundx-2.0.29 → groundx-2.2.0}/src/groundx/ingest.py

@@ -58,11 +58,10 @@ def prep_documents(
         except ValueError:
             return False
 
-    idx = 0
-    remote_documents: typing.List[IngestRemoteDocument] = []
     local_documents: typing.List[
         typing.Tuple[str, typing.Tuple[typing.Union[str, None], typing.BinaryIO, str]]
     ] = []
+    remote_documents: typing.List[IngestRemoteDocument] = []
 
     for document in documents:
         if not hasattr(document, "file_path"):
@@ -123,7 +122,6 @@ def prep_documents(
                     ),
                 )
             )
-            idx += 1
         else:
             raise ValueError(f"Invalid file path: {document.file_path}")
 

{groundx-2.0.29 → groundx-2.2.0}/src/groundx/search/client.py

@@ -34,10 +34,7 @@ class SearchClient:
     ) -> SearchResponse:
         """
         Search documents on GroundX for the most relevant information to a given query.
-
-        The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
 
         Parameters
         ----------
@@ -145,10 +142,7 @@ class SearchClient:
     ) -> SearchResponse:
         """
         Search documents on GroundX for the most relevant information to a given query by documentId(s).
-
-        The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
 
         Parameters
         ----------
@@ -262,10 +256,7 @@ class AsyncSearchClient:
     ) -> SearchResponse:
         """
         Search documents on GroundX for the most relevant information to a given query.
-
-        The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
 
         Parameters
         ----------
@@ -381,10 +372,7 @@ class AsyncSearchClient:
     ) -> SearchResponse:
         """
         Search documents on GroundX for the most relevant information to a given query by documentId(s).
-
-        The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
 
         Parameters
         ----------

groundx-2.2.0/src/groundx/types/document_type.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DocumentType = typing.Union[
+    typing.Literal[
+        "bmp",
+        "csv",
+        "docx",
+        "gif",
+        "heif",
+        "hwp",
+        "ico",
+        "jpg",
+        "json",
+        "pdf",
+        "png",
+        "pptx",
+        "svg",
+        "tiff",
+        "tsv",
+        "txt",
+        "xlsx",
+        "webp",
+    ],
+    typing.Any,
+]

groundx-2.0.29/src/groundx/types/document_type.py

@@ -1,7 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-DocumentType = typing.Union[
-    typing.Literal["txt", "docx", "pptx", "xlsx", "pdf", "png", "jpg", "csv", "tsv", "json"], typing.Any
-]