# truongvi-ute/student-information-assistant-backend architecture

> Architecture diagram of the GitHub repository truongvi-ute/student-information-assistant-backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/truongvi-ute/student-information-assistant-backend
- Repository: https://github.com/truongvi-ute/student-information-assistant-backend

## Overview

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: [`src/main/java/vn/hcmute/edu/sia/service`](https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/service) (Auth Services), [`src/main/java/vn/hcmute/edu/sia/service/AiChatbotService.java`](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/AiChatbotService.java) (AI Conversation Logic), [`src/main/java/vn/hcmute/edu/sia/service/DocumentService.java`](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/DocumentService.java) (Document Management), [`src/main/java/vn/hcmute/edu/sia/repository`](https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/repository) (Data Repositories)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_identity["Identity &amp; Access"]
  node_auth_api["Auth API"]
  node_auth_services["Auth Services"]
  node_security["JWT Security"]
  node_accounts[("Account Data<br/>[Account.java]")]
end

subgraph group_assistant["AI Assistant"]
  node_ai_api["AI Chat API"]
  node_ai_service["AI Conversation Logic"]
  node_ai_client["AI Service Client"]
  node_chat_data[("AI Conversation Data")]
end

subgraph group_documents["Document Knowledge"]
  node_doc_api["Document API"]
  node_doc_service["Document Management"]
  node_doc_entity[("Document Records<br/>[Document.java]")]
  node_storage["Document Storage"]
  node_rag_api["RAG Request API"]
  node_rag_service["Request Review Logic"]
  node_rag_requests[("RAG Request Records")]
  node_rag_status["RAG Status Updates"]
end

subgraph group_collaboration["Advisor Chat"]
  node_advisor_chat["Advisor Messaging"]
  node_chat_api["Chat APIs"]
  node_chat_records[("Chat Records")]
  node_websocket["WebSocket Messaging"]
end

subgraph group_platform["Persistence &amp; Integrations"]
  node_db_repos["Data Repositories"]
  node_redis[("Redis State")]
  node_email["Email Delivery"]
end

node_client(("Web Client"))
node_ai_service_ext{{"AI Service"}}
node_rustfs[("RustFS Object Store")]

node_client -->|"requests"| node_auth_api
node_auth_api -->|"delegates to"| node_auth_services
node_auth_services -.->|"manages"| node_accounts
node_auth_services -.->|"uses state"| node_redis
node_auth_services -.->|"sends OTP"| node_email
node_client -->|"asks questions"| node_ai_api
node_ai_api -->|"delegates to"| node_ai_service
node_ai_service -.->|"calls"| node_ai_client
node_ai_client -->|"communicates"| node_ai_service_ext
node_ai_service -.->|"persists turns"| node_chat_data
node_client -->|"manages documents"| node_doc_api
node_doc_api -->|"delegates to"| node_doc_service
node_doc_service -.->|"stores files"| node_storage
node_storage -->|"reads and writes"| node_rustfs
node_doc_service -.->|"manages records"| node_doc_entity
node_client -->|"submits review"| node_rag_api
node_rag_api -->|"delegates to"| node_rag_service
node_rag_service -.->|"records decisions"| node_rag_requests
node_rag_status -->|"updates status"| node_doc_entity
node_client -.->|"sends messages"| node_chat_api
node_chat_api -.->|"delegates to"| node_advisor_chat
node_advisor_chat -.->|"persists chat"| node_chat_records
node_advisor_chat -.->|"publishes messages"| node_websocket
node_auth_services -.->|"accesses data"| node_db_repos
node_doc_service -.->|"accesses data"| node_db_repos
node_rag_service -.->|"accesses data"| node_db_repos
node_ai_service -.->|"accesses data"| node_db_repos

click node_auth_api "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/AuthController.java"
click node_auth_services "https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/service"
click node_security "https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/security"
click node_accounts "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/Account.java"
click node_ai_api "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java"
click node_ai_service "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/AiChatbotService.java"
click node_ai_client "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/AiServiceClient.java"
click node_chat_data "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/AIConversation.java"
click node_doc_api "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java"
click node_doc_service "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/DocumentService.java"
click node_doc_entity "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/Document.java"
click node_storage "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/RustFsDocumentStorageService.java"
click node_rag_api "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/DocumentRagRequestController.java"
click node_rag_service "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/DocumentRagRequestService.java"
click node_rag_requests "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/DocumentRagRequest.java"
click node_rag_status "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/DocumentRagStatusServiceImpl.java"
click node_advisor_chat "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/ChatServiceImpl.java"
click node_chat_api "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/ChatController.java"
click node_chat_records "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/ChatConversation.java"
click node_db_repos "https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/repository"
click node_redis "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/repository/implement/RedisOtpRepository.java"
click node_email "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/ConsoleEmailServiceImpl.java"
click node_websocket "https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/config/WebSocketConfig.java"

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_auth_api,node_auth_services,node_security,node_accounts,node_client toneBlue
class node_ai_api,node_ai_service,node_ai_client,node_chat_data,node_rustfs toneAmber
class node_doc_api,node_doc_service,node_doc_entity,node_storage,node_rag_api,node_rag_service,node_rag_requests,node_rag_status toneMint
class node_advisor_chat,node_chat_api,node_chat_records,node_websocket toneRose
class node_db_repos,node_redis,node_email,node_ai_service_ext toneIndigo
```

## Components

### Identity & Access

- [Auth API](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/AuthController.java): `src/main/java/vn/hcmute/edu/sia/controller/AuthController.java`
- [Auth Services](https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/service): `src/main/java/vn/hcmute/edu/sia/service`
- [JWT Security](https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/security): `src/main/java/vn/hcmute/edu/sia/security`
- [Account Data](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/Account.java): `src/main/java/vn/hcmute/edu/sia/entity/Account.java`

### AI Assistant

- [AI Chat API](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java): `src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java`
- [AI Conversation Logic](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/AiChatbotService.java): `src/main/java/vn/hcmute/edu/sia/service/AiChatbotService.java`
- [AI Service Client](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/AiServiceClient.java): `src/main/java/vn/hcmute/edu/sia/service/AiServiceClient.java`
- [AI Conversation Data](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/AIConversation.java): `src/main/java/vn/hcmute/edu/sia/entity/AIConversation.java`

### Document Knowledge

- [Document API](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java): `src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java`
- [Document Management](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/DocumentService.java): `src/main/java/vn/hcmute/edu/sia/service/DocumentService.java`
- [Document Records](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/Document.java): `src/main/java/vn/hcmute/edu/sia/entity/Document.java`
- [Document Storage](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/RustFsDocumentStorageService.java): `src/main/java/vn/hcmute/edu/sia/service/implement/RustFsDocumentStorageService.java`
- [RAG Request API](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/DocumentRagRequestController.java): `src/main/java/vn/hcmute/edu/sia/controller/DocumentRagRequestController.java`
- [Request Review Logic](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/DocumentRagRequestService.java): `src/main/java/vn/hcmute/edu/sia/service/DocumentRagRequestService.java`
- [RAG Request Records](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/DocumentRagRequest.java): `src/main/java/vn/hcmute/edu/sia/entity/DocumentRagRequest.java`
- [RAG Status Updates](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/DocumentRagStatusServiceImpl.java): `src/main/java/vn/hcmute/edu/sia/service/implement/DocumentRagStatusServiceImpl.java`

### Advisor Chat

- [Advisor Messaging](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/ChatServiceImpl.java): `src/main/java/vn/hcmute/edu/sia/service/implement/ChatServiceImpl.java`
- [Chat APIs](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/controller/ChatController.java): `src/main/java/vn/hcmute/edu/sia/controller/ChatController.java`
- [Chat Records](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/entity/ChatConversation.java): `src/main/java/vn/hcmute/edu/sia/entity/ChatConversation.java`
- [WebSocket Messaging](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/config/WebSocketConfig.java): `src/main/java/vn/hcmute/edu/sia/config/WebSocketConfig.java`

### Persistence & Integrations

- [Data Repositories](https://github.com/truongvi-ute/student-information-assistant-backend/tree/main/src/main/java/vn/hcmute/edu/sia/repository): `src/main/java/vn/hcmute/edu/sia/repository`
- [Redis State](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/repository/implement/RedisOtpRepository.java): `src/main/java/vn/hcmute/edu/sia/repository/implement/RedisOtpRepository.java`
- [Email Delivery](https://github.com/truongvi-ute/student-information-assistant-backend/blob/main/src/main/java/vn/hcmute/edu/sia/service/implement/ConsoleEmailServiceImpl.java): `src/main/java/vn/hcmute/edu/sia/service/implement/ConsoleEmailServiceImpl.java`

### Other components

- **Web Client**
- **AI Service**
- **RustFS Object Store**

## Connections

- Web Client → Auth API: requests (evidence: `README.md`)
- Auth API → Auth Services: delegates to (evidence: `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 (evidence: `src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java`)
- AI Chat API → AI Conversation Logic: delegates to (evidence: `src/main/java/vn/hcmute/edu/sia/controller/AiChatbotController.java`)
- AI Conversation Logic → AI Service Client: calls
- AI Service Client → AI Service: communicates (evidence: `README.md`)
- AI Conversation Logic → AI Conversation Data: persists turns
- Web Client → Document API: manages documents (evidence: `src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java`)
- Document API → Document Management: delegates to (evidence: `src/main/java/vn/hcmute/edu/sia/controller/DocumentController.java`)
- Document Management → Document Storage: stores files
- Document Storage → RustFS Object Store: reads and writes (evidence: `src/main/java/vn/hcmute/edu/sia/service/implement/RustFsDocumentStorageService.java`)
- Document Management → Document Records: manages records
- Web Client → RAG Request API: submits review (evidence: `src/main/java/vn/hcmute/edu/sia/controller/DocumentRagRequestController.java`)
- RAG Request API → Request Review Logic: delegates to (evidence: `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 (evidence: `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 (evidence: `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
