196 lines
10 KiB
Markdown
196 lines
10 KiB
Markdown
<!-- WEHUB_ZH_README -->
|
||
> [!NOTE]
|
||
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
|
||
> [English](./README.en.md) · [原始项目](https://github.com/xerrors/Yuxi) · [上游 README](https://github.com/xerrors/Yuxi/blob/HEAD/README.md)
|
||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||
|
||
<div align="center">
|
||
<h1>Yuxi</h1>
|
||
|
||
<p><strong>结合 RAG 与知识图谱的多租户智能体平台</strong><br/>让企业知识可被检索、推理,并由智能体交付</p>
|
||
|
||
[](https://github.com/xerrors/Yuxi/blob/main/docker-compose.yml)
|
||
[](https://github.com/xerrors/Yuxi/issues)
|
||
[](https://github.com/xerrors/Yuxi/blob/main/LICENSE)
|
||
[](https://deepwiki.com/xerrors/Yuxi)
|
||
[](https://zread.ai/xerrors/Yuxi)
|
||
[](https://www.bilibili.com/video/BV1TZEx6NEit/)
|
||
|
||
<a href="https://trendshift.io/repositories/24335" target="_blank"><img src="https://trendshift.io/api/badge/repositories/24335" alt="xerrors%2FYuxi | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||
|
||
[[Docs]](https://xerrors.github.io/Yuxi) · [[中文]](README.md)
|
||
|
||
</div>
|
||
|
||

|
||
|
||
**图片由 GPT-Image-2 生成。**
|
||
|
||
## 简介
|
||
|
||
Yuxi 是一个由大语言模型(LLM)驱动的平台,用于构建知识库与知识图谱智能体。它将 **RAG 检索**、**基于 Milvus 的知识库内图谱**,以及 **LangGraph 多智能体编排** 统一于单一多租户工作空间:管理员配置知识库、模型与权限,用户则可在类 ChatGPT 的界面中与智能体对话——智能体可挂载 Skills、MCP、子智能体(SubAgents)与沙箱工具,并获得附带引用来源、基于图谱的推理以及可交付产物的回答。
|
||
|
||
导航:[简介](https://xerrors.github.io/Yuxi/) | [快速开始](https://xerrors.github.io/Yuxi/intro/quick-start) | [路线图](https://xerrors.github.io/Yuxi/develop-guides/roadmap); 最新更新请参见 [更新日志](https://xerrors.github.io/Yuxi/develop-guides/changelog).
|
||
|
||
## 核心功能
|
||
|
||
- 🤖 **智能体开发** — 基于 LangGraph,支持子智能体(SubAgents)、Skills、MCP、Tools 与中间件;长时间运行的任务在后台 worker 上异步执行,并由沙箱文件系统支持工具产物的持久化、预览与下载。
|
||
- 📚 **知识库(RAG)** — 多格式文档解析(MinerU / PaddleX / OCR),可配置 Embedding 与 Rerank 模型,知识库评测,应用内 PDF / 图片预览,检索来源回填为对话引用。
|
||
- 🕸️ **知识图谱** — 在 Milvus 知识库内构建、可视化并检索实体关系图谱,再将图谱命中与分块检索融合,供智能体推理使用。
|
||
- 🏢 **多租户与权限** — 用户 / 部门级访问控制,统一的模型提供商配置,以及面向外部系统集成的 API Key 认证。
|
||
- ⚙️ **平台与工程** — Vue + FastAPI 架构,开箱即用的 Docker Compose 部署,深色模式,轻量级 LITE 启动模式,以及生产级编排能力。
|
||
|
||
## 技术栈
|
||
|
||
| 层级 | 技术 |
|
||
| --- | --- |
|
||
| 前端 | Vue 3 · Vite · Pinia |
|
||
| 后端 | FastAPI · LangGraph · ARQ(异步 worker) |
|
||
| 存储 | PostgreSQL · Redis · MinIO · Milvus · Neo4j |
|
||
| 文档解析 | MinerU · PaddleX · RapidOCR |
|
||
| 部署 | Docker Compose |
|
||
|
||
|
||

|
||
|
||
## 快速开始
|
||
|
||
**前置条件**:[Docker](https://docs.docker.com/get-docker/) 与 Docker Compose 已安装,并至少拥有一个兼容 OpenAI 的 LLM API。
|
||
|
||
**1. 克隆并初始化**
|
||
|
||
```bash
|
||
git clone --branch v0.7.1.beta1 --depth 1 https://github.com/xerrors/Yuxi.git
|
||
cd Yuxi
|
||
|
||
# Linux/macOS
|
||
./scripts/init.sh
|
||
|
||
# Windows PowerShell
|
||
.\scripts\init.ps1
|
||
```
|
||
|
||
**2. 使用 Docker 启动**
|
||
|
||
```bash
|
||
docker compose up --build
|
||
```
|
||
|
||
**3. 打开平台**
|
||
|
||
服务就绪后,在浏览器中打开 `http://localhost:5173`,并使用初始化时生成的管理员账号登录。
|
||
|
||
> 💡 若不需要知识库 / 图谱等重型依赖,可运行 `make up-lite` 以启用轻量级 LITE 模式,冷启动更快。更多部署细节请参阅[文档](https://xerrors.github.io/Yuxi)。
|
||
|
||
## 示例与演示
|
||
|
||
<table>
|
||
<tr>
|
||
<td align="center">
|
||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260326125852369.png" width="100%" alt="Home"/>
|
||
<br/>
|
||
<strong>首页</strong>
|
||
</td>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/d3e4fe09-fa48-4686-93ea-2c50300ade21" width="100%" alt="Dashboard statistics"/>
|
||
<br/>
|
||
<strong>仪表盘统计</strong>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260326130528866.png" width="100%" alt="Agent configuration"/>
|
||
<br/>
|
||
<strong>智能体配置</strong>
|
||
</td>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/06d56525-69bf-463a-8360-286b2cf8796f" width="100%" alt="Knowledge base invocation"/>
|
||
<br/>
|
||
<strong>知识库调用</strong>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/0548d89c-15a3-47cf-ba87-1b544f7dd749" width="100%" alt="Create knowledge base"/>
|
||
<br/>
|
||
<strong>创建知识库</strong>
|
||
</td>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/21396d04-376b-4e9a-8139-eec8c3cc915a" width="100%" alt="Knowledge base management"/>
|
||
<br/>
|
||
<strong>知识库管理</strong>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/fc46a14b-16fb-47ea-84a0-148a451f3012" width="100%" alt="Knowledge graph"/>
|
||
<br/>
|
||
<strong>知识图谱可视化</strong>
|
||
</td>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/d8b3de51-2854-455b-956f-2ae2d8d5f677" width="100%" alt="Project docs"/>
|
||
<br/>
|
||
<strong>项目文档</strong>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260326130404306.png" width="100%" alt="Skills management"/>
|
||
<br/>
|
||
<strong>扩展管理(Skills)</strong>
|
||
</td>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/9305d7a4-663b-4e5d-a252-211d6caa019b" width="100%" alt="MCPs management"/>
|
||
<br/>
|
||
<strong>扩展管理(MCPs)</strong>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/13bd22ea-ddde-4262-8c29-69fb948bce44" width="100%" alt="User and department permissions"/>
|
||
<br/>
|
||
<strong>用户 / 部门权限管理</strong>
|
||
</td>
|
||
<td align="center">
|
||
<img src="https://github.com/user-attachments/assets/cc886b04-719e-4abd-807d-e9955080003d" width="100%" alt="Model provider configuration"/>
|
||
<br/>
|
||
<strong>模型提供商配置</strong>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
## 致谢
|
||
|
||
Yuxi 参考并基于以下优秀的开源项目构建:
|
||
|
||
- [LightRAG](https://github.com/HKUDS/LightRAG) - 用作图构建与检索的基础。
|
||
- [DeepAgents](https://github.com/langchain-ai/deepagents) - 用作深度智能体(deep agent)框架。
|
||
- [DeerFlow](https://github.com/bytedance/deer-flow) - 参考了其 Sandbox 智能体架构思路。
|
||
- [RAGflow](https://github.com/infiniflow/ragflow) - 参考了其文档文本分块策略。
|
||
- [LangGraph](https://github.com/langchain-ai/langgraph) - 多智能体编排框架,亦是本项目的核心架构基础。
|
||
- [QwenPaw](https://github.com/agentscope-ai/QwenPaw) - 参考了其模型配置与个人文件区设计。
|
||
|
||
## 参与贡献
|
||
|
||
感谢所有贡献者对本项目的支持!
|
||
|
||
<a href="https://github.com/xerrors/Yuxi/contributors">
|
||
<img src="https://contrib.rocks/image?repo=xerrors/Yuxi&max=100&columns=10" />
|
||
</a>
|
||
|
||
## Star 历史
|
||
|
||
[](https://star-history.com/#xerrors/Yuxi)
|
||
|
||
## 📄 许可证
|
||
|
||
本项目基于 MIT 许可证开源。详情请参阅 [LICENSE](LICENSE)。
|
||
|
||
---
|
||
|
||
<div align="center">
|
||
|
||
**如果本项目对你有所帮助,请给我们一个 ⭐️。**
|
||
|
||
</div>
|