Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HugoX2003/nisira-assistant/llms.txt

Use this file to discover all available pages before exploring further.

NISIRA Assistant is a full-stack Retrieval-Augmented Generation (RAG) conversational assistant built for organizations that need accurate, document-grounded answers. Users submit natural-language questions; the system retrieves the most relevant document chunks via hybrid search, passes them to an LLM, and returns a cited response — all within a React chat interface backed by a Django REST API.

Introduction

Learn what NISIRA Assistant is, how it works, and when to use it.

Quickstart

Get NISIRA Assistant running locally in minutes with Docker.

Architecture

Explore the full system architecture: backend, RAG pipeline, and frontend.

API Reference

Browse every REST endpoint with parameters, request bodies, and responses.

Key Features

Hybrid RAG Pipeline

60% semantic search via pgvector/ChromaDB + 40% lexical BM25-style search for maximum recall.

Adaptive Retrieval

Dynamically selects 3–15 documents per query based on complexity scoring.

Multi-Provider LLMs

Plug in Gemini 2.0 Flash, OpenRouter, or Groq — swap providers via environment variables.

Google Drive Sync

Automatically ingest PDF, DOCX, PPTX, XLSX, and TXT files from a Drive folder.

RAG Evaluation Metrics

Built-in Precision@k, Recall@k, Faithfulness, Hallucination Rate, and WER tracking.

Admin Panel

React-based dashboard for managing documents, embeddings, and viewing system metrics.

Get Up and Running

1

Clone the repository

git clone https://github.com/HugoX2003/nisira-assistant.git
cd nisira-assistant
2

Configure environment variables

Copy the example environment file and set your API keys and database credentials.
cp backend/.env.local.example backend/.env
At minimum, set GOOGLE_API_KEY (or another LLM provider key) and SECRET_KEY. See Environment Variables for the full reference.
3

Start with Docker Compose

docker-compose up
This starts MySQL, the Django backend on port 8000, and the React frontend on port 3000.
4

Initialize the RAG system

Open http://localhost:3000, log in as admin, then trigger document ingestion from the Admin Panel — or call the RAG initialize endpoint directly.
For production deployments with PostgreSQL and pgvector, see the Docker Production and DigitalOcean guides.

Build docs developers (and LLMs) love