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.2.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_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)
    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_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)
        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 Keys list GET /v1/apikey Get API keys
Buckets get GET /v1/bucket/{bucketId} Look up an existing bucket by its ID
Buckets list GET /v1/bucket Look up existing buckets
Buckets update PUT /v1/bucket/{bucketId} Update an existing bucket
Documents delete DELETE /v1/ingest/document/{documentId} Delete a document
Documents get GET /v1/ingest/document/{documentId} Look up an existing document by its ID
Documents get_processing_status_by_id GET /v1/ingest/{processId} Look up the processing status of documents for a given processId
Documents list GET /v1/ingest/documents Look up all existing documents
Documents lookup GET /v1/ingest/documents/{id} Look up existing documents by processId, bucketId, or projectId
Documents upload_local POST /v1/ingest/documents/local Upload local documents to GroundX
Documents upload_remote POST /v1/ingest/documents/remote Upload hosted documents to GroundX
Projects get GET /v1/project/{projectId} Look up an existing project by its ID
Projects list GET /v1/project Look up existing projects
Projects 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.2.0.tar.gz (77.4 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.2.0-py3-none-any.whl (254.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: groundx_python_sdk-1.2.0.tar.gz
  • Upload date:
  • Size: 77.4 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.2.0.tar.gz
Algorithm Hash digest
SHA256 74c37bcee4660567dbf9dc00873168e5bd4c1efe0e1099d08297b9ccb57cff4b
MD5 356a02f67ea95e7abf758536daeb8bcd
BLAKE2b-256 00f1a06b06305fa294432f20d8c6515055bb32965acebf57356825db72fdcbde

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for groundx_python_sdk-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be05a2b24a25ea8381da2f81e88469419dbf620e02cbad102fff1f1cb15cb31a
MD5 0efea6f4bdd8988aa502eb6b259b630e
BLAKE2b-256 54ddc55cc6f92cfa105798d94caf8e058c22293ad20c8c25e22f7b7118733e3e

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