Skip to main content

groundx-python-sdk

PyPI

Ground Your RAG Apps in Fact not Fiction

Requirements

Python >=3.7

Installing

pip install groundx-python-sdk==1.1.0

Getting Started

from pprint import pprint
from groundx import Groundx, ApiException

groundx = Groundx(
    api_key="YOUR_API_KEY",
)

try:
    # Get API keys
    list_response = groundx.api_key_management.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 APIKeyManagementApi.list: %s\n" % e)
    pprint(e.body)
    if e.status == 405:
        pprint(e.body["message"])
    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:
        # Get API keys
        list_response = await groundx.api_key_management.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 APIKeyManagementApi.list: %s\n" % e)
        pprint(e.body)
        if e.status == 405:
            pprint(e.body["message"])
        pprint(e.headers)
        pprint(e.status)
        pprint(e.reason)
        pprint(e.round_trip_time)


asyncio.run(main())

Documentation for API Endpoints

All URIs are relative to https://api.groundx.ai/api

Tag Method HTTP request Description
API Key Management list GET /v1/apikey Get API keys
Bucket create POST /v1/bucket Create a bucket
Bucket delete DELETE /v1/bucket/{bucketId} Delete an existing bucket
Bucket get GET /v1/bucket/{bucketId} Look up an existing bucket
Bucket list GET /v1/bucket Look up existing buckets
Bucket update PUT /v1/bucket/{bucketId} Update an existing bucket
Document delete DELETE /v1/ingest/document/{documentId} Delete documents
Document get GET /v1/ingest/document/{documentId} Look up an existing document
Document get_processing_status_by_id GET /v1/ingest/{processId} Look up document processing status by processId
Document list GET /v1/ingest/documents Look up all existing documents
Document lookup GET /v1/ingest/documents/{id} Look up existing documents by processId, bucketId, or projectId
Document upload_local POST /v1/ingest/documents/local Upload local documents to GroundX
Document upload_remote POST /v1/ingest/documents/remote Upload hosted documents to GroundX
Preprocessor delete DELETE /v1/preprocess Delete Custom Pre-Processor
Preprocessor list GET /v1/preprocess Query pre-processors
Preprocessor setup POST /v1/preprocess Setup Custom Pre-Processor
Project bind_bucket POST /v1/project/{projectId} Add an existing bucket to a project
Project create POST /v1/project Create a project
Project delete DELETE /v1/project/{projectId} Delete an existing project
Project get GET /v1/project/{projectId} Look up an existing project
Project list GET /v1/project Look up existing projects
Project update PUT /v1/project/{projectId} Update an existing project
Search content POST /v1/search/{id} Perform a search query of your content

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.1.0.tar.gz (90.1 kB view details)

Uploaded Source

Built Distribution

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

groundx_python_sdk-1.1.0-py3-none-any.whl (344.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: groundx_python_sdk-1.1.0.tar.gz
  • Upload date:
  • Size: 90.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for groundx_python_sdk-1.1.0.tar.gz
Algorithm Hash digest
SHA256 7b2ec6e0279bc23c60d5143f0ef7f7c4092589f1303a43a9907ea589b7668a32
MD5 086db1559710a21352ea1496cb4bdaf7
BLAKE2b-256 7c7a0a6da502f1cef0fb10057fd97fe44faf4a3e0125cc4679027c20610edf93

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for groundx_python_sdk-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f61a69c21e53be8e407ac5cf1b103cb6688cf9f1b7e9116545b62aa881010339
MD5 3135dcf5ce65aa0b8ab75bc631a77125
BLAKE2b-256 5685d196aeb84f9917a88fc5e5d0f750034b12b5c2778f98109d6693ffe186a2

See more details on using hashes here.

Supported by

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