groundx-python-sdk 1.3.8

`groundx.buckets.delete`

delete a bucket.

🛠️ Usage

delete_response = groundx.buckets.delete(
    bucket_id=1,
)

⚙️ Parameters

bucket_id: `int`

The bucketId of the bucket being deleted.

🔄 Return

🌐 Endpoint

/v1/bucket/{bucketId} delete

`groundx.buckets.get`

look up a specific bucket by its bucketId.

🛠️ Usage

get_response = groundx.buckets.get(
    bucket_id=1,
)

⚙️ Parameters

bucket_id: `int`

The bucketId of the bucket to look up.

🔄 Return

BucketResponse

🌐 Endpoint

/v1/bucket/{bucketId} get

`groundx.buckets.list`

List all buckets within your GroundX account

🛠️ Usage

list_response = groundx.buckets.list(
    n=1,
    next_token="string_example",
)

⚙️ Parameters

n: `int`

The maximum number of returned documents. Accepts 1-100 with a default of 20.

next_token: `str`

A 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.

🔄 Return

BucketListResponse

🌐 Endpoint

/v1/bucket get

`groundx.buckets.update`

Rename a bucket

🛠️ Usage

update_response = groundx.buckets.update(
    new_name="your_bucket_name",
    bucket_id=1,
)

⚙️ Parameters

new_name: `str`

bucket_id: `int`

The bucketId of the bucket being updated.

⚙️ Request Body

BucketUpdateRequest

🔄 Return

BucketUpdateResponse

🌐 Endpoint

/v1/bucket/{bucketId} put

`groundx.documents.crawl_website`

Upload the content of a publicly accessible website to a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages.

🛠️ 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

WebsiteCrawlRequest

🔄 Return

🌐 Endpoint

/v1/ingest/documents/website post

`groundx.documents.delete`

Delete multiple documents hosted on GroundX

🛠️ Usage

delete_response = groundx.documents.delete(
    document_ids=["documentIds_example"],
)

⚙️ Parameters

document_ids: List[`str`]

A list of documentIds which correspond to documents uploaded to GroundX

🔄 Return

🌐 Endpoint

/v1/ingest/documents delete

`groundx.documents.delete_0`

Delete a single document hosted on GroundX

🛠️ Usage

delete_0_response = groundx.documents.delete_0(
    document_id="documentId_example",
)

⚙️ Parameters

document_id: `str`

A documentId which correspond to a document uploaded to GroundX

🔄 Return

🌐 Endpoint

/v1/ingest/document/{documentId} delete

`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

`groundx.documents.get_processing_status_by_id`

Get the current status of an upload, initiated with documents.upload_remote, documents.upload_local, or documents.crawl_website, by specifying the processId (which is included in the response of the upload functions).

🛠️ 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

`groundx.documents.list`

lookup all documents across all resources which are currently on GroundX

🛠️ Usage

list_response = groundx.documents.list(
    n=1,
    next_token="string_example",
)

⚙️ Parameters

n: `int`

The maximum number of returned documents. Accepts 1-100 with a default of 20.

next_token: `str`

🔄 Return

DocumentListResponse

🌐 Endpoint

/v1/ingest/documents get

`groundx.documents.lookup`

lookup the document(s) associated with a processId, bucketId, or projectId.

🛠️ Usage

lookup_response = groundx.documents.lookup(
    id=1,
    n=1,
    next_token="string_example",
)

⚙️ Parameters

id: `int`

a processId, bucketId, or projectId

n: `int`

The maximum number of returned documents. Accepts 1-100 with a default of 20.

next_token: `str`

🔄 Return

DocumentLookupResponse

🌐 Endpoint

/v1/ingest/documents/{id} get

DocumentLocalUploadRequest

`groundx.documents.upload_local`

Upload documents hosted on a local file system to a GroundX bucket

🛠️ 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

DocumentRemoteUploadRequest

`groundx.documents.upload_remote`

Upload documents which are hosted on public URLs to a GroundX bucket

🛠️ 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

`groundx.projects.add_bucket`

Add an existing bucket to an existing project. Buckets and projects can be associated many to many.

🛠️ Usage

add_bucket_response = groundx.projects.add_bucket(
    project_id=1,
    bucket_id=1,
)

⚙️ Parameters

project_id: `int`

The projectId of the project which the bucket will be added to.

bucket_id: `int`

The bucketId of the bucket being added to the project.

🔄 Return

🌐 Endpoint

/v1/project/{projectId}/bucket/{bucketId} post

`groundx.projects.create`

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

ProjectCreateRequest

🔄 Return

ProjectResponse

🌐 Endpoint

/v1/project post

`groundx.projects.delete`

delete a project.

🛠️ Usage

delete_response = groundx.projects.delete(
    project_id=1,
)

⚙️ Parameters

project_id: `int`

The projectId of the project to be deleted.

🔄 Return

🌐 Endpoint

/v1/project/{projectId} delete

`groundx.projects.get`

look up a specific project by its projectId.

🛠️ Usage

get_response = groundx.projects.get(
    project_id=1,
)

⚙️ Parameters

project_id: `int`

The projectId of the project to look up.

🔄 Return

ProjectResponse

🌐 Endpoint

/v1/project/{projectId} get

`groundx.projects.list`

list all projects within your GroundX account.

🛠️ Usage

list_response = groundx.projects.list(
    n=1,
    next_token="string_example",
)

⚙️ Parameters

n: `int`

The maximum number of returned documents. Accepts 1-100 with a default of 20.

next_token: `str`

🔄 Return

ProjectListResponse

🌐 Endpoint

/v1/project get

`groundx.projects.remove_bucket`

remove a bucket from a project. Buckets and projects can be associated many to many, this removes one bucket to project association without disturbing others.

🛠️ Usage

remove_bucket_response = groundx.projects.remove_bucket(
    project_id=1,
    bucket_id=1,
)

⚙️ Parameters

project_id: `int`

The projectId of the project which the bucket will be removed from.

bucket_id: `int`

The bucketId of the bucket which will be removed from the project.

🔄 Return

🌐 Endpoint

/v1/project/{projectId}/bucket/{bucketId} delete

`groundx.projects.update`

Rename a project

🛠️ Usage

update_response = groundx.projects.update(
    new_name="your_project_name",
    project_id=1,
)

⚙️ Parameters

new_name: `str`

project_id: `int`

The projectId of the project to update.

⚙️ Request Body

ProjectUpdateRequest

🔄 Return

ProjectResponse

🌐 Endpoint

/v1/project/{projectId} put

`groundx.search.content`

Search 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.

🛠️ Usage

content_response = groundx.search.content(
    search={
        "query": "my search query",
        "next_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    },
    id=1,
    n=20,
)

⚙️ Parameters

search: `SearchRequestSearch`

id: `int`

The bucketId or projectId of the bucket or project being searched. The documents within the specified container will be compared to the query, and relevant information will be extracted.

n: `int`

The maximum number of returned documents. Accepts 1-100 with a default of 20.

⚙️ Request Body

SearchRequest

🔄 Return

SearchResponse

🌐 Endpoint

/v1/search/{id} post