title	CorpGuide AI
emoji	🤖
colorFrom	blue
colorTo	indigo
sdk	docker
pinned	false
app_port	7860

CorpGuideAI - HR Policy Assistant

CorpGuideAI is an advanced AI-powered assistant designed to help employees navigate and understand internal HR policies. Leveraging Retrieval-Augmented Generation (RAG), it provides accurate, context-aware answers based on your organization's PDF documents.

🚀 Features

• RAG Architecture: Combines vector search with generative AI for precise answers.
• LLM Integration: Powered by Groq (using Llama models) for fast and efficient inference.
• Vector Database: Uses ChromaDB for efficient document storage and retrieval.
• Smart Ingestion:
  • Extracts text from PDFs.
  • Improves retrieval speed and accuracy with semantic chunking.
  • Uses Alibaba-NLP/gte-multilingual-base for robust multilingual support.
• Chat History Management: Maintains context across the conversation session (Reset supported).
• FastAPI Backend: A high-performance API to serve requests.
• Docker Support: Containerized for easy deployment.

🛠️ Tech Stack

• Language: Python 3.10+
• Backend: FastAPI, Uvicorn
• AI/ML: LangChain, HuggingFace, ChromaDB, Groq
• Tools: pypdf, sentence-transformers, Docker

📂 Project Structure

CorpGuideAI-HR-Policy-Assistant/
├── api/
│   ├── main.py              # FastAPI application & entry point
│   ├── schemas.py           # Pydantic models
├── config/
│   ├── settings.py          # Configuration settings
├── core/
│   ├── rag_pipeline.py      # Core RAG logic & Chat History
│   ├── prompts.py           # Prompt templates
├── data/                    # PDF documents storage
├── services/
│   ├── document_processor.py
│   ├── vector_store.py
│   ├── llm_client.py
├── ingest.py                # Document ingestion script
├── Dockerfile               # Docker container configuration
├── requirements.txt         # Dependencies
└── README.md                # Documentation

⚡ Prerequisites

• Python 3.10+
• Groq API Key: Get it from Groq Console.

📦 Installation & Usage

Option 1: Local Installation

1. Clone & Setup:

   git clone <repository-url>
   cd CorpGuideAI-HR-Policy-Assistant
   python -m venv venv
   
   # Windows
   venv\Scripts\activate
   # macOS/Linux
   source venv/bin/activate
   
   pip install -r requirements.txt

2. Environment Variables: Create a .env file:

   GROQ_API_KEY=your_groq_api_key_here

3. 1. Ingest Documents

Place your HR policy PDF files in the data/ directory.

Note: The system automatically ingests documents from the data/ directory every time the server starts. This ensures your database is always fresh and in sync with your files.

2. Start the API Server

Launch the FastAPI server:

uvicorn api.main:app --reload

The API will be accessible at: `http://localhost:8000`

Option 2: Docker

1. Build Image:

   docker build -t corpguide-ai .

2. Run Container:

   docker run -p 7860:7860 --env-file .env corpguide-ai

   The API will be accessible at: http://localhost:7860

🔗 API Endpoints

• GET /: Health check / Root.
• POST /chat: Chat endpoint.
  • Body: { "question": "..." } (History managed internally)

📄 License

MIT License - see LICENSE file.