How ivandrf/rag-manual-searcher works
RAG-manual-searcher is a FastAPI service for authenticated manual search and chat over university math notes, with user registration/login and administrator controls. The main path is a chat request through the API to RAG retrieval, which ranks note chunks and formats a context prompt; the available excerpts do not show the final model-request wiring. Authentication and administration form a separate branch backed by PostgreSQL and Redis. The README provides no further capability detail, and some retrieval modules are represented from the source index rather than inspected excerpts.
Main entry points: auth.py Auth endpoints · admin.py Admin endpoints · dependencies.py API dependencies · main.py FastAPI app
Components 21
API and access
- FastAPI app
src/app/main.py - Chat endpoint
src/api/chat.py - API schemas
src/domain/schemas.py - API dependencies
src/api/dependencies.py - API utilities
src/api/utils.py
Identity and administration
- Auth endpoints
src/api/auth.py - Admin endpoints
src/api/admin.py - Access middleware
src/api/middleware.py - Identity rules
src/domain/rules.py
Manual retrieval
- RAG prompt builder
src/infrastructure/rag/rag.py - BM25 retrieval
src/infrastructure/rag/bm25.py - Text chunking
src/infrastructure/rag/chuncking.py - Manual text corpus
student_book_txt
Persistence
- ORM models
src/domain/models.py - User repository
src/infrastructure/repository/postgresql/user_repo.py - Block-list repository
src/infrastructure/repository/redis/block_repo.py - PostgreSQL connection
src/infrastructure/repository/postgresql/connection.py - Redis connection
src/infrastructure/repository/redis/connection.py - PostgreSQL
- Redis
Other components
- User
Connections 25
- User → FastAPI app: sends requests
- FastAPI app → Auth endpoints: registers routes
src/app/main.py - FastAPI app → Admin endpoints: registers routes
src/app/main.py - FastAPI app → Chat endpoint: registers routes
src/app/main.py - Chat endpoint → RAG prompt builder: requests retrieval
src/api/chat.py - RAG prompt builder → BM25 retrieval: retrieves chunks
src/infrastructure/rag/rag.py - BM25 retrieval → Text chunking: uses chunks
src/infrastructure/rag/bm25.py - Auth endpoints → User repository: looks up and adds users
src/api/auth.py - Auth endpoints → Identity rules: checks credentials
src/api/auth.py - Auth endpoints → API utilities: creates token cookies
src/api/auth.py - Admin endpoints → Access middleware: requires admin access
src/api/admin.py - Admin endpoints → User repository: manages users
src/api/admin.py - Admin endpoints → Block-list repository: updates block list
src/api/admin.py - Access middleware → Identity rules: decodes tokens
src/api/middleware.py - Access middleware → Block-list repository: checks blocked users
src/api/middleware.py - User repository → ORM models: queries users
src/infrastructure/repository/postgresql/user_repo.py - API dependencies → PostgreSQL connection: creates session maker
src/api/dependencies.py - API dependencies → Redis connection: creates Redis client
src/api/dependencies.py - API dependencies → PostgreSQL: opens connection
- API dependencies → Redis: opens connection
- User repository → PostgreSQL: queries through session
- Block-list repository → Redis: accesses block list
- Chat endpoint → API schemas: uses request schema
src/api/chat.py - Auth endpoints → API schemas: uses user schemas
src/api/auth.py - Admin endpoints → API schemas: uses admin schemas
src/api/admin.py