Skip to content

KenValenzuela/DocChat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 DocChat: Local Documentation Assistant

DocChat is an AI-powered chatbot that helps developers and data scientists interact with technical documentation using natural language. Built with Retrieval-Augmented Generation (RAG), it semantically searches embedded HTML docs and returns GPT-generated answers grounded in real content — not hallucinations.

Think ChatGPT, but grounded in the docs you care about.


🧠 Why I Built This

As a data scientist, I constantly found myself Googling the same questions:

  • "How do I merge two DataFrames in pandas?"
  • "What's the difference between .loc and .iloc?"
  • "What arguments does sns.catplot() support?"

General-purpose chatbots like ChatGPT were helpful — but often hallucinated or lacked the exact syntax. And searching docs manually felt inefficient.

So I built DocChat to fix this. It’s a documentation-first AI assistant that:

✅ Uses your local documentation (HTML)
✅ Searches it with semantic embeddings
✅ Answers questions using OpenAI GPT models
✅ Works even in offline or restricted environments (post-embedding)


🚀 Demo Screenshot

DocChat Streamlit Screenshot


✨ Features

  • 🔍 Semantic Search with FAISS — Embed and retrieve HTML docs with sentence-level accuracy
  • 🧠 GPT-Generated Answers — Use OpenAI’s GPT models to answer based on context
  • 💬 Streamlit UI — Chat-like interface with fallback prompts, dark mode, and "Explain this answer"
  • 🔄 Conversational Memory — Maintains full chat history per session
  • 📚 Multi-Doc Support — Easily switch between pandas, seaborn, python_docs, and more
  • 🧱 Modular Codebase — Clear folder structure for embedding, retrieval, and generation logic

🛠️ Tech Stack

Layer Tool
UI Streamlit
Embeddings SentenceTransformers (MiniLM)
Vector Search FAISS
LLM Generation OpenAI GPT-3.5
Docs Format HTML (locally hosted)
Config dotenv + modular scripts

📦 Installation

git clone https://github.com/KenValenzuela/DocChat.git
cd DocChat
python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages