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

Namespaces

  • client.collections for collection CRUD, stats, re-embedding, and event streams.
  • client.documents for uploads, batch operations, file URLs, and status polling.
  • 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, access logs, audit logs, runtime settings, backups, admin realtime streams, connector config, embedding presets, and MCP server keys.
  • client.connectors.google for Google Drive account, file browsing, sources, and sync jobs.
  • 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.7.tar.gz (47.7 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.7-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bigrag-2026.5.7.tar.gz
  • Upload date:
  • Size: 47.7 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.7.tar.gz
Algorithm Hash digest
SHA256 ba1e291d7ec2ab777b37e3e51fb78ad219cda5ef0f6d75de822cae38f5f27f5d
MD5 6236daddd14327d2f84d4a98ee0c2986
BLAKE2b-256 72a6422b690e87be3d16a38af728a4c509fd9e33a475d4b0fae034dd82005e9a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bigrag-2026.5.7-py3-none-any.whl
  • Upload date:
  • Size: 35.4 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 de28046343695c67468d7bb4c7a4714427855772221f66caf5f21d7a23a0a901
MD5 7715c4cacc3fdb6cbc0c74e6c8dcb975
BLAKE2b-256 84fedcb6cbec449a973a5b7b4f7dc140fc7b0cef779e77c10e9e127af5e62022

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