# ageerle/ruoyi-ai architecture

> Architecture diagram of the GitHub repository ageerle/ruoyi-ai, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ageerle/ruoyi-ai
- Repository: https://github.com/ageerle/ruoyi-ai

## Overview

RuoYi AI is an enterprise AI assistant platform. Its main user journey is submitting a request to an AI capability and receiving a streamed or ordinary result; documented branches include multi-agent/tool use, knowledge retrieval, and visual workflows. The backend also provides account access, knowledge administration, and shared platform services. The graph preserves README capabilities, but several implementation paths were not sampled, so those links are marked as unverified rather than asserted as source-level calls.

Main entry points: [`ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatService.java`](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatService.java) (Chat and agents), [`ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java`](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java) (Knowledge fragments), [`ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysLoginService.java`](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysLoginService.java) (Login service), [`ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java`](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java) (Workflow engine)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["Access and platform"]
  node_login["Login service"]
  node_register["Registration service"]
  node_auth_api["Authentication API"]
end

subgraph group_assistant["AI assistant"]
  node_chat["Chat and agents<br/>[IChatService.java]"]
  node_model["Model management"]
  node_multimodal["Media generation"]
  node_tools["MCP tools"]
  node_skills["Skills"]
  node_chat_contracts["Chat contracts<br/>[ErrorEnum.java]"]
end

subgraph group_knowledge["Knowledge and retrieval"]
  node_knowledge_admin["Knowledge fragments"]
  node_retrieval["Knowledge retrieval"]
  node_vector_store[("Vector databases")]
end

subgraph group_workflow["Workflow orchestration"]
  node_workflow_design["Workflow management"]
  node_workflow_nodes["Node management"]
  node_workflow_engine["Workflow engine"]
  node_workflow_runtime["Workflow runtime"]
  node_sse["SSE streaming"]
end

subgraph group_shared["Shared services"]
  node_common_response["API response model<br/>[R.java]"]
  node_common_web["Web base controller"]
  node_tenant["Tenant context<br/>[TenantHelper.java]"]
  node_paging["Pagination<br/>[PageQuery.java]"]
  node_core["Core utilities"]
end

node_user(("Platform user"))

node_user -.->|"authenticates"| node_auth_api
node_auth_api -.->|"delegates login"| node_login
node_user -.->|"registers"| node_register
node_user -.->|"sends request"| node_chat
node_chat -.->|"selects model"| node_model
node_chat -.->|"uses tools"| node_tools
node_chat -.->|"uses skills"| node_skills
node_chat -.->|"generates media"| node_multimodal
node_user -->|"manages knowledge"| node_knowledge_admin
node_knowledge_admin -->|"tests retrieval"| node_retrieval
node_retrieval -.->|"queries vectors"| node_vector_store
node_user -.->|"designs workflow"| node_workflow_design
node_workflow_design -.->|"configures nodes"| node_workflow_nodes
node_user -.->|"runs workflow"| node_workflow_engine
node_workflow_engine -->|"creates runtime"| node_workflow_runtime
node_workflow_engine -->|"streams status"| node_sse
node_knowledge_admin -->|"extends"| node_common_web
node_knowledge_admin -->|"accepts paging"| node_paging
node_knowledge_admin -->|"returns envelope"| node_common_response
node_register -->|"checks tenant"| node_tenant
node_login -->|"resolves tenant"| node_tenant
node_login -->|"uses utilities"| node_core

click node_login "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysLoginService.java"
click node_register "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysRegisterService.java"
click node_chat "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatService.java"
click node_model "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatModelService.java"
click node_multimodal "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/image/IImageGenerationService.java"
click node_tools "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/mcp/service/core/LangChain4jMcpToolProviderService.java"
click node_skills "https://github.com/ageerle/ruoyi-ai/tree/main/ruoyi-admin/src/main/resources/skills"
click node_knowledge_admin "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java"
click node_retrieval "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/service/retrieval/KnowledgeRetrievalService.java"
click node_workflow_design "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowService.java"
click node_workflow_nodes "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowNodeService.java"
click node_workflow_engine "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java"
click node_workflow_runtime "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowRuntimeService.java"
click node_sse "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java"
click node_auth_api "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-admin/src/main/java/org/ruoyi/controller/AuthController.java"
click node_common_response "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-core/src/main/java/org/ruoyi/common/core/domain/R.java"
click node_common_web "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-web/src/main/java/org/ruoyi/common/web/core/BaseController.java"
click node_tenant "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-tenant/src/main/java/org/ruoyi/common/tenant/helper/TenantHelper.java"
click node_paging "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-mybatis/src/main/java/org/ruoyi/common/mybatis/core/page/PageQuery.java"
click node_core "https://github.com/ageerle/ruoyi-ai/tree/main/ruoyi-common/ruoyi-common-core/src/main/java/org/ruoyi/common/core"
click node_chat_contracts "https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/enums/ErrorEnum.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_login,node_register,node_auth_api,node_user toneBlue
class node_chat,node_model,node_multimodal,node_tools,node_skills,node_chat_contracts toneAmber
class node_knowledge_admin,node_retrieval,node_vector_store toneMint
class node_workflow_design,node_workflow_nodes,node_workflow_engine,node_workflow_runtime,node_sse toneRose
class node_common_response,node_common_web,node_tenant,node_paging,node_core toneIndigo
```

## Components

### Access and platform

- [Login service](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysLoginService.java): `ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysLoginService.java`
- [Registration service](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysRegisterService.java): `ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysRegisterService.java`
- [Authentication API](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-admin/src/main/java/org/ruoyi/controller/AuthController.java): `ruoyi-admin/src/main/java/org/ruoyi/controller/AuthController.java`

### AI assistant

- [Chat and agents](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatService.java): `ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatService.java`
- [Model management](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatModelService.java): `ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/chat/IChatModelService.java`
- [Media generation](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/image/IImageGenerationService.java): `ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/service/image/IImageGenerationService.java`
- [MCP tools](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/mcp/service/core/LangChain4jMcpToolProviderService.java): `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/mcp/service/core/LangChain4jMcpToolProviderService.java`
- [Skills](https://github.com/ageerle/ruoyi-ai/tree/main/ruoyi-admin/src/main/resources/skills): `ruoyi-admin/src/main/resources/skills`
- [Chat contracts](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/enums/ErrorEnum.java): `ruoyi-common/ruoyi-common-chat/src/main/java/org/ruoyi/common/chat/enums/ErrorEnum.java`

### Knowledge and retrieval

- [Knowledge fragments](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java): `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java`
- [Knowledge retrieval](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/service/retrieval/KnowledgeRetrievalService.java): `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/service/retrieval/KnowledgeRetrievalService.java`
- **Vector databases**

### Workflow orchestration

- [Workflow management](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowService.java): `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowService.java`
- [Node management](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowNodeService.java): `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowNodeService.java`
- [Workflow engine](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java): `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java`
- [Workflow runtime](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowRuntimeService.java): `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowRuntimeService.java`
- [SSE streaming](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java): `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java`

### Shared services

- [API response model](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-core/src/main/java/org/ruoyi/common/core/domain/R.java): `ruoyi-common/ruoyi-common-core/src/main/java/org/ruoyi/common/core/domain/R.java`
- [Web base controller](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-web/src/main/java/org/ruoyi/common/web/core/BaseController.java): `ruoyi-common/ruoyi-common-web/src/main/java/org/ruoyi/common/web/core/BaseController.java`
- [Tenant context](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-tenant/src/main/java/org/ruoyi/common/tenant/helper/TenantHelper.java): `ruoyi-common/ruoyi-common-tenant/src/main/java/org/ruoyi/common/tenant/helper/TenantHelper.java`
- [Pagination](https://github.com/ageerle/ruoyi-ai/blob/main/ruoyi-common/ruoyi-common-mybatis/src/main/java/org/ruoyi/common/mybatis/core/page/PageQuery.java): `ruoyi-common/ruoyi-common-mybatis/src/main/java/org/ruoyi/common/mybatis/core/page/PageQuery.java`
- [Core utilities](https://github.com/ageerle/ruoyi-ai/tree/main/ruoyi-common/ruoyi-common-core/src/main/java/org/ruoyi/common/core): `ruoyi-common/ruoyi-common-core/src/main/java/org/ruoyi/common/core`

### Other components

- **Platform user**

## Connections

- Platform user → Authentication API: authenticates
- Authentication API → Login service: delegates login (evidence: `ruoyi-admin/src/main/java/org/ruoyi/controller/AuthController.java`)
- Platform user → Registration service: registers
- Platform user → Chat and agents: sends request
- Chat and agents → Model management: selects model
- Chat and agents → MCP tools: uses tools
- Chat and agents → Skills: uses skills
- Chat and agents → Media generation: generates media
- Platform user → Knowledge fragments: manages knowledge (evidence: `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java`)
- Knowledge fragments → Knowledge retrieval: tests retrieval (evidence: `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java`)
- Knowledge retrieval → Vector databases: queries vectors
- Platform user → Workflow management: designs workflow
- Workflow management → Node management: configures nodes (evidence: `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/service/WorkflowService.java`)
- Platform user → Workflow engine: runs workflow
- Workflow engine → Workflow runtime: creates runtime (evidence: `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java`)
- Workflow engine → SSE streaming: streams status (evidence: `ruoyi-modules/ruoyi-aiflow/src/main/java/org/ruoyi/workflow/workflow/WorkflowEngine.java`)
- Knowledge fragments → Web base controller: extends (evidence: `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java`)
- Knowledge fragments → Pagination: accepts paging (evidence: `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java`)
- Knowledge fragments → API response model: returns envelope (evidence: `ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/controller/knowledge/KnowledgeFragmentController.java`)
- Registration service → Tenant context: checks tenant (evidence: `ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysRegisterService.java`)
- Login service → Tenant context: resolves tenant (evidence: `ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysLoginService.java`)
- Login service → Core utilities: uses utilities (evidence: `ruoyi-modules/ruoyi-system/src/main/java/org/ruoyi/system/service/SysLoginService.java`)
