groundx 2.1.0__tar.gz → 2.2.1__tar.gz

{groundx-2.1.0 → groundx-2.2.1}/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.1.0 → groundx-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.1.0
+Version: 2.2.1
 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.1.0 → groundx-2.2.1}/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.1.0 → groundx-2.2.1}/pyproject.toml

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

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

{groundx-2.1.0 → groundx-2.2.1}/src/groundx/core/http_client.py

@@ -85,8 +85,8 @@ def _retry_timeout(response: httpx.Response, retries: int) -> float:
 
 
 def _should_retry(response: httpx.Response) -> bool:
-    retriable_400s = [429, 408, 409]
-    return response.status_code >= 500 or response.status_code in retriable_400s
+    retryable_400s = [429, 408, 409]
+    return response.status_code >= 500 or response.status_code in retryable_400s
 
 
 def remove_omit_from_dict(

{groundx-2.1.0 → groundx-2.2.1}/src/groundx/core/pydantic_utilities.py

@@ -79,7 +79,7 @@ def to_jsonable_with_fallback(
 class UniversalBaseModel(pydantic.BaseModel):
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
-            # Allow fields begining with `model_` to be used in the model
+            # Allow fields beginning with `model_` to be used in the model
             protected_namespaces=(),
         )  # type: ignore # Pydantic v2
 
@@ -128,7 +128,7 @@ class UniversalBaseModel(pydantic.BaseModel):
         Override the default dict method to `exclude_unset` by default. This function patches
         `exclude_unset` to work include fields within non-None default values.
         """
-        # Note: the logic here is multi-plexed given the levers exposed in Pydantic V1 vs V2
+        # Note: the logic here is multiplexed given the levers exposed in Pydantic V1 vs V2
         # Pydantic V1's .dict can be extremely slow, so we do not want to call it twice.
         #
         # We'd ideally do the same for Pydantic V2, but it shells out to a library to serialize models

{groundx-2.1.0 → groundx-2.2.1}/src/groundx/documents/client.py

@@ -204,6 +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.
+        Note1: This endpoint is currently not supported for on-prem deployments.
+        Note2: The `source_url` must include the protocol, http:// or https://.
 
         Parameters
         ----------
@@ -746,6 +748,84 @@ class DocumentsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def document_get_processing_status(
+        self,
+        *,
+        n: typing.Optional[int] = None,
+        status: typing.Optional[ProcessingStatus] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DocumentResponse:
+        """
+        Get the current status of ingest processes, sorted from most recent to least.
+
+        Parameters
+        ----------
+        n : typing.Optional[int]
+            The maximum number of returned processes. Accepts 1-100 with a default of 20.
+
+        status : typing.Optional[ProcessingStatus]
+            A status filter on the processing status. If this value is set, then only processes with this status will be returned in the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DocumentResponse
+            Look up success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.documents.document_get_processing_status()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/ingest",
+            method="GET",
+            params={
+                "n": n,
+                "status": status,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    DocumentResponse,
+                    parse_obj_as(
+                        type_=DocumentResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
 
 class AsyncDocumentsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -944,6 +1024,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.
+        Note1: This endpoint is currently not supported for on-prem deployments.
+        Note2: The `source_url` must include the protocol, http:// or https://.
 
         Parameters
         ----------
@@ -1543,3 +1625,89 @@ class AsyncDocumentsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def document_get_processing_status(
+        self,
+        *,
+        n: typing.Optional[int] = None,
+        status: typing.Optional[ProcessingStatus] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DocumentResponse:
+        """
+        Get the current status of ingest processes, sorted from most recent to least.
+
+        Parameters
+        ----------
+        n : typing.Optional[int]
+            The maximum number of returned processes. Accepts 1-100 with a default of 20.
+
+        status : typing.Optional[ProcessingStatus]
+            A status filter on the processing status. If this value is set, then only processes with this status will be returned in the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DocumentResponse
+            Look up success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.documents.document_get_processing_status()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/ingest",
+            method="GET",
+            params={
+                "n": n,
+                "status": status,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    DocumentResponse,
+                    parse_obj_as(
+                        type_=DocumentResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

groundx-2.2.1/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.2.1/src/groundx/types/processing_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ProcessingStatus = typing.Union[
+    typing.Literal["queued", "processing", "error", "complete", "cancelled", "active", "inactive"], typing.Any
+]

groundx-2.1.0/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
-]

groundx-2.1.0/src/groundx/types/processing_status.py

@@ -1,5 +0,0 @@
-# This file was auto-generated by Fern from our API Definition.
-
-import typing
-
-ProcessingStatus = typing.Union[typing.Literal["queued", "processing", "error", "complete", "cancelled"], typing.Any]