diff --git a/docs/latest/changelog/faq.md b/docs/latest/changelog/faq.md index 8bc00c53..8b11b645 100644 --- a/docs/latest/changelog/faq.md +++ b/docs/latest/changelog/faq.md @@ -66,5 +66,5 @@ - RapidOCR 本地模型：确保 `MODEL_DIR/SWHL/RapidOCR` 下存在 `PP-OCRv4` 模型 - MinerU/PaddleX：检查健康检查接口与 GPU/CUDA 版本 -- 登录失败被锁定？ +### 登录失败被锁定？ - 多次失败会临时锁定账户，请根据提示等待后重试 diff --git a/docs/latest/changelog/roadmap.md b/docs/latest/changelog/roadmap.md index 2fd44b79..e7a1605e 100644 --- a/docs/latest/changelog/roadmap.md +++ b/docs/latest/changelog/roadmap.md @@ -13,6 +13,8 @@ - 优化chunk逻辑，移除 QA 分割，集成到普通分块中 - 考虑修改附件的处理逻辑，考虑使用文件系统，将附件解析后放到文件系统中，智能体按需读取，用户可以使用 @ 来引用附件，例如 @file:reports.md 相较于现在的处理逻辑感觉会更加自然一点。在此之前可能还要考虑文件系统的后端支持问题 - skills 如何实现还需要继续调研 +- 优化 paddle 的命名，paddlex 有歧义，修改为 PP-StructureV3 +- 增加 paddle-vl 以及 deepseek-ocr 的支持 ### Bugs - 部分异常状态下，智能体的模型名称出现重叠[#279](https://github.com/xerrors/Yuxi-Know/issues/279) diff --git a/docs/latest/intro/evaluation.md b/docs/latest/intro/evaluation.md index d15e3a47..fa7e3850 100644 --- a/docs/latest/intro/evaluation.md +++ b/docs/latest/intro/evaluation.md @@ -4,7 +4,7 @@ **适用场景**：验证知识库上线前的效果、对比不同配置下的检索效果、定期监控知识库质量变化、调优检索参数。 -**注意**：当前版本仅支持 Milvus 类型的知识库。 +**注意**：当前版本支持 Milvus 类型的知识库。 ## 如何创建评估基准 diff --git a/docs/latest/intro/knowledge-base.md b/docs/latest/intro/knowledge-base.md index cb9bb5f5..08f67003 100644 --- a/docs/latest/intro/knowledge-base.md +++ b/docs/latest/intro/knowledge-base.md @@ -8,7 +8,7 @@ | 存储类型 | 特点 | 适用场景 | |----------|------|----------| -| **Chroma** | 轻量级向量数据库 | 小型项目、快速原型、维护方便（后续会移除） | +| **Chroma** | 轻量级向量数据库 | 已弃用，建议使用 Milvus | | **Milvus** | 高性能向量数据库 | 大规模生产环境、高性能查询 | | **LightRAG** | 图增强检索 | 复杂知识关系，构建成本较高 | @@ -19,7 +19,15 @@ ### LightRAG 知识库说明 -在本项目中，系统支持基于 [LightRAG](https://github.com/HKUDS/LightRAG) 的知识图谱自动构建，能够从文档中自动提取实体和关系，构建结构化知识图谱。但是 LightRAG 所构建的知识图谱不作为全局的知识图谱来使用。只是将 LightRAG 作为知识的组织和检索形式。一方面是因为 LightRAG 构建的图谱的质量比较差，另一方面是不希望与全局的知识图谱弄混。 +在本项目中，系统支持基于 [LightRAG](https://github.com/HKUDS/LightRAG) 的知识图谱自动构建，能够从文档中自动提取实体和关系，构建结构化知识图谱。 + +**LightRAG 图谱 vs 全局知识图谱的区别：** + +- **LightRAG 图谱**（知识库专属）：针对单个知识库由 LightRAG 自动抽取实体/关系，用于该库内的图增强检索与可视化。通过特殊的 label（知识库ID）与全局图谱区分，不会混入全局数据。 + +- **全局知识图谱**（系统级）：通过三元组文件上传的图谱数据，提供系统级的知识图谱查询和可视化能力，会作为工具供 LLM 使用。 + +两者共享同一个 Neo4j 实例，但完全隔离，互不影响。 LightRAG 知识库可在知识库详情、知识图谱中可视化。由于免费版的 neo4j 智能创建一个图数据库，因此实际上 LightRAG 的节点和边依然是和知识图谱本身构建在了同一个 Neo4j 数据库中，但是使用了特殊的 label `{知识库ID}` 做区分。 diff --git a/docs/latest/intro/model-config.md b/docs/latest/intro/model-config.md index 8a96bfd4..b7afba61 100644 --- a/docs/latest/intro/model-config.md +++ b/docs/latest/intro/model-config.md @@ -210,7 +210,7 @@ config.reranker_names["local/reranker-model"] = RerankerInfo( config.save() ``` -#### 2. 启动模型服务 +#### 3. 启动模型服务 ```bash # 启动嵌入模型 diff --git a/docs/latest/intro/project-overview.md b/docs/latest/intro/project-overview.md index 0198d743..494c3b17 100644 --- a/docs/latest/intro/project-overview.md +++ b/docs/latest/intro/project-overview.md @@ -2,7 +2,7 @@ Yuxi-Know（语析）是一个基于知识图谱和向量数据库的智能知识库系统，融合了 RAG（检索增强生成）技术与知识图谱技术，为用户提供智能问答和知识管理服务。 -特点是技术栈简单，易于上手，使用 MIT 开源协议，非常适合二次开发使用。 +**特点**：技术栈简单，易于上手，使用 MIT 开源协议，非常适合二次开发使用。 ### 技术栈选择 diff --git a/docs/latest/intro/quick-start.md b/docs/latest/intro/quick-start.md index bcaa944c..326ad268 100644 --- a/docs/latest/intro/quick-start.md +++ b/docs/latest/intro/quick-start.md @@ -1,7 +1,7 @@ # 快速开始指南 ::: tip 提示 -除了此文档网站外，小伙伴们还可以在 [Zread](https://zread.ai/xerrors/Yuxi-Know) 或 [DeepWiki](https://deepwiki.com/xerrors/Yuxi-Know) 平台查看自动生成的详细项目文档。 +除了此文档网站外，用户还可以在 [Zread](https://zread.ai/xerrors/Yuxi-Know) 或 [DeepWiki](https://deepwiki.com/xerrors/Yuxi-Know) 平台查看自动生成的详细项目文档。 ::: @@ -16,13 +16,12 @@ ```bash # 克隆稳定版本 -git clone --branch v0.4.0-beta --depth 1 https://github.com/xerrors/Yuxi-Know.git +git clone --branch v0.4.0 --depth 1 https://github.com/xerrors/Yuxi-Know.git cd Yuxi-Know ``` ::: warning 版本说明 -- `v0.3.0`: 稳定版本 -- `v0.4.0-beta`：最新的 Beta 测试版 +- `v0.4.0`: 稳定版本 - `main`: 最新开发版本（不稳定，新特性可能会导致新 bug） :::