How truongvi-ute/student-information-assistant-backend works
SIA Backend is the Spring Boot backend for a Student Information Assistant. Users authenticate and manage accounts, use AI conversations, exchange advisor chat, and access institutional documents; advisors can submit document-ingestion requests for administrator review. The sampled code confirms the REST-to-service boundaries for authentication, chatbot, and document workflows, plus object-storage behavior. README documents broader AI-service communication and WebSocket capabilities, but those unsampled implementations and several repository connections are shown only at subsystem level.
Main entry points: service Auth Services · AiChatbotService.java AI Conversation Logic · DocumentService.java Document Management · repository Data Repositories
Components 26
Identity & Access
- Auth API
src/main/java/vn/hcmute/edu/sia/controller/AuthController.java - Auth Services
src/main/java/vn/hcmute/edu/sia/service - JWT Security
src/main/java/vn/hcmute/edu/sia/security - Account Data
src/main/java/vn/hcmute/edu/sia/entity/Account.java
AI Assistant
- AI Chat API
src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java - AI Conversation Logic
src/main/java/vn/hcmute/edu/sia/service/AiChatbotService.java - AI Service Client
src/main/java/vn/hcmute/edu/sia/service/AiServiceClient.java - AI Conversation Data
src/main/java/vn/hcmute/edu/sia/entity/AIConversation.java
Document Knowledge
- Document API
src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java - Document Management
src/main/java/vn/hcmute/edu/sia/service/DocumentService.java - Document Records
src/main/java/vn/hcmute/edu/sia/entity/Document.java - Document Storage
src/main/java/vn/hcmute/edu/sia/service/implement/RustFsDocumentStorageService.java - RAG Request API
src/main/java/vn/hcmute/edu/sia/controller/DocumentRagRequestController.java - Request Review Logic
src/main/java/vn/hcmute/edu/sia/service/DocumentRagRequestService.java - RAG Request Records
src/main/java/vn/hcmute/edu/sia/entity/DocumentRagRequest.java - RAG Status Updates
src/main/java/vn/hcmute/edu/sia/service/implement/DocumentRagStatusServiceImpl.java
Advisor Chat
- Advisor Messaging
src/main/java/vn/hcmute/edu/sia/service/implement/ChatServiceImpl.java - Chat APIs
src/main/java/vn/hcmute/edu/sia/controller/ChatController.java - Chat Records
src/main/java/vn/hcmute/edu/sia/entity/ChatConversation.java - WebSocket Messaging
src/main/java/vn/hcmute/edu/sia/config/WebSocketConfig.java
Persistence & Integrations
- Data Repositories
src/main/java/vn/hcmute/edu/sia/repository - Redis State
src/main/java/vn/hcmute/edu/sia/repository/implement/RedisOtpRepository.java - Email Delivery
src/main/java/vn/hcmute/edu/sia/service/implement/ConsoleEmailServiceImpl.java
Other components
- Web Client
- AI Service
- RustFS Object Store
Connections 27
- Web Client → Auth API: requests
README.md - Auth API → Auth Services: delegates to
src/main/java/vn/hcmute/edu/sia/controller/AuthController.java - Auth Services → Account Data: manages
- Auth Services → Redis State: uses state
- Auth Services → Email Delivery: sends OTP
- Web Client → AI Chat API: asks questions
src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java - AI Chat API → AI Conversation Logic: delegates to
src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java - AI Conversation Logic → AI Service Client: calls
- AI Service Client → AI Service: communicates
README.md - AI Conversation Logic → AI Conversation Data: persists turns
- Web Client → Document API: manages documents
src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java - Document API → Document Management: delegates to
src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java - Document Management → Document Storage: stores files
- Document Storage → RustFS Object Store: reads and writes
src/main/java/vn/hcmute/edu/sia/service/implement/RustFsDocumentStorageService.java - Document Management → Document Records: manages records
- Web Client → RAG Request API: submits review
src/main/java/vn/hcmute/edu/sia/controller/DocumentRagRequestController.java - RAG Request API → Request Review Logic: delegates to
src/main/java/vn/hcmute/edu/sia/controller/DocumentRagRequestController.java - Request Review Logic → RAG Request Records: records decisions
- RAG Status Updates → Document Records: updates status
src/main/java/vn/hcmute/edu/sia/service/implement/DocumentRagStatusServiceImpl.java - Web Client → Chat APIs: sends messages
- Chat APIs → Advisor Messaging: delegates to
- Advisor Messaging → Chat Records: persists chat
- Advisor Messaging → WebSocket Messaging: publishes messages
- Auth Services → Data Repositories: accesses data
src/main/java/vn/hcmute/edu/sia/service/implement/DocumentRagStatusServiceImpl.java - Document Management → Data Repositories: accesses data
- Request Review Logic → Data Repositories: accesses data
- AI Conversation Logic → Data Repositories: accesses data