Skip to content

Retrieval Augmented Generation (RAG) based chatbot template

License

Notifications You must be signed in to change notification settings

0xChron/rag-chatbot-assistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RAG AI Chatbot

A starter template for a Retrieval-Augmented Generation (RAG) chatbot that leverages PDF files as its primary knowledge source. Designed for easy setup, customization, and future expansion. Click the Use this template button on the upper right corner of this repository to use this sample template.

Table of Contents

Installation

  1. Clone the repo:
git clone https://github.com/0xChron/rag-chatbot-assistant.git
cd rag-chatbot-assistant
  1. Create .env file and input your own configuration:
cp .env.sample .env
  1. Create and activate a virtual environment (recommended):
python -m venv venv
source venv/bin/activate    # On Windows use `venv\Scripts\activate`
  1. Install dependencies:
pip install -r requirements.txt

Usage

  1. Create a folder named data/ and place your PDF documents there.

  2. Ingest documents using:

python ingest.py
  1. Start the chatbot:
python main.py
  1. You can modify settings in config.py file 👽

Features

  • 📄 Support PDF document ingestion
  • 🧠 RAG-based conversational AI
  • ⚙️ Configurable via config.py
  • 🛠️ Easy to extend for additional file types and features

Future enhancements

  • Additional file types support
  • Web-based UI

About

Retrieval Augmented Generation (RAG) based chatbot template

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages