RuoYi AI 快速入门指南

RuoYi AI 快速入门指南

企业级AI助手平台快速入门

开箱即用的智能AI平台，深度集成 FastGPT、扣子(Coze)、DIFY 等主流AI平台

📖 完整文档 | 🚀 在线体验 | 🐛 问题反馈

📋 目录

• 项目概述
• 核心特性
• 技术架构
• 环境要求
• 快速开始
• Dify集成配置
• 其他AI平台集成
• 常见问题
• 社区支持

🎯 项目概述

RuoYi AI 是一个基于Spring Boot 3.4构建的企业级AI助手平台，提供了完整的AI应用解决方案。它深度集成了多个主流AI平台，支持本地化部署，为企业提供安全可控的AI服务。

🌟 项目亮点

• 多平台集成: 支持FastGPT、扣子(Coze)、DIFY等主流AI平台
• 本地化RAG: 基于Langchain4j + BGE-large-zh-v1.5的私有知识库
• 实时对话: SSE/WebSocket流式响应，提供丝滑体验
• 企业级: 完整的权限管理、多租户支持、监控告警
• 开箱即用: 提供完整的前后端代码和部署方案

✨ 核心特性

🤖 智能AI引擎

• 多模型接入: OpenAI GPT-4、Azure、ChatGLM、通义千问、智谱AI等
• AI平台集成: 深度集成FastGPT、扣子(Coze)、DIFY等主流AI应用平台
• Spring AI MCP集成: 基于模型上下文协议，打造可扩展的AI工具生态系统
• 实时流式对话: 采用SSE/WebSocket技术，提供丝滑的对话体验
• AI编程助手: 内置智能代码分析和项目脚手架生成能力

🌟 AI平台生态集成

• FastGPT深度集成: 原生支持FastGPT API，包括知识库检索、工作流编排和上下文管理
• 扣子(Coze)官方SDK: 集成字节跳动扣子平台官方SDK，支持Bot对话和流式响应
• DIFY完整兼容: 使用DIFY Java Client，支持应用编排、工作流和知识库管理
• 统一聊天接口: 提供统一的聊天服务接口，支持多平台无缝切换和负载均衡

🧠 本地化RAG方案

• 私有知识库: 基于Langchain4j框架 + BGE-large-zh-v1.5中文向量模型
• 多种向量库: 支持Milvus、Weaviate、Qdrant等主流向量数据库
• 数据安全可控: 支持完全本地部署，保护企业数据隐私
• 灵活模型部署: 兼容Ollama、vLLM等本地推理框架

🎨 AI创作工具

• AI绘画创作: 深度集成DALL·E-3、MidJourney、Stable Diffusion
• 智能PPT生成: 一键将文本内容转换为精美演示文稿
• 多模态理解: 支持文本、图片、文档等多种格式的智能处理

🏗️ 技术架构

后端技术栈

Spring Boot 3.4
├── Spring AI (AI框架集成)
├── Langchain4j (RAG框架)
├── MyBatis Plus (ORM框架)
├── Sa-Token (权限认证)
├── Redis (缓存)
├── MySQL 8.0 (数据存储)
└── 向量数据库 (知识库存储)

前端技术栈

Vue 3
├── Vben Admin (后台管理)
├── Naive UI (组件库)
├── TypeScript (类型支持)
└── Vite (构建工具)

系统组件

• 文档处理: PDF、Word、Excel解析，图像智能分析
• 实时通信: WebSocket实时通信，SSE流式响应
• 系统监控: 完善的日志体系、性能监控、服务健康检查

💻 环境要求

基础环境

• Java: JDK 17+
• Maven: 3.6+
• Node.js: 16+ (前端开发需要)
• Git: 2.0+

数据库环境

• MySQL: 8.0+
• Redis: 6.0+

可选环境

• 向量数据库: Milvus/Weaviate/Qdrant (RAG功能)
• Docker: 20.0+ (容器化部署)

🚀 快速开始

1. 克隆项目

# 克隆后端项目
git clone https://github.com/ageerle/ruoyi-ai.git
cd ruoyi-ai

# 克隆前端项目 (可选)
git clone https://github.com/ageerle/ruoyi-web.git
git clone https://github.com/ageerle/ruoyi-admin.git

2. 数据库初始化

— 创建数据库
CREATE DATABASE `ruoyi–ai` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;

— 使用数据库
USE `ruoyi–ai`;

— 导入初始化数据
source script/sql/ruoyi–ai.sql;

3. 配置文件修改

编辑 ruoyi-admin/src/main/resources/application-local.yml:

# 数据库配置
spring:
datasource:
dynamic:
datasource:
master:
url: jdbc:mysql://localhost:3306/ruoyi–ai?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
username: root
password: your_mysql_password

# Redis配置
spring.data:
redis:
host: 127.0.0.1
port: 6379
password: your_redis_password
database: 0

# AI模型配置
spring:
ai:
openai:
api-key: sk–your–openai–key
base-url: https://api.openai.com/

4. 启动后端服务

# 进入管理模块
cd ruoyi-admin

# 编译项目
mvn clean compile

# 启动服务
mvn spring-boot:run -Dspring-boot.run.profiles=local

5. 启动前端服务

# 启动用户端 (ruoyi-web)
cd ruoyi-web
npm install
npm run dev

# 启动管理后台 (ruoyi-admin)
cd ruoyi-admin
npm install
npm run dev

6. 访问系统

• 用户端: http://localhost:3000
• 管理后台: http://localhost:3001
• API文档: http://localhost:8080/doc.html

默认账号：

• 管理员: admin / admin123
• 演示用户: demo / demo123

🔗 Dify集成配置

1. 在Dify平台创建应用

2. 配置模型设置

3. 发布应用

4. 在RuoYi AI中配置

模型名称: dify–gpt–4
API地址: https://api.dify.ai/v1/chat–messages
API密钥: app–xxxxxxxxxxxxx
模型类型: DIFY
模型描述: Dify平台GPT–4模型

5. 测试集成

代码实现说明

Dify集成核心代码位于 ruoyi-modules/ruoyi-chat/src/main/java/org/ruoyi/chat/service/chat/impl/DifyServiceImpl.java:

@Service
public class DifyServiceImpl implements IChatService {

@Override
public SseEmitter chat(ChatRequest chatRequest, SseEmitter emitter) {
// 获取模型配置
ChatModelVo chatModelVo = chatModelService.selectModelByName(chatRequest.getModel());

// 创建Dify客户端配置
DifyConfig config = DifyConfig.builder()
.baseUrl(chatModelVo.getApiHost())
.apiKey(chatModelVo.getApiKey())
.connectTimeout(5000)
.readTimeout(60000)
.writeTimeout(30000)
.build();

// 创建客户端
DifyClient chatClient = DifyClientFactory.createClient(config);

// 构建聊天消息
ChatMessage message = ChatMessage.builder()
.query(chatRequest.getPrompt())
.user(chatRequest.getUserId().toString())
.responseMode(ResponseMode.STREAMING)
.build();

// 发送流式消息
chatClient.sendChatMessageStream(message, new ChatStreamCallback() {
@Override
public void onMessage(MessageEvent event) {
emitter.send(event.getAnswer());
}

@Override
public void onMessageEnd(MessageEndEvent event) {
emitter.complete();
}

@Override
public void onError(ErrorEvent event) {
ChatServiceHelper.onStreamError(emitter, event.getMessage());
}
});

return emitter;
}
}

🔧 其他AI平台集成

FastGPT集成

扣子(Coze)集成

本地模型集成

支持通过Ollama、vLLM等框架部署本地模型：

# Ollama配置示例
ollama:
base-url: http://localhost:11434
model: llama2

❓ 常见问题

Q1: 启动时报数据库连接错误？

A: 检查MySQL服务是否启动，数据库连接信息是否正确，确保已创建数据库并导入初始化脚本。

Q2: Redis连接失败？

A: 确认Redis服务已启动，检查连接地址、端口和密码配置。

Q3: AI模型调用失败？

A: 检查API密钥是否正确，网络是否通畅，模型配置是否完整。

Q4: 前端页面无法访问？

A: 确认前端服务已启动，检查端口是否被占用，查看浏览器控制台错误信息。

Q5: 如何添加自定义AI模型？

A: 在管理后台的"AI模型管理"中添加新模型，配置相应的API地址和密钥。

Q6: 如何配置本地知识库？

A: 部署向量数据库(如Milvus)，在配置文件中设置向量库连接信息，上传文档进行向量化。

🌐 在线体验

• 用户端体验: web.pandarobot.chat

  • 账号: demo
  • 密码: demo123

• 管理后台: admin.pandarobot.chat

  • 账号: admin
  • 密码: admin123

📚 相关资源

官方资源

• 项目文档: https://doc.pandarobot.chat
• GitHub仓库: https://github.com/ageerle/ruoyi-ai
• Gitee仓库: https://gitee.com/ageerle/ruoyi-ai

相关项目

• 用户前端: ruoyi-web
• 管理后台: ruoyi-admin
• 前端简化版: ruoyi-element-ai

技术文档

• Spring AI: https://spring.io/projects/spring-ai
• Langchain4j: https://github.com/langchain4j/langchain4j
• Dify文档: https://docs.dify.ai/
• FastGPT文档: https://doc.fastgpt.in/

🤝 社区支持

交流群组

• QQ技术交流群: 扫描项目README中的二维码
• 微信技术交流群: 添加作者微信进群学习
• GitHub Discussions: 项目讨论区

问题反馈

• Bug报告: GitHub Issues
• 功能建议: GitHub Issues
• 贡献代码: 欢迎提交Pull Request

生态伙伴

• PPIO 派欧云 – 高性价比GPU算力服务
• 优云智算 – AI模型API服务
• 胜算云 – AI算力聚合服务

📄 开源协议

本项目采用 MIT 开源协议，详情请查看 LICENSE 文件。

⭐ 点个Star支持一下 • 🍴 Fork 开始贡献 • 📖 查看完整文档

用 ❤️ 打造，由 RuoYi AI 开源社区维护