Client for GroundX API
Project description
Table of Contents
- Requirements
- Installing
- Getting Started
- Async
- Reference
groundx.buckets.creategroundx.buckets.deletegroundx.buckets.getgroundx.buckets.listgroundx.buckets.updategroundx.documents.crawl_websitegroundx.documents.deletegroundx.documents.delete_0groundx.documents.getgroundx.documents.get_processing_status_by_idgroundx.documents.listgroundx.documents.lookupgroundx.documents.upload_localgroundx.documents.upload_remotegroundx.projects.add_bucketgroundx.projects.creategroundx.projects.deletegroundx.projects.getgroundx.projects.listgroundx.projects.remove_bucketgroundx.projects.updategroundx.search.content
Requirements
Python >=3.7
Installing
pip install groundx-python-sdk==1.3.6
Getting Started
from pprint import pprint
from groundx import Groundx, ApiException
groundx = Groundx(
api_key="YOUR_API_KEY",
)
try:
# Create a new bucket
create_response = groundx.buckets.create(
name="your_bucket_name",
)
pprint(create_response.body)
pprint(create_response.body["bucket"])
pprint(create_response.headers)
pprint(create_response.status)
pprint(create_response.round_trip_time)
except ApiException as e:
print("Exception when calling BucketsApi.create: %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:
# Create a new bucket
create_response = await groundx.buckets.acreate(
name="your_bucket_name",
)
pprint(create_response.body)
pprint(create_response.body["bucket"])
pprint(create_response.headers)
pprint(create_response.status)
pprint(create_response.round_trip_time)
except ApiException as e:
print("Exception when calling BucketsApi.create: %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.buckets.create
This endpoint allows you to create a new bucket.
๐ ๏ธ Usage
create_response = groundx.buckets.create(
name="your_bucket_name",
)
โ๏ธ Parameters
name: str
โ๏ธ Request Body
๐ Return
๐ Endpoint
/v1/bucket post
๐ Back to Table of Contents
groundx.buckets.delete
Delete a bucket
๐ ๏ธ Usage
delete_response = groundx.buckets.delete(
bucket_id=1,
)
โ๏ธ Parameters
bucket_id: int
๐ Return
๐ Endpoint
/v1/bucket/{bucketId} delete
๐ 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
๐ 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(
n=1,
next_token="string_example",
)
โ๏ธ Parameters
n: int
next_token: str
๐ Return
๐ 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(
new_name="your_bucket_name",
bucket_id=1,
)
โ๏ธ Parameters
new_name: str
bucket_id: int
The ID of the bucket to update.
โ๏ธ Request Body
๐ Return
๐ 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(
websites=[
{
"bucket_id": 123,
"cap": 100,
"depth": 3,
"source_url": "https://my.website.com",
}
],
)
โ๏ธ Parameters
websites: WebsiteCrawlRequestWebsites
โ๏ธ Request Body
๐ Return
๐ 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(
document_ids=["documentIds_example"],
)
โ๏ธ Parameters
document_ids: List[str]
A comma delimited list of document IDs
๐ Return
๐ 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
๐ 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
๐ 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
๐ 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
๐ 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
๐ 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,
"file_name": "my_file.txt",
"file_type": "txt",
},
}
],
)
โ๏ธ Request Body
๐ Return
๐ 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,
"file_name": "my_file.txt",
"file_type": "txt",
"source_url": "https://my.source.url.com/file.txt",
}
],
)
โ๏ธ Parameters
documents: DocumentRemoteUploadRequestDocuments
โ๏ธ Request Body
๐ Return
๐ Endpoint
/v1/ingest/documents/remote post
๐ Back to Table of Contents
groundx.projects.add_bucket
This endpoint allows you to add a bucket to a project.
๐ ๏ธ Usage
add_bucket_response = groundx.projects.add_bucket(
project_id=1,
bucket_id=1,
)
โ๏ธ Parameters
project_id: int
The ID of the project to update.
bucket_id: int
The ID of the bucket to update.
๐ Return
๐ Endpoint
/v1/project/{projectId}/bucket/{bucketId} post
๐ Back to Table of Contents
groundx.projects.create
This endpoint allows you to create a new project.
๐ ๏ธ Usage
create_response = groundx.projects.create(
name="your_project_name",
bucket_name="your_new_bucket_name",
)
โ๏ธ Parameters
name: str
bucket_name: str
Include a bucket name to automatically create a bucket and add it to this project
โ๏ธ Request Body
๐ Return
๐ Endpoint
/v1/project post
๐ Back to Table of Contents
groundx.projects.delete
Delete a project
๐ ๏ธ Usage
delete_response = groundx.projects.delete(
project_id=1,
)
โ๏ธ Parameters
project_id: int
๐ Return
๐ Endpoint
/v1/project/{projectId} delete
๐ 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=1,
)
โ๏ธ Parameters
project_id: int
The ID of the project to retrieve.
๐ Return
๐ 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(
n=1,
next_token="string_example",
)
โ๏ธ Parameters
n: int
next_token: str
๐ Return
๐ Endpoint
/v1/project get
๐ Back to Table of Contents
groundx.projects.remove_bucket
This endpoint allows you to remove a bucket from a project.
๐ ๏ธ Usage
remove_bucket_response = groundx.projects.remove_bucket(
project_id=1,
bucket_id=1,
)
โ๏ธ Parameters
project_id: int
The ID of the project to update.
bucket_id: int
The ID of the bucket to update.
๐ Return
๐ Endpoint
/v1/project/{projectId}/bucket/{bucketId} delete
๐ Back to Table of Contents
groundx.projects.update
This endpoint allows you to update an existing project.
๐ ๏ธ Usage
update_response = groundx.projects.update(
new_name="your_project_name",
project_id=1,
)
โ๏ธ Parameters
new_name: str
project_id: int
The ID of the project to update.
โ๏ธ Request Body
๐ Return
๐ 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
๐ Return
๐ Endpoint
/v1/search/{id} post
๐ Back to Table of Contents
Author
This Python package is automatically generated by Konfig
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for groundx_python_sdk-1.3.6-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 971cec3c84fd5a4df9de067fa58817d092f9d015892272d0addbf2904a72cc70 |
|
| MD5 | 8e9ca4b655387f19f61172839be89b8b |
|
| BLAKE2b-256 | 5e5029cc9a90d25cb7b9cb489bbfefb082113d9428d7d43f92ab0e40352551b3 |
