groundx 2.9.2__tar.gz

groundx-2.9.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

groundx-2.9.2/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.1
+Name: groundx
+Version: 2.9.2
+Summary: 
+License: MIT
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.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: boto3 ; extra == "extract"
+Requires-Dist: celery ; extra == "extract"
+Requires-Dist: celery-types ; extra == "extract"
+Requires-Dist: dateparser ; extra == "extract"
+Requires-Dist: fastapi ; extra == "extract"
+Requires-Dist: google-api-python-client ; extra == "extract"
+Requires-Dist: google-api-python-client-stubs ; extra == "extract"
+Requires-Dist: google-auth-stubs ; extra == "extract"
+Requires-Dist: gspread ; extra == "extract"
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: minio ; extra == "extract"
+Requires-Dist: pillow ; extra == "extract"
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: pytest ; extra == "extract"
+Requires-Dist: redis ; extra == "extract"
+Requires-Dist: requests (>=2.4.0)
+Requires-Dist: tqdm (>=4.60.0)
+Requires-Dist: types-PyYAML ; extra == "extract"
+Requires-Dist: types-boto3 ; extra == "extract"
+Requires-Dist: types-dateparser ; extra == "extract"
+Requires-Dist: types-tqdm (>=4.60.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# GroundX Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Feyelevelai%2Fgroundx-python)
+[![pypi](https://img.shields.io/pypi/v/groundx)](https://pypi.python.org/pypi/groundx)
+
+The GroundX Python library provides convenient access to the GroundX API from Python.
+
+## Documentation
+
+API reference documentation is available [here](https://docs.eyelevel.ai/reference).
+
+## Installation
+
+```sh
+pip install groundx
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/eyelevelai/groundx-python/blob/main/reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from groundx import Document, GroundX
+
+client = GroundX(
+    api_key="YOUR_API_KEY",
+)
+
+client.ingest(
+    documents=[
+        Document(
+            bucket_id=1234,
+            file_name="my_file1.txt",
+            file_type="txt",
+            source_url="https://my.source.url.com/file1.txt",
+        )
+    ],
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from groundx import AsyncGroundX, Document
+
+client = AsyncGroundX(
+    api_key="YOUR_API_KEY",
+)
+
+async def main() -> None:
+    await client.ingest(
+        documents=[
+            Document(
+                bucket_id=1234,
+                file_name="my_file1.txt",
+                file_type="txt",
+                source_url="https://my.source.url.com/file1.txt",
+            )
+        ],
+    )
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from groundx.core.api_error import ApiError
+
+try:
+    client.ingest(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.ingest(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.ingest(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

groundx-2.9.2/README.md

@@ -0,0 +1,155 @@
+# GroundX Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Feyelevelai%2Fgroundx-python)
+[![pypi](https://img.shields.io/pypi/v/groundx)](https://pypi.python.org/pypi/groundx)
+
+The GroundX Python library provides convenient access to the GroundX API from Python.
+
+## Documentation
+
+API reference documentation is available [here](https://docs.eyelevel.ai/reference).
+
+## Installation
+
+```sh
+pip install groundx
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/eyelevelai/groundx-python/blob/main/reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from groundx import Document, GroundX
+
+client = GroundX(
+    api_key="YOUR_API_KEY",
+)
+
+client.ingest(
+    documents=[
+        Document(
+            bucket_id=1234,
+            file_name="my_file1.txt",
+            file_type="txt",
+            source_url="https://my.source.url.com/file1.txt",
+        )
+    ],
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from groundx import AsyncGroundX, Document
+
+client = AsyncGroundX(
+    api_key="YOUR_API_KEY",
+)
+
+async def main() -> None:
+    await client.ingest(
+        documents=[
+            Document(
+                bucket_id=1234,
+                file_name="my_file1.txt",
+                file_type="txt",
+                source_url="https://my.source.url.com/file1.txt",
+            )
+        ],
+    )
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from groundx.core.api_error import ApiError
+
+try:
+    client.ingest(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.ingest(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.ingest(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

groundx-2.9.2/pyproject.toml

@@ -0,0 +1,149 @@
+[project]
+name = "groundx"
+
+[tool.poetry]
+name = "groundx"
+version = "2.9.2"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+license = "MIT"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+    "License :: OSI Approved :: MIT License"
+]
+packages = [
+    { include = "groundx", from = "src"}
+]
+
+[project.urls]
+Repository = 'https://github.com/eyelevelai/groundx-python'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+aiohttp = ">=3.8.0"
+boto3 = { version = "*", optional = true}
+celery = { version = "*", optional = true}
+celery-types = { version = "*", optional = true}
+dateparser = { version = "*", optional = true}
+fastapi = { version = "*", optional = true}
+google-api-python-client = { version = "*", optional = true}
+google-api-python-client-stubs = { version = "*", optional = true}
+google-auth-stubs = { version = "*", optional = true}
+gspread = { version = "*", optional = true}
+httpx = ">=0.21.2"
+minio = { version = "*", optional = true}
+pillow = { version = "*", optional = true}
+pydantic = ">= 1.9.2"
+pydantic-core = "^2.18.2"
+pytest = { version = "*", optional = true}
+redis = { version = "*", optional = true}
+requests = ">=2.4.0"
+tqdm = ">=4.60.0"
+types-PyYAML = { version = "*", optional = true}
+types-boto3 = { version = "*", optional = true}
+types-dateparser = { version = "*", optional = true}
+types-tqdm = ">=4.60.0"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "==0.11.5"
+types-requests = ">=2.0.0"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.extras]
+extract=["boto3", "celery", "celery-types", "dateparser", "fastapi", "google-api-python-client", "google-api-python-client-stubs", "google-auth-stubs", "gspread", "minio", "pillow", "pytest", "redis", "types-boto3", "types-dateparser", "types-PyYAML"]
+
+[[tool.mypy.overrides]]
+module = ["dateparser.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["boto3.*", "botocore.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["fastapi.*", "starlette.*", "redis.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["google.*", "googleapiclient.*", "gspread.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["minio.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["PIL.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["smolagents.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["yaml.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["groundx.extract.classes.document"]
+disable_error_code = ["call-arg"]
+
+[[tool.mypy.overrides]]
+module = ["groundx.extract.tasks.utility"]
+disable_error_code = ["call-arg"]

groundx-2.9.2/src/groundx/__init__.py

@@ -0,0 +1,161 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import (
+    BoundingBoxDetail,
+    BucketDetail,
+    BucketListResponse,
+    BucketResponse,
+    BucketUpdateDetail,
+    BucketUpdateResponse,
+    CustomerDetail,
+    CustomerResponse,
+    Document,
+    DocumentDetail,
+    DocumentListResponse,
+    DocumentLocalIngestRequest,
+    DocumentLookupResponse,
+    DocumentResponse,
+    DocumentType,
+    GroupDetail,
+    GroupListResponse,
+    GroupResponse,
+    HealthResponse,
+    HealthResponseHealth,
+    HealthService,
+    HealthServiceStatus,
+    IngestLocalDocument,
+    IngestLocalDocumentMetadata,
+    IngestRemoteDocument,
+    IngestResponse,
+    IngestStatus,
+    IngestStatusLight,
+    IngestStatusProgress,
+    IngestStatusProgressCancelled,
+    IngestStatusProgressComplete,
+    IngestStatusProgressErrors,
+    IngestStatusProgressProcessing,
+    MessageResponse,
+    MeterDetail,
+    ProcessLevel,
+    ProcessesStatusResponse,
+    ProcessingStatus,
+    SearchResponse,
+    SearchResponseSearch,
+    SearchResultItem,
+    SearchResultItemPagesItem,
+    Sort,
+    SortOrder,
+    SubscriptionDetail,
+    SubscriptionDetailMeters,
+    WebsiteSource,
+    WorkflowApplyRequest,
+    WorkflowDetail,
+    WorkflowDetailChunkStrategy,
+    WorkflowDetailRelationships,
+    WorkflowEngine,
+    WorkflowEngineReasoningEffort,
+    WorkflowEngineService,
+    WorkflowPrompt,
+    WorkflowPromptGroup,
+    WorkflowPromptRole,
+    WorkflowRequest,
+    WorkflowRequestChunkStrategy,
+    WorkflowResponse,
+    WorkflowStep,
+    WorkflowStepConfig,
+    WorkflowStepConfigField,
+    WorkflowSteps,
+    WorkflowsResponse,
+)
+from .errors import BadRequestError, UnauthorizedError
+from . import buckets, customer, documents, groups, health, search, workflows
+from .environment import GroundXEnvironment
+from .ingest import AsyncGroundX, GroundX
+from .search import SearchContentRequestId
+from .version import __version__
+from .workflows import WorkflowsGetRequestId
+
+__all__ = [
+    "AsyncGroundX",
+    "BadRequestError",
+    "BoundingBoxDetail",
+    "BucketDetail",
+    "BucketListResponse",
+    "BucketResponse",
+    "BucketUpdateDetail",
+    "BucketUpdateResponse",
+    "CustomerDetail",
+    "CustomerResponse",
+    "Document",
+    "DocumentDetail",
+    "DocumentListResponse",
+    "DocumentLocalIngestRequest",
+    "DocumentLookupResponse",
+    "DocumentResponse",
+    "DocumentType",
+    "GroundX",
+    "GroundXEnvironment",
+    "GroupDetail",
+    "GroupListResponse",
+    "GroupResponse",
+    "HealthResponse",
+    "HealthResponseHealth",
+    "HealthService",
+    "HealthServiceStatus",
+    "IngestLocalDocument",
+    "IngestLocalDocumentMetadata",
+    "IngestRemoteDocument",
+    "IngestResponse",
+    "IngestStatus",
+    "IngestStatusLight",
+    "IngestStatusProgress",
+    "IngestStatusProgressCancelled",
+    "IngestStatusProgressComplete",
+    "IngestStatusProgressErrors",
+    "IngestStatusProgressProcessing",
+    "MessageResponse",
+    "MeterDetail",
+    "ProcessLevel",
+    "ProcessesStatusResponse",
+    "ProcessingStatus",
+    "SearchContentRequestId",
+    "SearchResponse",
+    "SearchResponseSearch",
+    "SearchResultItem",
+    "SearchResultItemPagesItem",
+    "Sort",
+    "SortOrder",
+    "SubscriptionDetail",
+    "SubscriptionDetailMeters",
+    "UnauthorizedError",
+    "WebsiteSource",
+    "WorkflowApplyRequest",
+    "WorkflowDetail",
+    "WorkflowDetailChunkStrategy",
+    "WorkflowDetailRelationships",
+    "WorkflowEngine",
+    "WorkflowEngineReasoningEffort",
+    "WorkflowEngineService",
+    "WorkflowPrompt",
+    "WorkflowPromptGroup",
+    "WorkflowPromptRole",
+    "WorkflowRequest",
+    "WorkflowRequestChunkStrategy",
+    "WorkflowResponse",
+    "WorkflowStep",
+    "WorkflowStepConfig",
+    "WorkflowStepConfigField",
+    "WorkflowSteps",
+    "WorkflowsGetRequestId",
+    "WorkflowsResponse",
+    "__version__",
+    "buckets",
+    "customer",
+    "documents",
+    "groups",
+    "health",
+    "search",
+    "workflows",
+]

groundx-2.9.2/src/groundx/buckets/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+