# udityamerit/neurolens-knowledge-retrieval-engine architecture

> Architecture diagram of the GitHub repository udityamerit/neurolens-knowledge-retrieval-engine, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/udityamerit/neurolens-knowledge-retrieval-engine
- Repository: https://github.com/udityamerit/neurolens-knowledge-retrieval-engine

## Overview

NeuroLens lets users add documents or webpages, retrieve relevant passages across a library, and ask questions answered by an LLM. Its browser-native workflow handles ingestion, BM25 retrieval, local persistence, and chat; an optional FastAPI/FAISS mode provides dense semantic retrieval. The interface also supports camera OCR, document previews, math rendering, voice input/output, and provider settings. The graph combines sampled source relationships with README-documented capabilities; some client integrations and backend internals are documented but not shown in source excerpts.

Main entry points: [`frontend/src/App.jsx`](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/App.jsx) (App coordinator), [`frontend/src/components/ChatPanel.jsx`](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/ChatPanel.jsx) (Chat panel), [`backend/rag_engine.py`](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/rag_engine.py) (RAG engine), [`frontend/src/components/CameraModal.jsx`](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/CameraModal.jsx) (Camera scanner)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_browser_ui["Browser experience"]
  node_app["App coordinator<br/>[App.jsx]"]
  node_sidebar["Library sidebar<br/>[Sidebar.jsx]"]
  node_chat["Chat panel<br/>[ChatPanel.jsx]"]
  node_settings["Provider settings<br/>[SettingsModal.jsx]"]
  node_camera["Camera scanner<br/>[CameraModal.jsx]"]
  node_preview["Document preview"]
  node_author["Author profile<br/>[AuthorModal.jsx]"]
end

subgraph group_client_knowledge["Client knowledge workflow"]
  node_ingest["Document ingestion<br/>[App.jsx]"]
  node_retrieval["Fair-share BM25<br/>[bm25Engine.js]"]
  node_storage[("IndexedDB storage<br/>[indexedStorage.js]")]
  node_safe_storage[("Storage fallback<br/>[storage.js]")]
  node_math["Math rendering<br/>[MathRenderer.jsx]"]
end

subgraph group_backend["Hybrid backend"]
  node_api["REST API<br/>[app.py]"]
  node_rag["RAG engine<br/>[rag_engine.py]"]
  node_faiss[("FAISS index<br/>[rag_engine.py]")]
  node_embedder["Text embeddings<br/>[rag_engine.py]"]
end

subgraph group_providers["External services"]
  node_groq{{"Groq LLM"}}
  node_openai{{"OpenAI LLM"}}
  node_huggingface{{"Hugging Face"}}
  node_elevenlabs{{"ElevenLabs TTS"}}
end

node_user(("User"))
node_web_speech{{"Web Speech API"}}
node_vision_llm{{"Vision LLM"}}

node_user -->|"adds documents"| node_sidebar
node_sidebar -->|"submits uploads"| node_app
node_app -->|"extracts and chunks"| node_ingest
node_app -->|"searches chunks"| node_retrieval
node_app -->|"persists library"| node_storage
node_storage -->|"falls back to"| node_safe_storage
node_user -->|"asks questions"| node_chat
node_chat -->|"submits query"| node_app
node_app -->|"selects context"| node_retrieval
node_app -->|"updates answers"| node_chat
node_chat -->|"renders messages"| node_math
node_preview -->|"renders chunk text"| node_math
node_app -->|"opens preview"| node_preview
node_app -->|"opens settings"| node_settings
node_app -->|"opens scanner"| node_camera
node_app -->|"opens profile"| node_author
node_user -->|"scans pages"| node_camera
node_camera -.->|"extracts image text"| node_vision_llm
node_chat -->|"requests speech"| node_elevenlabs
node_chat -->|"fallback speech"| node_web_speech
node_app -.->|"calls provider"| node_groq
node_app -.->|"calls provider"| node_openai
node_app -.->|"calls provider"| node_huggingface
node_app -.->|"optional hybrid request"| node_api
node_api -->|"delegates queries"| node_rag
node_rag -->|"embeds text"| node_embedder
node_embedder -->|"indexes vectors"| node_faiss
node_rag -.->|"generates answers"| node_groq

click node_app "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/App.jsx"
click node_sidebar "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/Sidebar.jsx"
click node_chat "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/ChatPanel.jsx"
click node_settings "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/SettingsModal.jsx"
click node_camera "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/CameraModal.jsx"
click node_preview "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/DocPreviewModal.jsx"
click node_author "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/AuthorModal.jsx"
click node_ingest "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/App.jsx"
click node_retrieval "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/utils/bm25Engine.js"
click node_storage "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/utils/indexedStorage.js"
click node_safe_storage "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/utils/storage.js"
click node_math "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/MathRenderer.jsx"
click node_api "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/app.py"
click node_rag "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/rag_engine.py"
click node_faiss "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/rag_engine.py"
click node_embedder "https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/rag_engine.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_sidebar,node_chat,node_settings,node_camera,node_preview,node_author,node_user toneBlue
class node_ingest,node_retrieval,node_storage,node_safe_storage,node_math toneAmber
class node_api,node_rag,node_faiss,node_embedder,node_web_speech toneMint
class node_groq,node_openai,node_huggingface,node_elevenlabs toneRose
class node_vision_llm toneIndigo
```

## Components

### Browser experience

- [App coordinator](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Library sidebar](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/Sidebar.jsx): `frontend/src/components/Sidebar.jsx`
- [Chat panel](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/ChatPanel.jsx): `frontend/src/components/ChatPanel.jsx`
- [Provider settings](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/SettingsModal.jsx): `frontend/src/components/SettingsModal.jsx`
- [Camera scanner](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/CameraModal.jsx): `frontend/src/components/CameraModal.jsx`
- [Document preview](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/DocPreviewModal.jsx): `frontend/src/components/DocPreviewModal.jsx`
- [Author profile](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/AuthorModal.jsx): `frontend/src/components/AuthorModal.jsx`

### Client knowledge workflow

- [Document ingestion](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Fair-share BM25](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/utils/bm25Engine.js): `frontend/src/utils/bm25Engine.js`
- [IndexedDB storage](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/utils/indexedStorage.js): `frontend/src/utils/indexedStorage.js`
- [Storage fallback](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/utils/storage.js): `frontend/src/utils/storage.js`
- [Math rendering](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/frontend/src/components/MathRenderer.jsx): `frontend/src/components/MathRenderer.jsx`

### Hybrid backend

- [REST API](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/app.py): `backend/app.py`
- [RAG engine](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/rag_engine.py): `backend/rag_engine.py`
- [FAISS index](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/rag_engine.py): `backend/rag_engine.py`
- [Text embeddings](https://github.com/udityamerit/neurolens-knowledge-retrieval-engine/blob/main/backend/rag_engine.py): `backend/rag_engine.py`

### External services

- **Groq LLM**
- **OpenAI LLM**
- **Hugging Face**
- **ElevenLabs TTS**

### Other components

- **User**
- **Web Speech API**
- **Vision LLM**

## Connections

- User → Library sidebar: adds documents (evidence: `README.md`)
- Library sidebar → App coordinator: submits uploads (evidence: `frontend/src/App.jsx`)
- App coordinator → Document ingestion: extracts and chunks (evidence: `README.md`)
- App coordinator → Fair-share BM25: searches chunks (evidence: `frontend/src/App.jsx`)
- App coordinator → IndexedDB storage: persists library (evidence: `frontend/src/App.jsx`)
- IndexedDB storage → Storage fallback: falls back to (evidence: `frontend/src/utils/indexedStorage.js`)
- User → Chat panel: asks questions (evidence: `README.md`)
- Chat panel → App coordinator: submits query (evidence: `frontend/src/App.jsx`)
- App coordinator → Fair-share BM25: selects context (evidence: `frontend/src/App.jsx`)
- App coordinator → Chat panel: updates answers (evidence: `frontend/src/App.jsx`)
- Chat panel → Math rendering: renders messages (evidence: `frontend/src/components/ChatPanel.jsx`)
- Document preview → Math rendering: renders chunk text (evidence: `frontend/src/components/DocPreviewModal.jsx`)
- App coordinator → Document preview: opens preview (evidence: `frontend/src/App.jsx`)
- App coordinator → Provider settings: opens settings (evidence: `frontend/src/App.jsx`)
- App coordinator → Camera scanner: opens scanner (evidence: `frontend/src/App.jsx`)
- App coordinator → Author profile: opens profile (evidence: `frontend/src/App.jsx`)
- User → Camera scanner: scans pages (evidence: `README.md`)
- Camera scanner → Vision LLM: extracts image text (evidence: `README.md`)
- Chat panel → ElevenLabs TTS: requests speech (evidence: `README.md`)
- Chat panel → Web Speech API: fallback speech (evidence: `README.md`)
- App coordinator → Groq LLM: calls provider (evidence: `README.md`)
- App coordinator → OpenAI LLM: calls provider (evidence: `README.md`)
- App coordinator → Hugging Face: calls provider (evidence: `README.md`)
- App coordinator → REST API: optional hybrid request (evidence: `README.md`)
- REST API → RAG engine: delegates queries (evidence: `backend/app.py`)
- RAG engine → Text embeddings: embeds text (evidence: `README.md`)
- Text embeddings → FAISS index: indexes vectors (evidence: `README.md`)
- RAG engine → Groq LLM: generates answers (evidence: `README.md`)
