groundx 3.8.1

No project description provided

GroundX Python Library

The GroundX Python library provides convenient access to the GroundX API from Python.

Documentation

API reference documentation is available here.

Installation

pip install groundx

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

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",
        )
    ],
)

Extraction Workflows

Extraction workflow helpers require the extract extra:

pip install "groundx[extract]"

Create or update an extraction workflow directly from a YAML file:

from groundx import GroundX

client = GroundX(api_key="YOUR_API_KEY")

workflow = client.create_extraction_workflow(
    path="statement.yaml",
    name="statement extraction",
)

client.update_extraction_workflow(
    workflow.workflow.workflow_id,
    path="statement.yaml",
    name="statement extraction",
)

Load an extraction definition when you need to inspect or reuse settings:

definition = client.load_extraction_definition(path="statement.yaml")
existing = client.load_extraction_definition(workflow_id="workflow-id")

If workflow_id is provided, the SDK loads from that workflow before considering YAML inputs. For create/update, pass path=... directly for the common case or pass definition=... when you already loaded one; definition takes precedence over YAML inputs.

Workflow assignment is still explicit. After creating a workflow, assign it to a bucket, group, or account with the normal workflow API.

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

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.

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 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

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.

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.

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!