Skip to content

devanand343/simple-rag-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📘 Project Title: Simple RAG System

🧠 Description

A Retrieval-Augmented Generation (RAG) tool that queries a vector database and provides concise answers (max 100 words) via CLI or Streamlit.


✨ Features

  • CLI Interface
    Run queries directly from the terminal via main.py.

  • Web Interface
    Interactive UI built with Streamlit in app.py.

  • Modular Logic
    Core RAG operations separated into the logic/ folder.

  • Security
    API keys managed via .env files.


⚙️ Installation & Setup

1. Clone the Repository

git clone <your-repo-link>
cd <your-repo-folder>

2. Create a Virtual Environment

python -m venv .myenv
source .myenv/bin/activate  # On Windows: .myenv\Scripts\activate

3. Install Dependencies

pip install -r requirements.txt

4. Environment Variables

OPENAI_API_KEY=your_actual_key_here

🚀 Usage

Run the CLI

python main.py

Run the Streamlit App

streamlit run app.py

📁 Project Structure

  • main.py
    Entry point for the CLI application.

  • app.py
    Entry point for the Streamlit web application.

  • logic/
    Contains the backend logic for document processing and vector database queries.

  • .env.example
    A template for required environment variables.

About

This is a simple RAG project that perform search in ChromaDB vector database and based on search results, using OpenAI LLM model gpt-4o-mini to answer in 100 words.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages