Requirements
Python >=3.7
Installing
pip install groundx-python-sdk==1.3.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
2 maintainers
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.0.tar.gz
(76.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file groundx_python_sdk-1.3.0.tar.gz.
File metadata
- Download URL: groundx_python_sdk-1.3.0.tar.gz
- Upload date:
- Size: 76.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
70e4a2011eed9ac8aa83f22f6a2b01e197a732291472adff25c72cca0d97a53a
|
|
| MD5 |
362ff68b8fa20c939c3b1b4fc2cb3e8b
|
|
| BLAKE2b-256 |
c7ec6f8153bbeed719ad9cbd91fccf1bf8b67576e8c3ab88a559b184e91e0c06
|
File details
Details for the file groundx_python_sdk-1.3.0-py3-none-any.whl.
File metadata
- Download URL: groundx_python_sdk-1.3.0-py3-none-any.whl
- Upload date:
- Size: 245.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.7.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f1deec39a2aee98adc3f4d8861256c4d085c060c9b112726b09ff0dacef3a1f
|
|
| MD5 |
e8156250a26e9dfb137a01c11c85452e
|
|
| BLAKE2b-256 |
910c0ad836ffdbaa82b122fdbc34b1d167377f9550ad7f6c3aa7ad0415c313af
|
