Groundx

Ground Your RAG Apps in Fact not Fiction

Requirements
Installing
Getting Started
Async
Reference

Requirements

Python >=3.7

Installing

pip install groundx-python-sdk==1.3.4

Getting Started

from pprint import pprint
from groundx import Groundx, ApiException

groundx = Groundx(
    api_key="YOUR_API_KEY",
)

try:
    # Look up existing API Keys
    list_response = groundx.api_keys.list()
    pprint(list_response.body)
    pprint(list_response.body["api_keys"])
    pprint(list_response.headers)
    pprint(list_response.status)
    pprint(list_response.round_trip_time)
except ApiException as e:
    print("Exception when calling APIKeysApi.list: %s\n" % e)
    pprint(e.body)
    pprint(e.headers)
    pprint(e.status)
    pprint(e.reason)
    pprint(e.round_trip_time)

Async

async support is available by prepending a to any method.

import asyncio
from pprint import pprint
from groundx import Groundx, ApiException

groundx = Groundx(
    api_key="YOUR_API_KEY",
)


async def main():
    try:
        # Look up existing API Keys
        list_response = await groundx.api_keys.alist()
        pprint(list_response.body)
        pprint(list_response.body["api_keys"])
        pprint(list_response.headers)
        pprint(list_response.status)
        pprint(list_response.round_trip_time)
    except ApiException as e:
        print("Exception when calling APIKeysApi.list: %s\n" % e)
        pprint(e.body)
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)


asyncio.run(main())

Reference

`groundx.api_keys.list`

Retrieve the API keys for your account.

🛠️ Usage

list_response = groundx.api_keys.list()

🔄 Return

ApiKeyManagementListResponse

🌐 Endpoint

/v1/apikey get

🔙 Back to Table of Contents

`groundx.buckets.get`

Look up a bucket by its bucketId.

🛠️ Usage

get_response = groundx.buckets.get(
    bucket_id=1,
)

⚙️ Parameters

bucket_id: `int`

The ID of the bucket to retrieve.

🔄 Return

BucketResponse

🌐 Endpoint

/v1/bucket/{bucketId} get

🔙 Back to Table of Contents

`groundx.buckets.list`

Look up existing buckets associated with your account.

🛠️ Usage

list_response = groundx.buckets.list()

🔄 Return

BucketListResponse

🌐 Endpoint

/v1/bucket get

🔙 Back to Table of Contents

`groundx.buckets.update`

Update the configurations of an existing bucket.

🛠️ Usage

update_response = groundx.buckets.update(
    bucket={
        "name": "your_bucket_name",
    },
    bucket_id=1,
)

⚙️ Parameters

bucket: `BucketUpdateRequestBucket`

bucket_id: `int`

The ID of the bucket to update.

⚙️ Request Body

BucketUpdateRequest

🔄 Return

BucketUpdateResponse

🌐 Endpoint

/v1/bucket/{bucketId} put

🔙 Back to Table of Contents

`groundx.documents.crawl_website`

Crawl and ingest a website into GroundX

🛠️ Usage

crawl_website_response = groundx.documents.crawl_website(
    project=None,
)

⚙️ Parameters

project: `WebsiteRequest`

⚙️ Request Body

WebsiteCrawlRequest

🔄 Return

IngestResponse

🌐 Endpoint

/v1/ingest/documents/website post

🔙 Back to Table of Contents

`groundx.documents.delete`

Delete one or more documents from GroundX

🛠️ Usage

delete_response = groundx.documents.delete(
    documents=[
        {
            "document_id": "document_id_example",
        }
    ],
)

⚙️ Parameters

documents: `DocumentsDeleteRequestDocuments`

⚙️ Request Body

DocumentsDeleteRequest

🔄 Return

IngestResponse

🌐 Endpoint

/v1/ingest/documents delete

🔙 Back to Table of Contents

`groundx.documents.delete_0`

Delete a document

🛠️ Usage

delete_0_response = groundx.documents.delete_0(
    document_id="documentId_example",
)

⚙️ Parameters

document_id: `str`

🔄 Return

IngestResponse

🌐 Endpoint

/v1/ingest/document/{documentId} delete

🔙 Back to Table of Contents

`groundx.documents.get`

Look up an existing document by its ID

🛠️ Usage

get_response = groundx.documents.get(
    document_id="documentId_example",
)

⚙️ Parameters

document_id: `str`

🔄 Return

DocumentResponse

🌐 Endpoint

/v1/ingest/document/{documentId} get

🔙 Back to Table of Contents

`groundx.documents.get_processing_status_by_id`

Look up the processing status of documents for a given processId

🛠️ Usage

get_processing_status_by_id_response = groundx.documents.get_processing_status_by_id(
    process_id="processId_example",
)

⚙️ Parameters

process_id: `str`

🔄 Return

ProcessStatusResponse

🌐 Endpoint

/v1/ingest/{processId} get

🔙 Back to Table of Contents

`groundx.documents.list`

Look up all existing documents

🛠️ Usage

list_response = groundx.documents.list(
    n=1,
    next_token="string_example",
)

⚙️ Parameters

n: `int`

next_token: `str`

🔄 Return

DocumentListResponse

🌐 Endpoint

/v1/ingest/documents get

🔙 Back to Table of Contents

`groundx.documents.lookup`

Look up existing documents by processId, bucketId, or projectId

🛠️ Usage

lookup_response = groundx.documents.lookup(
    id=1,
    n=1,
    next_token="string_example",
)

⚙️ Parameters

id: `int`

n: `int`

next_token: `str`

🔄 Return

DocumentLookupResponse

🌐 Endpoint

/v1/ingest/documents/{id} get

🔙 Back to Table of Contents

`groundx.documents.upload_local`

Upload local documents to GroundX

🛠️ Usage

upload_local_response = groundx.documents.upload_local(
    body=[
        {
            "blob": open("/path/to/file", "rb"),
            "metadata": {
                "bucket_id": 1234,
                "callback_data": "my_callback_data",
                "callback_url": "https://my.callback.url.com",
                "file_name": "my_file.txt",
                "file_type": "txt",
            },
        }
    ],
)

⚙️ Request Body

DocumentLocalUploadRequest

🔄 Return

IngestResponse

🌐 Endpoint

/v1/ingest/documents/local post

🔙 Back to Table of Contents

`groundx.documents.upload_remote`

Upload hosted documents to GroundX

🛠️ Usage

upload_remote_response = groundx.documents.upload_remote(
    documents=[
        {
            "bucket_id": 1234,
            "callback_data": "my_callback_data",
            "callback_url": "https://my.callback.url.com",
            "file_name": "my_file.txt",
            "file_type": "txt",
            "source_url": "https://my.source.url.com/file.txt",
        }
    ],
)

⚙️ Parameters

documents: `DocumentRemoteUploadRequestDocuments`

⚙️ Request Body

DocumentRemoteUploadRequest

🔄 Return

IngestResponse

🌐 Endpoint

/v1/ingest/documents/remote post

🔙 Back to Table of Contents

`groundx.projects.get`

This endpoint allows you to retrieve a specific project by projectId.

🛠️ Usage

get_response = groundx.projects.get(
    project_id="projectId_example",
)

⚙️ Parameters

project_id: `str`

The ID of the project to retrieve.

🔄 Return

ProjectResponse

🌐 Endpoint

/v1/project/{projectId} get

🔙 Back to Table of Contents

`groundx.projects.list`

This endpoint allows you to retrieve your existing projects.

🛠️ Usage

list_response = groundx.projects.list()

🔄 Return

ProjectListResponse

🌐 Endpoint

/v1/project get

🔙 Back to Table of Contents

`groundx.projects.update`

This endpoint allows you to update an existing project.

🛠️ Usage

update_response = groundx.projects.update(
    project={
        "name": "your_project_name",
    },
    project_id="projectId_example",
)

⚙️ Parameters

project: `ProjectUpdateRequestProject`

project_id: `str`

The ID of the project to update.

⚙️ Request Body

ProjectUpdateRequest

🔄 Return

ProjectResponse

🌐 Endpoint

/v1/project/{projectId} put

🔙 Back to Table of Contents

`groundx.search.content`

Search and retrieve relevant content from a project or bucket by id.

🛠️ Usage

content_response = groundx.search.content(
    search={
        "query": "my search query",
        "next_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    },
    id=1,
    n=20,
)

⚙️ Parameters

search: `SearchRequestSearch`

id: `int`

The ID of the project or bucket to search within.

n: `int`

Number of results

⚙️ Request Body

SearchRequest

🔄 Return

SearchResponse

🌐 Endpoint

/v1/search/{id} post

🔙 Back to Table of Contents

Author

This Python package is automatically generated by Konfig

Download files

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

Source Distribution

groundx_python_sdk-1.3.4.tar.gz (82.4 kB view details)

Uploaded Nov 29, 2023 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

groundx_python_sdk-1.3.4-py3-none-any.whl (276.5 kB view details)

Uploaded Nov 29, 2023 Python 3

File details

Details for the file groundx_python_sdk-1.3.4.tar.gz.

File metadata

Download URL: groundx_python_sdk-1.3.4.tar.gz
Upload date: Nov 29, 2023
Size: 82.4 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for groundx_python_sdk-1.3.4.tar.gz
Algorithm	Hash digest
SHA256	`b787a18508474e78e5da38b828234839efa13f02a248a19d2262b5f32502dadc`
MD5	`8a5cd791558625cb92f3e827eda34872`
BLAKE2b-256	`73d757fdf5bef50333ee9fa99da74b034cd3968f958f273c2f908f38a98caaee`

See more details on using hashes here.

File details

Details for the file groundx_python_sdk-1.3.4-py3-none-any.whl.

File metadata

Download URL: groundx_python_sdk-1.3.4-py3-none-any.whl
Upload date: Nov 29, 2023
Size: 276.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for groundx_python_sdk-1.3.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`f08e93a8274e9461e01a5858c0654dd2284e2192eebd28ce50d96090b244d780`
MD5	`c17f9fd8a0191cfd492ca515233486d4`
BLAKE2b-256	`f9864a1e05255f8f12f67293ed9aee783a58d4350bcfd1eccbbe15d1f1ba0d1c`

See more details on using hashes here.

Release history Release notifications | RSS feed

1.3.30

Jan 17, 2025

1.3.29

Nov 1, 2024

1.3.28

Oct 15, 2024

1.3.27

Oct 5, 2024

1.3.26

Oct 3, 2024

1.3.25

Oct 2, 2024

1.3.24

Oct 2, 2024

1.3.23

Aug 2, 2024

1.3.22

Jul 31, 2024

1.3.21

Jul 25, 2024

1.3.20

Jul 25, 2024

1.3.19

Jul 16, 2024

1.3.18

Jun 30, 2024

1.3.17

Jun 29, 2024

1.3.16

Jun 10, 2024

1.3.15

Jun 4, 2024

1.3.14

Feb 1, 2024

1.3.13

Jan 18, 2024

1.3.12

Dec 31, 2023

1.3.11

Dec 5, 2023

1.3.10

Dec 2, 2023

1.3.9

Dec 2, 2023

1.3.8

Dec 1, 2023

1.3.7

Nov 30, 2023

1.3.6

Nov 29, 2023

1.3.5

Nov 29, 2023

This release

1.3.4

Nov 29, 2023

1.3.3

Nov 9, 2023

1.3.2

Oct 13, 2023

1.3.1

Oct 9, 2023

1.3.0

Oct 9, 2023

1.2.0

Oct 5, 2023

1.1.0

Oct 5, 2023

1.0.0

Oct 5, 2023

groundx-python-sdk 1.3.4

Groundx

Table of Contents

Requirements

Installing

Getting Started

Async

Reference

groundx.api_keys.list

🛠️ Usage

🔄 Return

🌐 Endpoint

groundx.buckets.get

🛠️ Usage

⚙️ Parameters

bucket_id: int

🔄 Return

🌐 Endpoint

groundx.buckets.list

🛠️ Usage

🔄 Return

🌐 Endpoint

groundx.buckets.update

🛠️ Usage

⚙️ Parameters

bucket: BucketUpdateRequestBucket

bucket_id: int

⚙️ Request Body

🔄 Return

🌐 Endpoint

groundx.documents.crawl_website

🛠️ Usage

⚙️ Parameters

project: WebsiteRequest

⚙️ Request Body

🔄 Return

🌐 Endpoint

groundx.documents.delete

🛠️ Usage

⚙️ Parameters

documents: DocumentsDeleteRequestDocuments

⚙️ Request Body

🔄 Return

🌐 Endpoint

groundx.documents.delete_0

🛠️ Usage

⚙️ Parameters

document_id: str

🔄 Return

🌐 Endpoint

groundx.documents.get

🛠️ Usage

⚙️ Parameters

document_id: str

🔄 Return

🌐 Endpoint

groundx.documents.get_processing_status_by_id

🛠️ Usage

⚙️ Parameters

process_id: str

🔄 Return

🌐 Endpoint

groundx.documents.list

🛠️ Usage

⚙️ Parameters

n: int

next_token: str

🔄 Return

🌐 Endpoint

groundx.documents.lookup

🛠️ Usage

⚙️ Parameters

id: int

n: int

next_token: str

🔄 Return

🌐 Endpoint

groundx.documents.upload_local

🛠️ Usage

⚙️ Request Body

`groundx.api_keys.list`

`groundx.buckets.get`

bucket_id: `int`

`groundx.buckets.list`

`groundx.buckets.update`

bucket: `BucketUpdateRequestBucket`

bucket_id: `int`

`groundx.documents.crawl_website`

project: `WebsiteRequest`

`groundx.documents.delete`

documents: `DocumentsDeleteRequestDocuments`

`groundx.documents.delete_0`

document_id: `str`

`groundx.documents.get`

document_id: `str`

`groundx.documents.get_processing_status_by_id`

process_id: `str`

`groundx.documents.list`

n: `int`

next_token: `str`

`groundx.documents.lookup`

id: `int`

n: `int`

next_token: `str`

`groundx.documents.upload_local`

`groundx.documents.upload_remote`

documents: `DocumentRemoteUploadRequestDocuments`

`groundx.projects.get`

project_id: `str`

`groundx.projects.list`

`groundx.projects.update`

project: `ProjectUpdateRequestProject`

project_id: `str`

`groundx.search.content`

search: `SearchRequestSearch`

id: `int`

n: `int`