GroundX Python Library

fern shield pypi

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!

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (3.9.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for eyelevelai from gravatar.com eyelevelai

License

MIT License (MIT)

Requires

Python <4.0, >=3.10

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

groundx-3.8.11.tar.gz (146.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

groundx-3.8.11-py3-none-any.whl (229.0 kB view details)

Uploaded Python 3

File details

Details for the file groundx-3.8.11.tar.gz.

File metadata

  • Download URL: groundx-3.8.11.tar.gz
  • Upload date:
  • Size: 146.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.20 Linux/6.17.0-1020-azure

File hashes

Hashes for groundx-3.8.11.tar.gz
Algorithm Hash digest
SHA256 369a081061ff7be276210e1d2d238ec170c0a1af15e9bd631abd0772d0b5ed30
MD5 c0a8c9fca53e9dbb110da52ee2b53841
BLAKE2b-256 a2807e345a839047be37b833cf3a10cd8ebaec83b5263ecc589e2b38db9e7dc1

See more details on using hashes here.

File details

Details for the file groundx-3.8.11-py3-none-any.whl.

File metadata

  • Download URL: groundx-3.8.11-py3-none-any.whl
  • Upload date:
  • Size: 229.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.20 Linux/6.17.0-1020-azure

File hashes

Hashes for groundx-3.8.11-py3-none-any.whl
Algorithm Hash digest
SHA256 23c9cdf1b97f70821379948e65b4c44cebe3ba4a17af76e36f2a8aa92655e27d
MD5 2ecfa3b3ed6663bae3ee0202d2d81ea2
BLAKE2b-256 63334592f1382ffc0905ac5247810c3a01f030702a19c18e2f438c4bd8effc79

See more details on using hashes here.

Release history Release notifications | RSS feed

3.9.1

3.9.0

This release

3.8.11

3.8.10

3.8.9

3.8.8

3.8.7

3.8.6

3.8.5

3.8.4

3.8.3

3.8.2

3.8.1

3.8.0

3.7.9

3.7.8

3.7.7

3.7.6

3.7.5

3.7.4

3.7.3

3.7.2

3.7.1

3.7.0

3.6.9

3.6.8

3.6.7

3.6.6

3.6.5 yanked

3.6.4

3.6.3

3.6.2

3.6.2a0 pre-release

3.6.1

3.6.0

3.5.61

3.5.9

3.5.8

3.5.7

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.9

3.4.8

3.4.7

3.4.6

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.3.9

3.3.8

3.3.7

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.2.9

3.2.8

3.2.7

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.9

3.1.8

3.1.7

3.1.6

3.1.5

3.1.4

3.1.3

3.1.1

3.1.0

3.0.9

3.0.8

3.0.7

3.0.6

3.0.5

3.0.4

3.0.3

3.0.1

3.0.0

2.9.92

2.9.91

2.9.9

2.9.8

2.9.7

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.48

2.8.46

2.8.45

2.8.44

2.8.43

2.8.41

2.8.40

2.8.39

2.8.38

2.8.37

2.8.36

2.8.35

2.8.34

2.8.33

2.8.32

2.8.31

2.8.30

2.8.29

2.8.28

2.8.27

2.8.26

2.8.25

2.8.24

2.8.23

2.8.22

2.8.21

2.8.20

2.8.19

2.8.18

2.8.17

2.8.16

2.8.15

2.8.14

2.8.13

2.8.12

2.8.11

2.8.10

2.8.9

2.8.8

2.8.7

2.8.6

2.8.3

2.8.2

2.8.1

2.8.0

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7.0

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.0

2.5.10

2.5.9

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.1

2.5.0

2.4.10

2.4.9

2.4.5

2.4.4

2.4.2

2.4.1

2.4.0

2.3.8

2.3.7

2.3.6

2.3.5

2.3.3

2.3.0

2.2.9

2.2.8

2.2.7

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.0

2.0.29

2.0.21

2.0.20

2.0.19

2.0.18

2.0.17

2.0.16

2.0.15

2.0.14

2.0.13

2.0.12

2.0.11

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page