Table of Contents

• Requirements
• Installing
• Getting Started
• Async
• Reference
  • groundx.api_keys.list
  • groundx.buckets.get
  • groundx.buckets.list
  • groundx.buckets.update
  • groundx.documents.delete
  • groundx.documents.get
  • groundx.documents.get_processing_status_by_id
  • groundx.documents.list
  • groundx.documents.lookup
  • groundx.documents.upload_local
  • groundx.documents.upload_remote
  • groundx.projects.get
  • groundx.projects.list
  • groundx.projects.update
  • groundx.search.content

Requirements

Python >=3.7

Installing

pip install groundx-python-sdk==1.3.3

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())

Reference

groundx.api_keys.list

Retrieve the API keys for your account.

🛠️ Usage

list_response = groundx.api_keys.list()

🔄 Return

ApiKeyManagementListResponse

🌐 Endpoint

/v1/apikey get

🔙 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

BucketResponse

🌐 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()

🔄 Return

BucketListResponse

🌐 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(
    bucket={
        "name": "your_bucket_name",
    },
    bucket_id=1,
)

⚙️ Parameters

bucket: BucketUpdateRequestBucket

bucket_id: int

The ID of the bucket to update.

⚙️ Request Body

BucketUpdateRequest

🔄 Return

BucketUpdateResponse

🌐 Endpoint

/v1/bucket/{bucketId} put

🔙 Back to Table of Contents

groundx.documents.delete

Delete a document

🛠️ Usage

delete_response = groundx.documents.delete(
    document_id="documentId_example",
)

⚙️ Parameters

document_id: str

🔄 Return

DocumentDeleteResponse

🌐 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

DocumentResponse

🌐 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

ProcessStatusResponse

🌐 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

DocumentListResponse

🌐 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

DocumentLookupResponse

🌐 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",
                "callback_data": "my_callback_data",
                "callback_url": "https://my.callback.url.com",
            },
        }
    ],
)

⚙️ Request Body

DocumentLocalUploadRequest

🔄 Return

IngestResponse

🌐 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,
            "source_url": "https://my.source.url.com/file.txt",
            "callback_data": "my_callback_data",
            "callback_url": "https://my.callback.url.com",
            "type": "txt",
        }
    ],
)

⚙️ Parameters

documents: DocumentRemoteUploadRequestDocuments

⚙️ Request Body

DocumentRemoteUploadRequest

🔄 Return

IngestResponse

🌐 Endpoint

/v1/ingest/documents/remote post

🔙 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="projectId_example",
)

⚙️ Parameters

project_id: str

The ID of the project to retrieve.

🔄 Return

ProjectResponse

🌐 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()

🔄 Return

ProjectListResponse

🌐 Endpoint

/v1/project get

🔙 Back to Table of Contents

groundx.projects.update

This endpoint allows you to update an existing project.

🛠️ Usage

update_response = groundx.projects.update(
    project={
        "name": "your_project_name",
    },
    project_id="projectId_example",
)

⚙️ Parameters

project: ProjectUpdateRequestProject

project_id: str

The ID of the project to update.

⚙️ Request Body

ProjectUpdateRequest

🔄 Return

ProjectResponse

🌐 Endpoint

/v1/project/{projectId} put

🔙 Back to Table of Contents

groundx.search.content

Search and retrieve relevant content from a project, group, 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, group, or bucket to search within.

n: int

Number of results

⚙️ Request Body

SearchRequest

🔄 Return

SearchResponse

🌐 Endpoint

/v1/search/{id} post

🔙 Back to Table of Contents

Author

This Python package is automatically generated by Konfig