groundx.buckets.creategroundx.buckets.deletegroundx.buckets.getgroundx.buckets.listgroundx.buckets.updategroundx.customer.getgroundx.documents.crawl_websitegroundx.documents.deletegroundx.documents.delete1groundx.documents.getgroundx.documents.get_processing_status_by_idgroundx.documents.ingest_localgroundx.documents.ingest_remotegroundx.documents.listgroundx.documents.lookupgroundx.groups.add_bucketgroundx.groups.creategroundx.groups.deletegroundx.groups.getgroundx.groups.listgroundx.groups.remove_bucketgroundx.groups.updategroundx.health.getgroundx.health.listgroundx.search.contentgroundx.search.documentsPython >=3.7
pip install groundx-python-sdk==1.3.29
from pprint import pprint
from groundx import Groundx, ApiException
groundx = Groundx(
api_key="YOUR_API_KEY",
)
try:
# create
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 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
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())
groundx.buckets.createCreate a new bucket.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
create_response = groundx.buckets.create(
name="your_bucket_name",
)
str/v1/bucket post
groundx.buckets.deleteDelete a bucket.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
delete_response = groundx.buckets.delete(
bucket_id=1,
)
intThe bucketId of the bucket being deleted.
/v1/bucket/{bucketId} delete
groundx.buckets.getLook up a specific bucket by its bucketId.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
get_response = groundx.buckets.get(
bucket_id=1,
)
intThe bucketId of the bucket to look up.
/v1/bucket/{bucketId} get
groundx.buckets.listList all buckets within your GroundX account
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
list_response = groundx.buckets.list(
n=1,
next_token="string_example",
)
intThe maximum number of returned buckets. Accepts 1-100 with a default of 20.
strA token for pagination. If the number of buckets for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n buckets.
/v1/bucket get
groundx.buckets.updateRename a bucket.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
update_response = groundx.buckets.update(
new_name="your_bucket_name",
bucket_id=1,
)
strThe new name of the bucket being renamed.
intThe bucketId of the bucket being updated.
/v1/bucket/{bucketId} put
groundx.customer.getGet the account information associated with the API key.
get_response = groundx.customer.get()
/v1/customer get
groundx.documents.crawl_websiteUpload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
crawl_website_response = groundx.documents.crawl_website(
websites=[
{
"bucket_id": 123,
"cap": 100,
"depth": 3,
"source_url": "https://my.website.com",
}
],
)
WebsiteCrawlRequestWebsites/v1/ingest/documents/website post
groundx.documents.deleteDelete multiple documents hosted on GroundX
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
delete_response = groundx.documents.delete(
document_ids=["documentIds_example"],
)
str]A list of documentIds which correspond to documents ingested by GroundX
/v1/ingest/documents delete
groundx.documents.delete1Delete a single document hosted on GroundX
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
delete1_response = groundx.documents.delete1(
document_id="documentId_example",
)
strA documentId which correspond to a document ingested by GroundX
/v1/ingest/document/{documentId} delete
groundx.documents.getLook up an existing document by documentId.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
get_response = groundx.documents.get(
document_id="documentId_example",
)
strThe documentId of the document for which GroundX information will be provided.
/v1/ingest/document/{documentId} get
groundx.documents.get_processing_status_by_idGet the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions).
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
get_processing_status_by_id_response = groundx.documents.get_processing_status_by_id(
process_id="processId_example",
)
strthe processId for the ingest process being checked
/v1/ingest/{processId} get
groundx.documents.ingest_localUpload documents hosted on a local file system for ingestion into a GroundX bucket.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
ingest_local_response = groundx.documents.ingest_local(
body=[
{
"blob": open("/path/to/file", "rb"),
"metadata": {
"bucket_id": 1234,
"file_name": "my_file.txt",
"file_type": "txt",
},
}
],
)
/v1/ingest/documents/local post
groundx.documents.ingest_remoteIngest documents hosted on public URLs to a GroundX bucket.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
ingest_remote_response = groundx.documents.ingest_remote(
documents=[
{
"bucket_id": 1234,
"file_name": "my_file.txt",
"file_type": "txt",
"source_url": "https://my.source.url.com/file.txt",
}
],
)
DocumentRemoteIngestRequestDocuments/v1/ingest/documents/remote post
groundx.documents.listlookup all documents across all resources which are currently on GroundX
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
list_response = groundx.documents.list(
n=1,
filter="string_example",
sort="name",
sort_order="asc",
status="queued",
next_token="string_example",
)
intThe maximum number of returned documents. Accepts 1-100 with a default of 20.
strOnly documents with names that contain the filter string will be returned in the results.
SortThe document attribute that will be used to sort the results.
SortOrderThe order in which to sort the results. A value for sort must also be set.
ProcessingStatusA status filter on the get documents query. If this value is set, then only documents with this status will be returned in the results.
strA token for pagination. If the number of documents for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n documents.
/v1/ingest/documents get
groundx.documents.lookuplookup the document(s) associated with a processId, bucketId, groupId, or projectId.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
lookup_response = groundx.documents.lookup(
id=1,
n=1,
filter="string_example",
sort="name",
sort_order="asc",
status="queued",
next_token="string_example",
)
inta processId, bucketId, groupId, or projectId
intThe maximum number of returned documents. Accepts 1-100 with a default of 20.
strOnly documents with names that contain the filter string will be returned in the results.
SortThe document attribute that will be used to sort the results.
SortOrderThe order in which to sort the results. A value for sort must also be set.
ProcessingStatusA status filter on the get documents query. If this value is set, then only documents with this status will be returned in the results.
strA token for pagination. If the number of documents for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n documents.
/v1/ingest/documents/{id} get
groundx.groups.add_bucketAdd an existing bucket to an existing group. Buckets and groups can be associated many to many.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
add_bucket_response = groundx.groups.add_bucket(
group_id=1,
bucket_id=1,
)
intThe groupId of the group which the bucket will be added to.
intThe bucketId of the bucket being added to the group.
/v1/group/{groupId}/bucket/{bucketId} post
groundx.groups.createcreate a new group, a group being a collection of buckets which can be searched.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
create_response = groundx.groups.create(
name="your_group_name",
bucket_name="your_new_bucket_name",
)
strThe name of the group being created.
strSpecify bucketName to automatically create a bucket, by the name specified, and add it to the created group.
/v1/group post
groundx.groups.deleteDelete a group.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
delete_response = groundx.groups.delete(
group_id=1,
)
intThe groupId of the group to be deleted.
/v1/group/{groupId} delete
groundx.groups.getlook up a specific group by its groupId.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
get_response = groundx.groups.get(
group_id=1,
)
intThe groupId of the group to look up.
/v1/group/{groupId} get
groundx.groups.listlist all groups within your GroundX account.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
list_response = groundx.groups.list(
n=1,
next_token="string_example",
)
intThe maximum number of returned groups. Accepts 1-100 with a default of 20.
strA token for pagination. If the number of groups for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n groups.
/v1/group get
groundx.groups.remove_bucketremove a bucket from a group. Buckets and groups can be associated many to many, this removes one bucket to group association without disturbing others.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
remove_bucket_response = groundx.groups.remove_bucket(
group_id=1,
bucket_id=1,
)
intThe groupId of the group which the bucket will be removed from.
intThe bucketId of the bucket which will be removed from the group.
/v1/group/{groupId}/bucket/{bucketId} delete
groundx.groups.updateRename a group
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
update_response = groundx.groups.update(
new_name="your_group_name",
group_id=1,
)
strThe new name of the group being renamed.
intThe groupId of the group to update.
/v1/group/{groupId} put
groundx.health.getLook up the current health status of a specific service. Statuses update every 5 minutes.
get_response = groundx.health.get(
service="search",
)
strThe name of the service to look up.
/v1/health/{service} get
groundx.health.listList the current health status of all services. Statuses update every 5 minutes.
list_response = groundx.health.list()
/v1/health get
groundx.search.contentSearch documents on GroundX for the most relevant information to a given query.
The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
content_response = groundx.search.content(
query="my search query",
id=None,
relevance=10,
n=20,
next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
verbosity=0,
)
strThe search query to be used to find relevant documentation.
int, str]The bucketId, groupId, projectId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted.
Union[int, float]The minimum search relevance score required to include the result. By default, this is 10.0.
intThe maximum number of returned search results. Accepts 1-100 with a default of 20.
strA token for pagination. If the number of search results for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n search results.
intThe amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData.
/v1/search/{id} post
groundx.search.documentsSearch documents on GroundX for the most relevant information to a given query by documentId(s).
The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
documents_response = groundx.search.documents(
query="my search query",
document_ids=["docUUID1", "docUUID2"],
relevance=10,
n=20,
next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
verbosity=0,
)
strThe search query to be used to find relevant documentation.
SearchDocumentsRequestDocumentIdsUnion[int, float]The minimum search relevance score required to include the result. By default, this is 10.0.
intThe maximum number of returned search results. Accepts 1-100 with a default of 20.
strA token for pagination. If the number of search results for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n search results.
intThe amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData.
/v1/search/documents post
This Python package is automatically generated by Konfig
FAQs
Client for GroundX APIs
We found that groundx-python-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.