git404hub

what is auditrag fr?

aryansharmagithub/auditrag — explained in plain English

Analysis updated 2026-05-18

5PythonAudience · developerComplexity · 3/5LicenseSetup · moderate

tl;dr

A retrieval-augmented question-answering tool that verifies every AI claim against its exact source text and exports the evidence as a checkable PDF report.

vibe map

mindmap
  root((AuditRAG))
    What it does
      Verifiable RAG answers
      Page-level citations
      PDF evidence export
    Tech stack
      Python
      SQLite and ChromaDB
      FastAPI web UI
    Use cases
      Q&A over your documents
      Check claim faithfulness
      Generate compliance reports
    Audience
      Developers
      Compliance teams
    Status
      v1 pipeline shipped
      MIT licensed

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

what do people make with this?

VIBE 1

Build a question-answering system over your own documents with verifiable, page-level citations.

VIBE 2

Check whether AI-generated answers are actually supported by the exact source text they cite.

VIBE 3

Export a timestamped PDF evidence report of an AI answer's claims and cited sources for compliance.

what's the stack?

PythonSQLiteChromaDBFastAPI

how it stacks up fr

aryansharmagithub/auditrag1ncendium/aibusteraaronmayeux/ha-hurricane-tracker
Stars555
LanguagePythonPythonPython
Setup difficultymoderatemoderateeasy
Complexity3/53/52/5
Audiencedeveloperops devopsgeneral

Figures from each repo's GitHub metadata at analysis time.

how do i run it?

Difficulty · moderate time til it works · 30min

Local embeddings need no API key, but the ask command needs an LLM endpoint like OpenAI or a local Ollama server.

MIT license: free to use, modify, and distribute, including commercially, as long as the copyright notice is kept.

in plain english

AuditRAG is a tool for building question-answering systems on top of your own documents, in a way that lets you actually check whether the AI's answer is telling the truth. This kind of system is often called retrieval-augmented generation, or RAG, where an AI model answers questions by first pulling relevant text from your files and then writing a response based on it. The README points out that most RAG tools cite a whole document under a paragraph of generated text, which does not really prove anything, since the model could still be making claims the source never actually said. AuditRAG's approach is to treat exact sourcing as the whole point of the tool. Every sentence the AI writes is linked to a specific chunk of text and a specific page number, and a separate model checks each individual claim against the exact wording of the source it cites, flagging anything unsupported. The whole question-and-answer exchange, including every claim, its verdict, and the exact cited text, can be exported as a timestamped PDF report, the kind of document you could hand to an auditor or compliance reviewer as evidence. Using it involves installing the Python package, pointing it at a folder of PDF, Markdown, or text files to index them, and then either asking questions from the command line or running a small web interface in your browser. It works with a local, no-API-key embedding model by default, but can also be configured to use OpenAI or a local alternative like Ollama for both the search and the answer-generation steps. Under the hood, it combines a search technique called BM25 with vector-based semantic search, stores the retrievable text chunks in a local SQLite database, and keeps embeddings in a separate ChromaDB index, always linked back to the same source chunk identifiers so a citation can never point to text that does not exist. The README notes that this version deliberately does not support multi-turn chat or bring in heavyweight frameworks like LangChain, aiming to keep citation tracking simple and verifiable. The project is open source under the MIT license.

prompts (copy fr)

prompt 1
Walk me through installing AuditRAG and indexing a folder of PDF documents with auditrag ingest.
prompt 2
Show me how to run auditrag ask with the --verify flag to check answer faithfulness.
prompt 3
Explain how AuditRAG's hybrid BM25 and vector retrieval keeps citations tied to exact chunk IDs.
prompt 4
Help me configure AuditRAG to use a local Ollama model instead of the OpenAI API.

Frequently asked questions

what is auditrag fr?

A retrieval-augmented question-answering tool that verifies every AI claim against its exact source text and exports the evidence as a checkable PDF report.

What language is auditrag written in?

Mainly Python. The stack also includes Python, SQLite, ChromaDB.

What license does auditrag use?

MIT license: free to use, modify, and distribute, including commercially, as long as the copyright notice is kept.

How hard is auditrag to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is auditrag for?

Mainly developer.

peek the repo → explain another one

This repo across BitVibe Labs

double-check against the repo, no cap.