Merge pull request 'refactor: 🔨 working Ollama migration' (#1) from migrate_to_ollama into main
Reviewed-on: #1
This commit was merged in pull request #1.
This commit is contained in:
@@ -1,36 +1,22 @@
|
||||
# 🐉 Dungeon Masters Vault: Local RAG Assistant
|
||||
# Dungeon Masters Vault: Local RAG Assistant
|
||||
|
||||
An advanced Retrieval-Augmented Generation (RAG) system designed for Dungeon Masters. This tool ingests markdown-based campaign notes, enriches them with AI-generated metadata, and provides an interactive terminal interface to query your world’s lore using **DSPy** and **Local LLMs**.
|
||||
An advanced Retrieval-Augmented Generation (RAG) system designed for Dungeon Masters. This tool ingests markdown-based campaign notes, enriches them with AI-generated metadata, and provides an interactive terminal interface to query your world's lore using **DSPy** and **Local LLMs**.
|
||||
|
||||
## ⚔️ Key Features
|
||||
## Key Features
|
||||
|
||||
* **Parallel Enrichment:** Utilizes a configurable multithreading to process multiple document chunks simultaneously across local LLM slots for high-speed ingestion.
|
||||
* **Deep Context Retrieval:** Unlike standard RAG, this system retrieves relevant chunks and then "peeks" at the full source file to provide the LLM with broader narrative context.
|
||||
* **Local-First:** Designed to run entirely on your hardware using **LM Studio**, keeping your campaign secrets private.
|
||||
* **Parallel Enrichment:** Configurable multithreading processes multiple document chunks simultaneously across local LLM slots for high-speed ingestion.
|
||||
* **Deep Context Retrieval:** Retrieves relevant chunks and "peeks" at the full source file to provide the LLM with broader narrative context.
|
||||
* **Local-First:** Runs entirely on your hardware using **Ollama**, keeping your campaign secrets private.
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
1. **Ingestion:** Scans `DATA_DIR` for `.md` files.
|
||||
2. **Chunking:** Splits documents into 800-character segments with overlap.
|
||||
3. **Enrichment:** A DSPy `IngestionAgent` analyzes each chunk to extract:
|
||||
* **Synopsis:** A one-sentence summary.
|
||||
* **Tags:** Plot points, item names, or themes.
|
||||
* **Entities:** Specific NPCs, Locations, or Factions.
|
||||
4. **Vector Store:** Chunks and metadata are embedded using `text-embedding-qwen3` and stored in a local **Turso** database.
|
||||
5. **Interactive RAG:** A terminal loop that uses **ReAct (Reasoning and Acting)** to answer queries based on retrieved context.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Setup
|
||||
## Setup
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* **UV [Link to install here](https://docs.astral.sh/uv/)**
|
||||
* **LM Studio:** Running a local server at `localhost:1234` (or your specific IP).
|
||||
* **Models:** * Inference & Embedding: Configurable for your preference. grab your model in LMStudio and update the conifg
|
||||
|
||||
* **[UV](https://docs.astral.sh/uv/)** — Python package manager
|
||||
* **Ollama** — Running a local server (default `localhost:11434`)
|
||||
* **Local Models** — Pull your inference and embedding models with `ollama pull`
|
||||
|
||||
### Installation
|
||||
|
||||
@@ -40,52 +26,52 @@ uv sync
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Usage
|
||||
## Usage
|
||||
|
||||
### 1. Ingest & Enrich
|
||||
### Ingest & Enrich
|
||||
|
||||
Run the ingestion script to process your markdown files and build the vector database.
|
||||
Process your markdown campaign files and build the vector database:
|
||||
|
||||
```bash
|
||||
uv run src/ingest.py
|
||||
```
|
||||
|
||||
### 2. Query the LLM
|
||||
### Query the LLM
|
||||
|
||||
Launch the interactive session to ask questions about your campaign.
|
||||
Launch the interactive session to ask questions about your campaign:
|
||||
|
||||
```bash
|
||||
uv run src/retrieve.py
|
||||
```
|
||||
|
||||
**Example Query:**
|
||||
**Example interaction:**
|
||||
|
||||
> `📝 Query: Why did the party get free bread at the Golden Grain Inn?`
|
||||
> `📜 AI RESPONSE: Based on the session notes from 'Session_12.md', the party received free bread because the Rogue successfully intimidated the baker's assistant, and the Cleric later performed a minor miracle (Thaumaturgy) that impressed the owner.`
|
||||
> Query: Why did the party get free bread at the Golden Grain Inn?
|
||||
>
|
||||
> Based on the session notes from 'Session_12.md', the party received free bread because the Rogue intimidated the baker's assistant and the Cleric performed Thaumaturgy to impress the owner.
|
||||
|
||||
---
|
||||
|
||||
## 📂 File Structure
|
||||
## File Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── config.yaml # Configuration for the app
|
||||
├── load_ingestion_llms.sh # script to load multiple LLMs (Run before ingest)
|
||||
├── config.yaml # App configuration
|
||||
├── load_ingestion_llms.sh # Script to load multiple LLMs (run before ingest)
|
||||
├── README.md
|
||||
├── ROADMAP.md
|
||||
├── src
|
||||
│ ├── config_loader.py # Loads the config yaml file
|
||||
│ ├── embedding.py # Class to talk to LMStudio Embedding Model Server
|
||||
│ ├── experts
|
||||
│ │ ├── ingestion_agent.py # Agent Class for ingestion enrichment
|
||||
│ │ └── retrieval_agent.py # Agent Class for retrieval, with tools and database calls
|
||||
│ ├── ingest.py # Ingestion script to load your DnD Campaign Notes
|
||||
│ └── retrieve.py # main Q&A for your notes
|
||||
├── data # GitIgnored Folder for Notes Database
|
||||
│ ├── dmv.db
|
||||
│ ├── dmv.db-wal
|
||||
│ ├── dmv.log
|
||||
│ └── time_file.txt
|
||||
├── src/
|
||||
│ ├── config_loader.py # Loads config.yaml
|
||||
│ ├── embedding.py # Ollama embedding model client
|
||||
│ ├── experts/
|
||||
│ │ ├── ingestion_agent.py # AI agent for document enrichment
|
||||
│ │ └── retrieval_agent.py # AI agent for queries, with tools and DB calls
|
||||
│ ├── ingest.py # Campaign notes ingestion script
|
||||
│ └── retrieve.py # Interactive Q&A interface
|
||||
├── data/ # Campaign database (gitignored)
|
||||
│ ├── dmv.db
|
||||
│ ├── dmv.log
|
||||
│ └── time_file.txt
|
||||
├── pyproject.toml
|
||||
├── LICENSE
|
||||
└── uv.lock
|
||||
@@ -93,12 +79,12 @@ uv run src/retrieve.py
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Configuration
|
||||
## Configuration
|
||||
|
||||
In `config.yaml`, you can adjust multiple things:
|
||||
Edit `config.yaml` to customize:
|
||||
|
||||
* Enrichment / embedding & Retrieval Mdels
|
||||
* DnD Notes Location (data_dir)
|
||||
* System Prompts for Ingestion & Retrieval Agents
|
||||
* Inference and embedding models
|
||||
* Campaign notes location (`data_dir`)
|
||||
* System prompts for ingestion and retrieval agents
|
||||
|
||||
---
|
||||
|
||||
+12
-12
@@ -1,24 +1,24 @@
|
||||
# --- Connection Settings ---
|
||||
api:
|
||||
base_url: "http://framework.tawny-bellatrix.ts.net:1234"
|
||||
base_url: "http://100.110.238.94:11434"
|
||||
api_version: "/v1/"
|
||||
|
||||
# --- Model Settings ---
|
||||
models:
|
||||
enrich: "lm_studio/qwen-" # will have an identifier, based on amount of active LLMs see ./load_ingestion_llms.sh
|
||||
embedding: "text-embedding-qwen3-embedding-8b"
|
||||
retrieval: "lm_studio/qwen/qwen3-30b-a3b-2507"
|
||||
expansion: "lm_studio/qwen/qwen3-30b-a3b-2507"
|
||||
enrich: "ollama/granite4.1:3b"
|
||||
embedding: "qwen3-embedding:4b"
|
||||
retrieval: "ollama/qwen3.6:latest"
|
||||
expansion: "ollama/granite4.1:3b"
|
||||
|
||||
# --- Ingestion Settings ---
|
||||
ingestion:
|
||||
data_dir: "/home/jake/DnD"
|
||||
db_path: "./data/"
|
||||
db_name: "dmv.db"
|
||||
active_llms: 2
|
||||
parallel_requests_per_llm: 2
|
||||
chunk_size: 800
|
||||
chunk_overlap: 100
|
||||
active_llms: 1
|
||||
parallel_requests_per_llm: 6
|
||||
chunk_size: 1200
|
||||
chunk_overlap: 200
|
||||
embedding_batch_size: 32
|
||||
time_file_location: "./data/time_file.txt"
|
||||
|
||||
@@ -29,7 +29,7 @@ ingestion_agent:
|
||||
Analyze the provided notes and extract a concise synopsis and relevant metadata.
|
||||
synopsis = A one-sentence summary of the document.
|
||||
tags = Relevant tags (NPCs, Locations, Items, Plot Points).
|
||||
entities = a list of Key names of people, places, or factions.
|
||||
entities = a list of names for people, places, or factions.
|
||||
"note -> synopsis:str, tags: list[str], entities: list[str]"
|
||||
|
||||
retrieval_agent:
|
||||
@@ -41,7 +41,7 @@ retrieval_agent:
|
||||
|
||||
expansion_agent:
|
||||
expansion_signature: |
|
||||
You are a query expansion expert, specialised in Dungeons and Dragons.
|
||||
Given a user's question, generate 3-5 similar but enhanced search queries that would help find more relevant information.
|
||||
You are an expert Dungeon Master's assistant.
|
||||
Given a user's question, generate 3-5 similar but enhanced search queries that would help find more relevant information in DnD notes.
|
||||
Each expanded query should be distinct and add different perspective to the original question.
|
||||
Return only the queries as a JSON list with key "queries"."""
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
lms load qwen-4b-instruct-2507 --parallel 2 --identifier "qwen-0" --ttl 1800
|
||||
lms load qwen-4b-instruct-2507 --parallel 2 --identifier "qwen-1" --ttl 1800
|
||||
# lms load qwen-4b-instruct-2507 --parallel 2 --identifier "qwen-2" --ttl 1800
|
||||
# lms load qwen-4b-instruct-2507 --parallel 2 --identifier "qwen-3" --ttl 1800
|
||||
# lms load qwen-4b-instruct-2507 --parallel 2 --identifier "qwen-4" --ttl 1800
|
||||
+3
-2
@@ -10,7 +10,7 @@ API_VERSION = CFG["api"]["api_version"]
|
||||
|
||||
class LocalLMEmbeddings(Embeddings):
|
||||
def __init__(self, model: str, base_url: str = API_BASE, batch_size: int = 32):
|
||||
self.url = f"{base_url}/{API_VERSION}embeddings"
|
||||
self.url = f"{base_url}/api/embed"
|
||||
self.model = model
|
||||
self.batch_size = batch_size
|
||||
|
||||
@@ -22,10 +22,11 @@ class LocalLMEmbeddings(Embeddings):
|
||||
response = requests.post(
|
||||
self.url, json=payload, timeout=120
|
||||
) # Longer timeout for batches
|
||||
# print(response)
|
||||
response.raise_for_status()
|
||||
data = response.json()
|
||||
# print(data)
|
||||
return [item["embedding"] for item in data["data"]]
|
||||
return data["embeddings"]
|
||||
except Exception as e:
|
||||
print(f"❌ Batch request failed: {e}")
|
||||
# Returning empty lists to maintain index integrity if needed,
|
||||
|
||||
@@ -18,7 +18,7 @@ EXPANSION_CONFIG = CFG["expansion_agent"]
|
||||
|
||||
def retrieve_from_turso(embedded_question, k=5):
|
||||
query = f"""
|
||||
SELECT file_path, synopsis, tags, entities, chunk_data,
|
||||
SELECT file_path, synopsis, tags, chunk_data,
|
||||
vector_distance_cos(embedding, vector32('{embedded_question}')) AS distance
|
||||
FROM notes
|
||||
ORDER BY distance ASC
|
||||
@@ -55,9 +55,7 @@ class DnDRAG(dspy.Module):
|
||||
base_url=API_BASE,
|
||||
# batch_size=1,
|
||||
)
|
||||
self.retrieval_lm = dspy.LM(
|
||||
model=CFG["models"]["retrieval"], api_base=API_BASE + CFG["api"]["api_version"]
|
||||
)
|
||||
self.retrieval_lm = dspy.LM(model=CFG["models"]["retrieval"], api_base=API_BASE)
|
||||
with dspy.context(lm=self.retrieval_lm, signature=ExpansionSignature):
|
||||
self.query_expander = dspy.Predict("question -> queries:list[str]")
|
||||
|
||||
@@ -68,9 +66,9 @@ class DnDRAG(dspy.Module):
|
||||
print("Enhancing Question")
|
||||
with dspy.context(lm=self.retrieval_lm):
|
||||
expanded_queries = self.query_expander(question=question).queries
|
||||
print("Enhanced Queries:")
|
||||
for q in expanded_queries:
|
||||
print(" ", q)
|
||||
# print("Enhanced Queries:")
|
||||
# for q in expanded_queries:
|
||||
# print(" ", q)
|
||||
all_embeddings = self.embeddings_model.embed_documents([question] + expanded_queries)
|
||||
# print(all_embeddings)
|
||||
all_results = []
|
||||
@@ -81,7 +79,7 @@ class DnDRAG(dspy.Module):
|
||||
seen = set()
|
||||
unique_results = []
|
||||
for row in all_results:
|
||||
key = (row[0], row[4])
|
||||
key = (row[0], row[3])
|
||||
if key not in seen:
|
||||
seen.add(key)
|
||||
unique_results.append(row)
|
||||
@@ -91,18 +89,18 @@ class DnDRAG(dspy.Module):
|
||||
source = row[0]
|
||||
synopsis = row[1]
|
||||
tags = row[2]
|
||||
entities = row[3]
|
||||
content = row[4]
|
||||
closeness = row[5]
|
||||
# entities = row[3]
|
||||
content = row[3]
|
||||
closeness = row[4]
|
||||
|
||||
context_parts.append(f"""
|
||||
--- Chunk {i + 1} from {source} ---
|
||||
synopsis: {synopsis},
|
||||
tags: {tags},
|
||||
entities: {entities},
|
||||
closeness: {closeness},
|
||||
{content}
|
||||
""")
|
||||
# entities: {entities},
|
||||
|
||||
context = "\n\n".join(context_parts)
|
||||
|
||||
|
||||
+15
-7
@@ -83,7 +83,7 @@ def enrich_chunks(chunks: list) -> list:
|
||||
|
||||
try:
|
||||
with dspy.context(
|
||||
lm=dspy.LM(model=f"{MODEL_BASE}{lm_index}", api_base=API_BASE + API_VERSION),
|
||||
lm=dspy.LM(model=f"{MODEL_BASE}", api_base=API_BASE),
|
||||
chat_template_kwargs={"enable_thinking": False},
|
||||
):
|
||||
response = IngestionAgent().ingest(note=chunk.page_content)
|
||||
@@ -140,10 +140,11 @@ def embed_chunks(chunks: List[Any], batch_size: int = EMBEDDING_BATCH_SIZE) -> L
|
||||
# Process chunks in batches
|
||||
for i in tqdm(range(0, total_chunks, batch_size), desc="Embedding batches"):
|
||||
batch = chunks[i : i + batch_size]
|
||||
print(f"🚀 Processing batch {(i // batch_size) + 1} (Size: {len(batch)})...")
|
||||
# print(f"🚀 Processing batch {(i // batch_size) + 1} (Size: {len(batch)})...")
|
||||
batch_content = [chunk.page_content for chunk in batch]
|
||||
try:
|
||||
batch_embeddings = embeddings_model.embed_documents(batch_content)
|
||||
# print(len(batch_embeddings[0]))
|
||||
# Process each chunk in the batch
|
||||
for j, (chunk, embedding) in enumerate(zip(batch, batch_embeddings)):
|
||||
# Extract metadata
|
||||
@@ -233,8 +234,15 @@ def save_to_db(chunk_dicts):
|
||||
# SQL with named placeholders for clarity and safety
|
||||
insert_sql = """
|
||||
INSERT INTO notes (
|
||||
file_path, file_name, chunk_data, synopsis, tags, entities, embedding, timestamp
|
||||
) VALUES (?, ?, ?, ?, ?, ?, vector32(?), ?)
|
||||
file_path,
|
||||
file_name,
|
||||
chunk_data,
|
||||
synopsis,
|
||||
tags,
|
||||
-- entities,
|
||||
embedding,
|
||||
timestamp
|
||||
) VALUES (?, ?, ?, ?, ?, vector32(?), ?)
|
||||
"""
|
||||
|
||||
# Prepare batch data: convert each dict to a tuple in correct order
|
||||
@@ -250,7 +258,7 @@ def save_to_db(chunk_dicts):
|
||||
entry["chunk_data"],
|
||||
entry["synopsis"],
|
||||
",".join(entry["tags"]), # Store as comma-separated string
|
||||
",".join(entry["entities"]), # Store as comma-separated string
|
||||
# ",".join(entry["entities"]), # Store as comma-separated string
|
||||
embedding_str,
|
||||
entry["timestamp"],
|
||||
)
|
||||
@@ -277,8 +285,8 @@ def create_db():
|
||||
chunk_data TEXT NOT NULL,
|
||||
synopsis TEXT,
|
||||
tags TEXT, -- comma-separated
|
||||
entities TEXT, -- comma-separated
|
||||
embedding F32_BLOB(4096),
|
||||
-- entities TEXT, -- comma-separated
|
||||
embedding F32_BLOB(2560),
|
||||
timestamp DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||
)
|
||||
""")
|
||||
|
||||
+1
-2
@@ -87,8 +87,7 @@ def main():
|
||||
dspy.configure(verbose_errors=True)
|
||||
dspy.configure(callbacks=[CallbackHandler(logger)])
|
||||
# 1. Setup the LLM
|
||||
print("🚀 Initializing Qwen-8B via LM Studio...")
|
||||
lm = dspy.LM(RETRIEVE_MODEL, api_base=API_BASE + API_VERSION)
|
||||
lm = dspy.LM(RETRIEVE_MODEL, api_base=API_BASE)
|
||||
dspy.configure(lm=lm)
|
||||
|
||||
# 2. Load the RAG System (only happens once!)
|
||||
|
||||
Reference in New Issue
Block a user