Self-optimising Retrieval-Augmented Generation built with LangGraph. AdaptiveRAG analyses your knowledge base, auto-tunes the pipeline, and routes every query through the best retrieval strategy — works fully locally with Ollama or with Claude / OpenAI cloud APIs.
- What makes it agentic
- How it works
- Installation
- Quick start
- LLM providers
- Configuration
- Supported document formats
- Validation queries
- API reference
- Project structure
- Contributing
- License
Most RAG pipelines execute the same fixed sequence regardless of what you ask. AdaptiveRAG uses LLM-driven decision nodes at every step so the path through the graph changes per query and per knowledge base.
| Capability | Fixed RAG pipeline | AdaptiveRAG |
|---|---|---|
| Chunking strategy | Hard-coded | Chosen per document type (sentence / paragraph / code) |
| Chunk size | Fixed | Auto-tuned against your actual documents |
| Query expansion | None | HyDE (hypothetical document embedding) for vague queries |
| Retrieval passes | Single | Multi-hop follow-up when first pass is insufficient |
| Result reranking | None | Cross-encoder reranking for analytical / comparison queries |
| Answer quality | Not checked | Critic node scores the answer; retries with a new strategy if confidence is low |
| Parameter tuning | Manual | Optimizer agent tunes chunk size, top-k, temperature, and reranking automatically |
| LLM provider | Single hard-coded | Ollama (local), Claude, or OpenAI — swap with one parameter |
AdaptiveRAG is composed of two LangGraph state machines.
load docs ──► profile KB ──► plan config ──► index ──► evaluate ──► orchestrate ──┐
▲ │
critique ◄── tune_*
(chunk / retrieval /
generation / reranking)
- Profile — the LLM classifies domain, structure type, and complexity of your documents
- Plan — heuristic config is derived from the profile (chunk size, strategy, top-k, temperature)
- Index — documents are chunked and embedded into ChromaDB
- Evaluate — answers are scored against validation queries using cosine similarity
- Orchestrate — the LLM picks which parameter to tune next and loops until scores plateau
classify ──► strategize ──► expand ──► retrieve ──► retrieval critic ──┐
▲ │ │
│ multihop ◄──── ┘
│ │
└──── retry ◄──── reflect ◄──── generate ◄──── rerank ◄─┘
- Classify — query type detected (factual / analytical / code / comparison / summarisation)
- Strategize — LLM decides which tools to use (HyDE, rerank, multihop, top-k)
- Retrieve — vector search, optionally with expanded queries
- Critic — retrieval quality is scored; if too low, a follow-up multi-hop query is issued
- Generate — answer produced using the style matching the query type
- Reflect — answer critic checks groundedness and completeness; retries if below threshold
pip install adaptiveragWith cross-encoder reranking (recommended for analytical or comparison queries):
pip install "adaptiverag[reranker]"With Claude (Anthropic) support:
pip install "adaptiverag[claude]"With OpenAI support:
pip install "adaptiverag[openai]"Prerequisite: Ollama must be running locally — it is used for embeddings regardless of which LLM provider you choose. Any missing Ollama models are pulled automatically the first time
build_rag()is called.
Create a knowledge_base/ folder and drop in your files (.txt, .pdf, .md, .docx):
knowledge_base/
├── report.pdf
├── notes.md
└── spec.txt
from adaptiverag import build_rag
# Indexes knowledge_base/, auto-tunes the pipeline, returns a ready instance
rag = build_rag()
result = rag.ask("What are the main findings?")
print(result) # the answer (str(result) also works)
print(result.confidence) # 0.0 – 1.0 self-assessed confidence
print(result.strategy) # why the agent chose this retrieval path
print(result.trace) # full step-by-step reasoning logadaptiveragInteractive prompt with the same agentic graph — type trace to see the last query's reasoning.
AdaptiveRAG supports three LLM providers. Embeddings always run locally via Ollama regardless of which provider you pick.
No API key needed. Any model from ollama.com/library works and is auto-pulled on first use.
from adaptiverag import build_rag
rag = build_rag(
llm_model = "gemma4:latest", # auto-pulled if not local
embed_model = "nomic-embed-text:latest",
)Get an API key at console.anthropic.com. Install the extra first:
pip install "adaptiverag[claude]"from adaptiverag import build_rag
rag = build_rag(
api_key = "sk-ant-...", # defaults to claude-opus-4-7
# llm_model = "claude-sonnet-4-6" # override the model if needed
)Get an API key at platform.openai.com. Install the extra first:
pip install "adaptiverag[openai]"from adaptiverag import build_rag
rag = build_rag(
openai_api_key = "sk-...", # defaults to gpt-4o
# llm_model = "gpt-4-turbo" # override the model if needed
)| Ollama | Claude | OpenAI | |
|---|---|---|---|
| Install extra | — | adaptiverag[claude] |
adaptiverag[openai] |
| Default model | gemma4:latest |
claude-opus-4-7 |
gpt-4o |
| Internet required | No | Yes | Yes |
| Data leaves machine | No | Yes | Yes |
| Cost | Free | Pay-per-token | Pay-per-token |
rag = build_rag(
llm_model = "gemma4:latest", # Ollama model (auto-pulled)
embed_model = "nomic-embed-text:latest", # Ollama embedding model (auto-pulled)
kb_path = "./knowledge_base", # path to your documents
val_queries_path = "./validation_queries.json", # optional — auto-generated if omitted
api_key = None, # Anthropic key → uses Claude
openai_api_key = None, # OpenAI key → uses OpenAI
)# keyword prefix
result = rag.ask("from:report.pdf Summarise the methodology")
# or the parameter
result = rag.ask("Summarise the methodology", source_filter="report.pdf")| Role | Recommended models |
|---|---|
| LLM (routing + answers) | gemma4, llama3.2, mistral, qwen2.5 |
| Embeddings | nomic-embed-text, mxbai-embed-large |
| Format | Extension | Notes |
|---|---|---|
| Plain text | .txt |
UTF-8 |
.pdf |
Text-based; scanned PDFs not supported | |
| Markdown | .md |
Code blocks, headings, and links stripped cleanly |
| Word | .docx |
Requires python-docx (included) |
Mixed formats in the same folder are fully supported.
The setup graph tunes pipeline parameters by scoring generated answers against expected answers. Provide your own queries for best results:
[
{
"query": "What problem does this research solve?",
"expected_answer": "The research addresses the challenge of ..."
},
{
"query": "What method is used for data collection?",
"expected_answer": "Data was collected through ..."
}
]Pass the path via val_queries_path. If you omit it:
- AdaptiveRAG checks for
./validation_queries.json - If not found, the LLM auto-generates queries from your documents and saves them to that path
- You can then open the file, edit or extend the queries, and they will be used on the next run
| Parameter | Type | Default | Description |
|---|---|---|---|
llm_model |
str |
"gemma4:latest" |
Model for routing and answer generation |
embed_model |
str |
"nomic-embed-text:latest" |
Ollama model for embeddings (always local) |
kb_path |
str | None |
"./knowledge_base" |
Folder containing your documents |
val_queries_path |
str | None |
"./validation_queries.json" |
Validation Q&A file (auto-generated if missing) |
api_key |
str | None |
None |
Anthropic API key — enables Claude as the LLM |
openai_api_key |
str | None |
None |
OpenAI API key — enables OpenAI as the LLM |
| Parameter | Type | Description |
|---|---|---|
question |
str |
Natural-language question. Prefix with from:<file> to filter by source. |
source_filter |
str | None |
Restrict retrieval to a single filename |
| Field | Type | Description |
|---|---|---|
answer |
str |
The generated answer (str(result) also works) |
confidence |
float |
Self-assessed confidence, 0.0 – 1.0 |
retries |
int |
Number of reflection retries used |
strategy |
str |
One-line explanation of the retrieval strategy chosen |
trace |
list[str] |
Complete step-by-step decision log |
adaptiverag/
├── core/
│ ├── config.py # constants and defaults
│ ├── models.py # KBProfile, PipelineConfig dataclasses
│ └── runtime.py # shared runtime singleton (RT)
├── components/
│ ├── chunker.py # content-aware chunking strategies
│ ├── embedder.py # Ollama embedding wrapper
│ ├── retriever.py # ChromaDB retrieval
│ └── reranker.py # cross-encoder reranking (optional)
├── pipeline/
│ ├── tools.py # LangChain tools (retrieve, rerank, HyDE, generate)
│ ├── kb_analysis.py # KB profiling and heuristic config planning
│ └── file_loader.py # document loading (.txt, .pdf, .md, .docx)
├── graphs/
│ ├── setup_graph.py # build-time LangGraph agent
│ └── query_graph.py # per-query LangGraph agent
├── api.py # public Python API (build_rag, AdaptiveRAG, QueryResult)
└── main.py # CLI entry point
- Python ≥ 3.10
- Ollama running at
http://localhost:11434(for embeddings) - Core dependencies installed automatically:
langgraph,langchain-ollama,chromadb,pypdf,python-docx,numpy,tqdm
Contributions are welcome. Please open an issue first to discuss what you would like to change.
git clone https://github.com/navid72m/adaptiveRAG.git
cd adaptiveRAG
pip install -e ".[dev]"MIT © navid72m
