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

Namespaces

  • client.collections for collection CRUD, stats, re-embedding, event tokens, 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, vector storage overview, 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.22.tar.gz (21.9 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.22-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bigrag-2026.5.22.tar.gz
  • Upload date:
  • Size: 21.9 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.22.tar.gz
Algorithm Hash digest
SHA256 b540ff986cbf89de1cd53d96fae73e9bc08926377a394faba8b414b425555e45
MD5 562ecc1131da902b81e6fedcd9b855c8
BLAKE2b-256 4196b37c9183c3990df62a7cb097c6cfc75e5f21d3e3be6056f4ba5b1e0b42f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: bigrag-2026.5.22-py3-none-any.whl
  • Upload date:
  • Size: 38.2 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.22-py3-none-any.whl
Algorithm Hash digest
SHA256 ac36999dcc07a1a7c029fed98d6dc8b6a58b1ef6a26c247e9607e3380ac0efb4
MD5 d1b24b96c99ea1ad3774e9934fb61e62
BLAKE2b-256 4143b99595a685ef4326483cbd121091be1812b6ea2ada4f9953d446efbb24a7

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