docs: 精简项目说明并更新路线图
This commit is contained in:
Wenjie Zhang
parent
e37bd7c808
commit
9e23ad8976
@ -24,6 +24,8 @@
|
||||
|
||||
Yuxi is an LLM-powered platform for building knowledge-base and knowledge-graph agents. It unifies **RAG retrieval**, **Milvus-backed in-knowledge-base graphs**, and **LangGraph multi-agent orchestration** into a single multi-tenant workspace: administrators configure knowledge bases, models, and permissions, while users chat — in a ChatGPT-like interface — with agents that can mount Skills, MCPs, sub-agents, and sandbox tools, and receive answers with cited sources, graph-based reasoning, and deliverable artifacts.
|
||||
|
||||
Navigation: [Introduction](https://xerrors.github.io/Yuxi/) ｜ [Quick Start](https://xerrors.github.io/Yuxi/intro/quick-start) ｜ [Roadmap](https://xerrors.github.io/Yuxi/develop-guides/roadmap); for the latest updates, see the [changelog](https://xerrors.github.io/Yuxi/develop-guides/changelog).
|
||||
|
||||
## Core Features
|
||||
|
||||
- 🤖 **Agent development** — Built on LangGraph, with sub-agents (SubAgents), Skills, MCPs, Tools, and middleware; long-running tasks run asynchronously on a background worker, backed by a sandbox file system for persisting, previewing, and downloading tool artifacts.
|
||||
|
||||
107
README.md
107
README.md
@ -7,31 +7,25 @@
|
||||
[](https://github.com/xerrors/Yuxi/issues)
|
||||
[](https://github.com/xerrors/Yuxi/blob/main/LICENSE)
|
||||
[](https://deepwiki.com/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>
|
||||
|
||||
[[文档]](https://xerrors.github.io/Yuxi) · [[English]](README.en.md)
|
||||
[[项目文档]](https://xerrors.github.io/Yuxi) · [[English]](README.en.md)
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
**图由 GPT-Image-2 生成*
|
||||
|
||||
## 简介
|
||||
|
||||
语析（Yuxi）是一个基于大模型的智能知识库与知识图谱智能体开发平台。它把 **RAG 检索**、**Milvus 知识库内知识图谱** 与 **LangGraph 多智能体编排** 整合进统一的多租户工作台：管理员配置知识库、模型与权限，用户在类 ChatGPT 的界面中与可挂载 Skills、MCP、子智能体和沙盒工具的智能体对话，并获得带引用来源、知识图谱推理与可交付产物的回答。
|
||||
|
||||
## 核心特性
|
||||
导航：[项目介绍](https://xerrors.github.io/Yuxi/) ｜ [快速开始](https://xerrors.github.io/Yuxi/intro/quick-start) ｜ [开发路线图](https://xerrors.github.io/Yuxi/develop-guides/roadmap)；最新开发动态，详见 [changelog](https://xerrors.github.io/Yuxi/develop-guides/changelog)。
|
||||
|
||||
- 🤖 **智能体开发** —— 基于 LangGraph 构建，支持子智能体（SubAgents）、Skills、MCP、Tools 与中间件机制；长耗时任务由后台 worker 异步执行，配套沙盒文件系统支持工具产物落盘、预览与下载。
|
||||
- 📚 **知识库（RAG）** —— 多格式文档解析（MinerU / PaddleX / OCR），可配置 Embedding 与 Rerank 模型，支持知识库评估与 PDF / 图片在线预览，检索来源回填到对话引用。
|
||||
- 🕸️ **知识图谱** —— 在 Milvus 知识库内构建、展示和检索实体关系图谱，并与 chunk 检索结果融合参与智能体推理。
|
||||
- 🏢 **多租户与权限** —— 用户 / 部门级权限管理，模型供应商统一配置，支持 API Key 认证供外部系统集成调用。
|
||||
- ⚙️ **平台与工程化** —— Vue + FastAPI 架构，开箱即用的 Docker Compose 部署，支持暗黑模式、LITE 轻量启动与生产级编排。
|
||||
|
||||
|
||||
|
||||
## 技术栈
|
||||
|
||||
@ -42,56 +36,6 @@
|
||||
| 存储 | PostgreSQL · Redis · MinIO · Milvus · Neo4j |
|
||||
| 文档解析 | MinerU · PaddleX · RapidOCR |
|
||||
| 部署 | Docker Compose |
|
||||
|
||||
|
||||
|
||||
## 最新动态
|
||||
|
||||
|
||||
<details>
|
||||
<summary>[2026/06] v0.7.0 开发中（重要不兼容变更）</summary>
|
||||
|
||||
**重大变更**
|
||||
|
||||
- **模型配置收敛**：移除旧版 v1 模型配置与 Ollama 支持，运行时统一使用 `provider_id:model_id` 与独立 provider 模块，自定义 provider 迁移到数据库
|
||||
- **智能体运行时收敛**：用户可见的 `AgentConfig` 收敛为数据库持久化的一级 `Agent`，新增 `/api/agent` 管理与运行接口，前端只提交 `agent_id`
|
||||
- **知识库能力收敛**：以 Yuxi 的知识库增强图谱构建、展示、检索链路替换历史 LightRAG 集成，并移除 Upload 类型；知识库类型收敛为单个类型与只读连接器（**Dify**、**Notion**），减少历史集成带来的兼容性问题
|
||||
- **Skill 安装与权限收敛**：以 `source_type / share_config / enabled` 表达来源、生效范围与启用状态；内置 Skill 启动自动入库并默认全局启用，上传/远程统一改为「解析草稿 → 确认安装」
|
||||
|
||||
|
||||
|
||||
详见 [changelog](docs/develop-guides/changelog.md)。
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>[2026/04/01] v0.6.0 版本发布</summary>
|
||||
|
||||
详见 [changelog](docs/develop-guides/changelog.md)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>[2026/03/01] v0.5.0 版本发布</summary>
|
||||
|
||||
详见 [changelog](docs/develop-guides/changelog.md)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>[2025/12/19] v0.4.0 版本发布</summary>
|
||||
|
||||
详见 [changelog](docs/develop-guides/changelog.md)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>[2025/11/05] v0.3.0 版本发布</summary>
|
||||
|
||||
详见 [changelog](docs/develop-guides/changelog.md)
|
||||
|
||||
</details>
|
||||
|
||||
## 快速开始
|
||||
|
||||
**前置要求**：已安装 [Docker](https://docs.docker.com/get-docker/) 与 Docker Compose，并准备至少一个兼容 OpenAI 接口的大模型 API。
|
||||
@ -121,49 +65,6 @@ docker compose up --build
|
||||
|
||||
> 💡 不需要知识库 / 知识图谱等重依赖时，可使用 `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-20260604203514048.png" width="100%" alt="对话工作台"/>
|
||||
<br/>
|
||||
<strong>对话工作台</strong>
|
||||
</td>
|
||||
<td align="center">
|
||||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260604203704426.png" width="100%" alt="沙盒文件系统"/>
|
||||
<br/>
|
||||
<strong>沙盒文件系统</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260604205342546.png" width="100%" alt="Agentic RAG"/>
|
||||
<br/>
|
||||
<strong>Agentic RAG</strong>
|
||||
</td>
|
||||
<td align="center">
|
||||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260604204056298.png" width="100%" alt="知识图谱"/>
|
||||
<br/>
|
||||
<strong>知识图谱</strong>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260604210111977.png" width="100%" alt="检索评估"/>
|
||||
<br/>
|
||||
<strong>检索评估</strong>
|
||||
</td>
|
||||
<td align="center">
|
||||
<img src="https://xerrors.oss-cn-shanghai.aliyuncs.com/github/image-20260604205611168.png" width="100%" alt="多知识源接入"/>
|
||||
<br/>
|
||||
<strong>多知识源接入</strong>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
## 致谢
|
||||
|
||||
本项目参考并引用了以下优秀开源项目，在此致以诚挚的感谢：
|
||||
|
||||
@ -453,7 +453,7 @@ const vReveal = {
|
||||
</header>
|
||||
<div v-reveal class="yx-quick">
|
||||
<pre class="yx-code"><code><span class="yx-c-cmt"># 1. 克隆并初始化</span>
|
||||
git clone --branch v0.7.0.dev0 --depth 1 https://github.com/xerrors/Yuxi.git
|
||||
git clone --branch v0.7.0.beta2 --depth 1 https://github.com/xerrors/Yuxi.git
|
||||
cd Yuxi && ./scripts/init.sh
|
||||
|
||||
<span class="yx-c-cmt"># 2. 使用 Docker 启动</span>
|
||||
|
||||
@ -43,6 +43,7 @@
|
||||
- 收敛知识库文件解析参数：文件级 `processing_params` 统一保存 `ocr_engine` 与 `ocr_engine_config`，解析阶段直接使用该结构并保留分块参数快照。
|
||||
- 修复知识库文件大小显示为 0 的问题：文件上传时 `file_sizes` 参数未正确传播或历史数据缺失导致 DB 中 `file_size` 为 `None`；新增 `MinIOClient.stat_file/astat_file` 获取文件大小方法，`add_file_record` 在 `size` 缺失时从 MinIO 回补，`_load_metadata` 加载元数据后自动为缺少 `size` 的文件从 MinIO 补全并持久化。
|
||||
- 优化评估基准自动生成：生成任务支持配置队列并发数，默认 10，范围 1-20。
|
||||
- 完善模型供应商类型：普通聊天模型运行时新增 Anthropic provider type 适配，并清理不再支持的旧 provider type 入口。
|
||||
- 重梳理知识库评估存储：评估数据集、题目、评估运行和逐题结果统一入库，JSONL 仅作为导入/导出格式；后端和前端 API 统一使用 dataset/run 语义；评估运行支持用户命名，历史记录按名称展示，综合评分只聚合检索指标。
|
||||
- 扩展知识库上传来源：添加“从工作区上传”模式，后端将当前用户工作区文件预处理上传到 MinIO，前端沿用现有 `addDocuments` 入库链路提交 MinIO URL、内容哈希和文件大小。
|
||||
- 重构知识库详情页布局：`DatabaseInfo` 改为顶部详情 header + 左侧功能 tab 侧边栏 + 右侧内容区，Milvus 默认进入文件管理，并将检索测试、知识图谱、知识导图、检索配置、RAG 评估和评估基准统一纳入侧边栏导航；只读连接器保留检索测试与检索配置。
|
||||
|
||||
@ -8,21 +8,21 @@
|
||||
### 看板
|
||||
|
||||
**知识库**
|
||||
- [ ] office 组件预览，docx/pptx 可以转PDF，然后前端预览
|
||||
- [ ] 知识库工具新增 query_keywords 工具，专门用于基于关键词命中的排序
|
||||
- [ ] office 组件预览，docx/pptx 可以转PDF，然后前端预览 <Badge text="v0.7.1" />
|
||||
- [ ] 知识库工具新增 query_keywords 工具，专门用于基于关键词命中的排序 <Badge text="v0.7.1" />
|
||||
- [ ] 调研将当前知识库映射为虚拟文件系统的可行性，先明确文件树映射、权限边界、内容读取与 Agent 工具调用形态，再决定是否实现
|
||||
- [ ] 增强知识库检索体验：增强 metadata、标签等
|
||||
- [ ] 优化思维导图构建的接口设计，支持增量构建和更新
|
||||
- [ ] 个人工作区增加可检索能力（但是不做向量化）
|
||||
- [ ] 个人工作区增加可检索能力（但是不做向量化） <Badge text="v0.7.1" />
|
||||
|
||||
|
||||
**智能体**
|
||||
- [ ] 子智能体缺少异步的机制 <Badge text="v0.7.1" />
|
||||
- [ ] 子智能体缺少 steer 机制 <Badge text="v0.7.1" />
|
||||
- [ ] 子智能体的双向通信，缺少 ask_for_main_agent 的机制 <Badge text="v0.7.1" />
|
||||
- [ ] 子智能体的双向通信，缺少 ask_for_main_agent 的机制
|
||||
- [ ] 子智能体与子智能体的通信机制
|
||||
- [ ] 如何停掉一个子智能体、查看智能体的进度
|
||||
- [ ] RAG 评估支持 Agent 模式
|
||||
- [ ] RAG 评估支持 Agent 模式 <Badge text="v0.7.1" />
|
||||
- [ ] 添加 Agent 独立调用接口，方便后续评估使用
|
||||
- [ ] 任务队列 <Badge text="v0.7.2" />
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
欢迎使用 Yuxi（语析），这是一个智能知识库和知识图谱 Agent 开发平台。
|
||||
本指南将帮助你在几分钟内启动并运行系统，使你能够利用 LangGraph、RAG 技术和知识图谱构建 AI 驱动的知识应用。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
::: tip 提示
|
||||
|
||||
Loading…
Reference in New Issue
Block a user