Requirements
Python >=3.7
Installing
pip install groundx-python-sdk==1.3.1
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.3.1.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.1.tar.gz.
File metadata
- Download URL: groundx_python_sdk-1.3.1.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 |
83bdadd63a8d5ae9a239cd374ec94da57ae9389acc1b4b2ef211d466de7c2b77
|
|
| MD5 |
17eac2d6ba5ce8dfd70e1af2f07bd3f2
|
|
| BLAKE2b-256 |
1e67bdaa134be22c7658d0c6909f8fa14a4ee10ab5c2608f33c9f37b57e5ab3f
|
File details
Details for the file groundx_python_sdk-1.3.1-py3-none-any.whl.
File metadata
- Download URL: groundx_python_sdk-1.3.1-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 |
37afd7fe8b6167d8ad829281bb25403e37cad3f4c9cc1aaaa24253f375eea4c0
|
|
| MD5 |
2dc0c839425c19b3ab73bb1784db230c
|
|
| BLAKE2b-256 |
7ea9b6e996ffa4b84a4a2cf3d0fd88f9c23a6cbe76509de7275b4b93f7fe3a8e
|