Skip to main content

Python SDK for the bigRAG platform

Project description

bigRAG Python SDK

Async Python client for the bigRAG API.

pip install bigrag
import asyncio

from bigrag import BigRAG


async def main() -> None:
    async with BigRAG(api_key="bigrag_sk_...", base_url="http://localhost:4000") as client:
        doc = await client.documents.upload("docs", "/path/to/paper.pdf")
        result = await client.queries.query("docs", {"query": "What is RAG?"})
        print(doc["id"], result["total"])


asyncio.run(main())

The SDK is fully typed, ships py.typed, and uses CalVer releases like 2026.5.1.

Namespaces

  • client.collections for collection CRUD, stats, re-embedding, and event streams.
  • client.documents for uploads, S3 ingestion, batch operations, file URLs, and progress streams.
  • client.queries for single, multi-collection, and batch retrieval queries.
  • client.vectors for raw vector upsert and delete.
  • client.webhooks for webhook management and delivery replay.
  • client.auth for session login, setup, preferences, and identity.
  • client.admin for users, API keys, audit logs, embedding presets, and MCP server keys.
  • client.evaluations for golden-set retrieval evaluations.

Authentication

API-key endpoints accept api_key or the BIGRAG_API_KEY environment variable. Session-only admin endpoints can be used after calling client.auth.login(...) or client.auth.setup(...); the client keeps the session cookie in its underlying httpx.AsyncClient.

Versioning

Published artifacts use CalVer in the form YYYY.M.D.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bigrag-2026.5.1.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bigrag-2026.5.1-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file bigrag-2026.5.1.tar.gz.

File metadata

  • Download URL: bigrag-2026.5.1.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bigrag-2026.5.1.tar.gz
Algorithm Hash digest
SHA256 1f799fb938735d96bc770a0ccf1b6c6b477b698af9f97718483e8918a178035c
MD5 4f2a186d4e06869937be2430dfb3dce1
BLAKE2b-256 841395c5e7edbc89e08326e91e46b486bf419599ebbaef6a6027ef7ef76e17b8

See more details on using hashes here.

File details

Details for the file bigrag-2026.5.1-py3-none-any.whl.

File metadata

  • Download URL: bigrag-2026.5.1-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bigrag-2026.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d12edf79736e97851867aead6069c0e188ce3fe300df6d06876fa728183630ec
MD5 b58670cd5e8d2f106bf798f5c27d87ad
BLAKE2b-256 15d013c5e22496c891a8da20675bf0cc92ab91d5ad2885ac81e68168d3923966

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page