Skip to main content

No project description provided

Project description

RAQA

Retrieval-Augmented Question-Answering

Retrieval-augmented, pip-installable, CLI-based question answering over arbitrary document collections.

Usage

Installation

pip install raqa

Locally

pip install -e .

Run

BASH via Python interpreter

  1. Build DB

    python cli.py build --path ./docs

  2. Chat

    python cli.py chat

  3. One-shot retrieval

    python cli.py search "what is retrieval augmented generation?"

  4. Rebuild and chat

    python cli.py rebuild-and-chat

  5. Get stats

    python cli.py stats

BASH natively

raqa build --path ./markdown_files
raqa chat
raqa search "what is RAG?"
raqa stats
raqa rebuild-and-chat

Python

Build database

from db import VectorDB
from config import MARKDOWN_ROOT

db = VectorDB()
db.build(MARKDOWN_ROOT)

Run

from agent import RAGAgent

agent = RAGAgent()
agent.chat()

Build instructions

Next steps:

  1. If any changes are made, update pyproject.toml.
  2. Building the package before uploading: cd raqa; python -m build.
  3. Upload the package to pypi: python -m twine upload --repository {pypi|testpypi} dist/*

Next steps

Real tool-calling (instead of implicit RAG)

Define OpenAI tool:

{
  "name": "search_docs",
  "description": "...",
  "parameters": { "query": "string" }
}

Hybrid search

Combine BM25 (rank-bm25) + embeddings

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

raqa-0.0.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

raqa-0.0.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file raqa-0.0.1.tar.gz.

File metadata

  • Download URL: raqa-0.0.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for raqa-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ba19c2452ec0542a100f79cbd7448f8411852cd4307c77ed9cd2e546fd558f8b
MD5 693465e7610fb82248d32e87bb3d0fed
BLAKE2b-256 5c5347a01b9988d3620df1bc770c5526262a10b1a30a044ec7c2e018ec9771d5

See more details on using hashes here.

File details

Details for the file raqa-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: raqa-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for raqa-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75259f1291ed02f5a75fb99f6bd11bf26f4480319c1f37d6bb3f3439f5e9cf36
MD5 25d60a3f8b504adc32724c9271d7ce1c
BLAKE2b-256 45fd4b68be63ed678f5cf43001c7520faefdd77d8ff7c07e3c31880cc3a16480

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