Skip to content

Commit cd34ea5

Browse files
committed
docs: 更新文档内容并优化图标映射
更新多个文档内容,包括移除演示视频、调整模型配置说明、优化知识库文档结构 在HomeView.vue中添加图标映射区域注释 将FileTable.vue中的刷新图标从RefreshCcw改为ReloadOutlined 添加agent.png图片资源
1 parent 696cd97 commit cd34ea5

File tree

10 files changed

+51
-143
lines changed

10 files changed

+51
-143
lines changed

docs/latest/advanced/branding.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ cp src/config/static/info.template.yaml src/config/static/info.local.yaml
1616

1717
<<< @/../src/config/static/info.template.yaml
1818

19+
上述中提到的 ICON 预设了下面这些,如果需要更多的 ICONS,可以手动从 `lucide-vue-next` 中引入。
20+
21+
<<< @/../web/src/views/HomeView.vue#icon_mapping{js}
22+
1923
### 3. 环境变量配置
2024

2125
`.env` 文件中指定配置文件路径:
@@ -47,5 +51,6 @@ YUXI_BRAND_FILE_PATH=src/config/static/info.local.yaml
4751
/* ... 其他色板 */
4852
}
4953

50-
**此外**,`web/src/stores/theme.js` 中也包含了主题相关的配置(需要修改 `colorPrimary`),可根据需要修改。
5154
```
55+
56+
**此外**`web/src/stores/theme.js` 中也包含了主题相关的配置(需要修改 `colorPrimary`),可根据需要修改。

docs/latest/advanced/document-processing.md

Lines changed: 12 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
### 常规文档格式
1313
- **文本文档**: `.txt`, `.md`, `.html`, `.htm`
14-
- **Word 文档**: `.doc`, `.docx`
14+
- **Word 文档**: `.docx`
1515
- **PDF 文档**: `.pdf`
1616
- **电子表格**: `.csv`, `.xls`, `.xlsx`
1717
- **JSON 数据**: `.json`
@@ -22,7 +22,7 @@
2222
### ZIP 压缩包
2323
- **ZIP 文档**: `.zip` - 支持包含 Markdown 文件和图片的压缩包
2424
- 自动提取和处理 ZIP 包中的 `.md` 文件
25-
- 自动处理 ZIP 包中的图片文件并上传到对象存储
25+
- 自动处理 ZIP 包中的图片文件并上传到对象存储(MINIO)
2626
- 图片链接会自动替换为可访问的 URL
2727
- 优先处理名为 `full.md` 的文件,否则使用第一个 `.md` 文件
2828
- 支持图片目录的智能识别(`images/``../images/` 等)
@@ -43,6 +43,8 @@ hf download SWHL/RapidOCR --local-dir ./models/SWHL/RapidOCR
4343
docker compose up -d api
4444
```
4545

46+
需要确保 `MODEL_DIR` 环境变量指向 RapidOCR 上层目录,例如 `./models`
47+
4648
### 2. 高精度 OCR (MinerU)
4749

4850
需要在 `.env` 文件中配置:
@@ -62,6 +64,11 @@ docker compose up mineru-vllm-server mineru-api -d
6264
docker compose up api -d
6365
```
6466

67+
::: tip 处理超时
68+
文档解析超时时间默认 600 秒,可通过 `MINERU_TIMEOUT` 环境变量调整。
69+
:::
70+
71+
6572
### 3. 官方云服务 (MinerU Official)
6673

6774
API 密钥可以从 [MinerU 官网](https://mineru.net) 申请。
@@ -97,6 +104,9 @@ docker compose up -d api
97104
## 参数说明
98105

99106
### enable_ocr 选项
107+
108+
对应网页中的 `使用 OCR` 选项
109+
100110
- `disable`: 不启用 OCR(PDF 按文本提取,图片**必须选择 OCR 方式**
101111
- `onnx_rapid_ocr`: RapidOCR 处理
102112
- `mineru_ocr`: MinerU HTTP API 处理
@@ -108,69 +118,3 @@ docker compose up -d api
108118
- MinerU 和 PaddleX 需要 GPU 支持
109119
- MinerU Official 需要设置 `MINERU_API_KEY` 环境变量
110120
- RapidOCR 适合 CPU 环境和基础识别需求
111-
112-
## 故障排除
113-
114-
### 常见问题
115-
116-
1. **RapidOCR 模型不存在**
117-
```bash
118-
# 下载模型
119-
huggingface-cli download SWHL/RapidOCR --local-dir ./models/SWHL/RapidOCR
120-
```
121-
122-
2. **GPU 服务连接失败**
123-
```bash
124-
# 检查服务状态
125-
docker compose ps
126-
127-
# 查看日志
128-
docker compose logs mineru
129-
```
130-
131-
3. **健康检查**
132-
```bash
133-
# 检查所有 OCR 服务状态
134-
curl http://localhost:5050/system/health/ocr-services
135-
```
136-
137-
## 批量处理脚本
138-
139-
系统提供便捷的批量处理脚本,用于高效批量上传文档。
140-
141-
### 文件上传脚本
142-
143-
使用 `scripts/batch_upload.py` 批量上传文件到知识库:
144-
145-
```bash
146-
# 批量上传文档(多种格式)
147-
uv run scripts/batch_upload.py \
148-
--db-id kb_b2730ad6801b149694021106c7eddd38 \
149-
--directory data.nogit/农业农村局 \
150-
--pattern "*.docx" --pattern "*.txt" --pattern "*.html" \
151-
--base-url http://172.19.13.6:5050/api \
152-
--username admin \
153-
--password admin123 \
154-
--batch-size 20 \
155-
--wait-for-completion \
156-
--poll-interval 5 \
157-
--recursive \
158-
--enable-ocr mineru_ocr \ # mineru_official, paddlex_ocr, onnx_rapid_ocr
159-
--record-file scripts/tmp/batch_processed_files_1029.txt
160-
```
161-
162-
**参数说明**:
163-
- `--db-id`: 目标知识库 ID
164-
- `--directory`: 文件目录路径
165-
- `--pattern`: 文件匹配模式,可以多次指定以支持多种格式(例如:`--pattern "*.docx" --pattern "*.pdf" --pattern "*.html"`
166-
- `--batch-size`: 每批处理的文件数量(默认20)
167-
- `--wait-for-completion`: 是否等待任务完成再处理下一批(默认开启)
168-
- `--poll-interval`: 任务状态检查间隔,单位秒(默认5秒)
169-
- `--recursive`: 递归处理子目录
170-
- `--record-file`: 处理记录文件路径
171-
172-
**注意事项**:
173-
- 系统按"内容哈希"进行去重;同一知识库已存在相同内容的文件会被拒绝(409)
174-
- 建议根据系统性能调整批次大小
175-
- 大量文件处理时建议开启分批等待功能
176-
- 先上传后处理的机制更稳定,适合大批量文档导入

docs/latest/advanced/misc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
## 网页搜索
1717

18-
系统内置了基于 Tavily 的联网搜索能力,配置完成后,大模型会自动在需要时调用 `enable_web_search` 对应的工具,为回答提供实时网页信息。
18+
系统内置了基于 Tavily 的联网搜索能力,配置完成后,大模型会自动在需要时调用对应的工具,为回答提供实时网页信息。
1919

2020

2121
1. 前往 [Tavily 官网](https://app.tavily.com/) 注册并在控制台创建 API Key。
@@ -29,7 +29,7 @@
2929
```
3030
若服务已运行,则使用 `docker compose restart api-dev` 即可。
3131

32-
完成以上步骤后,后端会自动将 `enable_web_search` 标记为启用,在智能体的工具配置区域即可看到这个工具,展示 Tavily 返回的实时结果。若需要关闭该能力,删除或清空 `TAVILY_API_KEY` 后再次重启服务即可。
32+
完成以上步骤后,在智能体的工具配置区域即可看到这个工具,展示 Tavily 返回的实时结果。若需要关闭该能力,删除或清空 `TAVILY_API_KEY` 后再次重启服务即可。
3333

3434
## 服务端口
3535

docs/latest/intro/knowledge-base.md

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,13 @@
2121

2222
在本项目中,系统支持基于 [LightRAG](https://github.com/HKUDS/LightRAG) 的知识图谱自动构建,能够从文档中自动提取实体和关系,构建结构化知识图谱。但是 LightRAG 所构建的知识图谱不作为全局的知识图谱来使用。只是将 LightRAG 作为知识的组织和检索形式。一方面是因为 LightRAG 构建的图谱的质量比较差,另一方面是不希望与全局的知识图谱弄混。
2323

24-
LightRAG 知识库可在知识库详情中可视化,但不支持在侧边栏图谱中直接检索,图谱检索工具不支持 LightRAG 知识库,查询需要使用对应的知识库作为工具。
25-
26-
在 Neo4j 的检索中可以看到,实际上 LightRAG 的节点和边依然是和知识图谱本身构建在了同一个 Neo4j 数据库中,但是使用了特殊的 tag 做区分。这点在后面介绍知识图谱的时候也会额外说明。
24+
LightRAG 知识库可在知识库详情、知识图谱中可视化。由于免费版的 neo4j 智能创建一个图数据库,因此实际上 LightRAG 的节点和边依然是和知识图谱本身构建在了同一个 Neo4j 数据库中,但是使用了特殊的 label `{知识库ID}` 做区分。
2725

2826
同时项目支持原 LightRAG 的所有环境变量,只需要在项目的 `.env` 文件中配置即可。比如当本地计算资源有限时,可以配置 `EMBEDDING_TIMEOUT=60`, `LLM_TIMEOUT=180` 增加超时时间。
2927

30-
31-
3228
## 文档管理
3329

34-
本系统的“上传 → 解析入库 → 检索/可视化”流程既可通过 Web 界面完成,也可使用 API/脚本批量处理。
35-
36-
**支持的文件类型**
37-
38-
- 文本与文档:`.txt``.md``.doc``.docx``.pdf`
39-
- 网页与数据:`.html``.htm``.json``.csv``.xls``.xlsx`
40-
- 图片:`.jpg``.jpeg``.png``.bmp``.tiff``.tif`
30+
本系统的“上传 → 解析入库 → 检索/可视化”流程既可通过 Web 界面完成,也可使用 API/脚本批量处理。详见[文档解析](../advanced/document-processing.md)
4131

4232
接口查询:`GET /api/knowledge/files/supported-types`
4333

@@ -53,42 +43,12 @@ LightRAG 知识库可在知识库详情中可视化,但不支持在侧边栏
5343

5444
去重策略:系统按“内容哈希”判断是否已存在相同文件,避免重复入库。
5545

56-
### 批量脚本
57-
58-
- 上传并入库:参见 `scripts/batch_upload.py upload`
59-
6046
## 知识图谱
6147

6248
本项目存在两类“图谱相关”能力:
6349

64-
- 全局知识图谱(Neo4j):用于智能体工具 `query_knowledge_graph` 的图实体查询;统一保存在 Neo4j 中,提供三元组检索和系统级可视化。
65-
- LightRAG 知识库内图谱:针对某个知识库由 LightRAG 自动抽取实体/关系,用于该库内的图增强检索与可视化;与全局图共享同一 Neo4j 实例,但通过特殊 tag 区分,不作为全局图谱使用。
66-
67-
选择建议:
68-
- 更结构化的库内检索/可视化:优先使用 LightRAG(注意构建质量与成本)。
69-
- 统一的图查询/工具调用:依赖全局 Neo4j 图谱与工具 `query_knowledge_graph`
70-
71-
因此,侧边栏知识图谱页面展示的是 Neo4j 图数据库中符合以下规则的知识图谱信息。
72-
73-
具体展示内容包括:
74-
75-
- 带有 Entity 标签的节点
76-
- 带有 RELATION 类型的关系边
77-
78-
79-
```SQL
80-
MATCH (n:Entity)-[r]->(m:Entity)
81-
RETURN
82-
{id: elementId(n), name: n.name} AS h,
83-
{type: r.type, source_id: elementId(n), target_id: elementId(m)} AS r,
84-
{id: elementId(m), name: m.name} AS t
85-
LIMIT $num
86-
```
87-
88-
如需查看完整的 Neo4j 数据库内容,请使用 "Neo4j 浏览器" 按钮访问 Neo4j 原生界面。
89-
90-
通过网页上传的 `jsonl` 文件的图谱默认会符合上述条件。
91-
50+
- 上传的知识图谱(Neo4j):提供三元组检索和系统级可视化。会作为工具供 LLM 使用。
51+
- LightRAG 知识库内图谱:针对某个知识库由 LightRAG 自动抽取实体/关系,用于该库内的图增强检索与可视化;与上传的图谱共享同一 Neo4j 实例,但通过特殊 label 区分,不作为全局图谱使用。
9252

9353

9454
### 1. 以三元组形式导入

docs/latest/intro/model-config.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,28 @@
1313
| 智谱清言 | `ZHIPUAI_API_KEY` | GLM 系列模型 |
1414
| 阿里云百炼 | `DASHSCOPE_API_KEY` | 通义千问系列 |
1515

16-
其余还支持火山、Together、vLLM、Ollama 等。
16+
其余还支持火山豆包、Together、vLLM、Ollama 等。
1717

1818
### 配置方法
1919

2020
`.env` 文件中添加对应的环境变量:
2121

22+
23+
24+
::: tip 免费获取 API Key
25+
[硅基流动](https://cloud.siliconflow.cn/i/Eo5yTHGJ) 注册即送 14 元额度,支持多种开源模型。
26+
:::
27+
2228
<<< @/../.env.template#model_provider{bash 5}
2329

2430
### 默认对话模型格式
2531

26-
系统的默认对话模型通过配置项 `default_model` 指定,格式统一为 `模型提供商/模型名称`,例如:
32+
系统的默认对话模型可以在设置页面配置,也可以通过配置项 `default_model` 指定,格式统一为 `模型提供商/模型名称`,例如:
2733

2834
```yaml
2935
default_model: siliconflow/deepseek-ai/DeepSeek-V3.2
3036
```
3137
32-
在 Web 界面中选择模型时也会自动按照这一格式保存。
33-
34-
::: tip 免费获取 API Key
35-
[硅基流动](https://cloud.siliconflow.cn/i/Eo5yTHGJ) 注册即送 14 元额度,支持多种开源模型。
36-
:::
37-
3838
## 自定义模型供应商
3939
4040
::: tip 配置系统升级 (v0.3.x)

docs/latest/intro/project-overview.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,3 @@ Yuxi-Know(语析)是一个基于知识图谱和向量数据库的智能知
2222
- **文档解析**: 支持 PDF、Word、图片等多种格式的智能解析
2323
- **权限管理**: 三级权限体系(超级管理员、管理员、普通用户)
2424
- **内容安全**: 内置内容审查机制,保障服务合规性
25-
26-
## 演示视频
27-
28-
<div align="center">
29-
<a href="https://www.bilibili.com/video/BV1DF14BTETq" target="_blank">
30-
<img width="3651" height="1933" alt="视频演示缩略图" src="https://github.com/user-attachments/assets/eac4fa89-2176-46ae-a649-45a125cb6ed1" />
31-
</a>
32-
<p style="margin-top: 12px;">
33-
<a href="https://www.bilibili.com/video/BV1DF14BTETq" target="_blank" style="text-decoration: none; color: #23ade5; font-weight: 500;">
34-
📽️ 点击查看视频演示 <i class="fa fa-external-link" style="margin-left: 4px;"></i>
35-
</a>
36-
</p>
37-
</div>

docs/latest/intro/quick-start.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@
1616

1717
```bash
1818
# 克隆稳定版本
19-
git clone --branch v0.3.6-beta --depth 1 https://github.com/xerrors/Yuxi-Know.git
19+
git clone --branch v0.4.0-beta --depth 1 https://github.com/xerrors/Yuxi-Know.git
2020
cd Yuxi-Know
2121
```
2222

2323
::: warning 版本说明
2424
- `v0.3.0`: 稳定版本
25-
- `v0.3.6-beta`:最新的 Beta 测试版
25+
- `v0.4.0-beta`:最新的 Beta 测试版
2626
- `main`: 最新开发版本(不稳定,新特性可能会导致新 bug)
2727
:::
2828

2929
#### 2. 项目启动
3030

31-
** 方法 1**:使用 init 脚本(推荐)
31+
**方法 1**:使用 init 脚本(推荐)
3232

3333
我们提供了自动化的初始化脚本,可以帮您完成环境配置和 Docker 镜像拉取:
3434

@@ -51,7 +51,7 @@ cd Yuxi-Know
5151
- [Tavily](https://app.tavily.com/) 获取搜索服务 API Key(可选)
5252
:::
5353

54-
** 方法 2**:手动配置环境变量
54+
**方法 2**:手动配置环境变量
5555

5656
复制环境变量模板并编辑:
5757

@@ -92,7 +92,17 @@ docker compose up --build -d
9292
docker compose down
9393
```
9494

95-
### 故障排除
95+
## 对话
96+
97+
项目第一次启动后,会要求填写超级管理员账号和密码,请确保填写正确。
98+
99+
然后在智能体页面可以进行对话,在右侧可以配置提示词、模型、工具等参数。
100+
101+
![agent.png](/images/agent.png)
102+
103+
104+
105+
## 故障排除
96106

97107
#### 查看服务状态
98108

docs/public/images/agent.png

474 KB
Loading

web/src/components/FileTable.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
type="text"
2323
@click="handleRefresh"
2424
:loading="refreshing"
25-
:icon="h(RefreshCcw)"
25+
:icon="h(ReloadOutlined)"
2626
title="刷新"
2727
class="panel-action-btn"
2828
/>
@@ -171,13 +171,13 @@ import {
171171
CloseCircleFilled,
172172
ClockCircleFilled,
173173
PlusOutlined,
174+
ReloadOutlined,
174175
} from '@ant-design/icons-vue';
175176
import {
176177
Trash2,
177178
Download,
178179
RefreshCw,
179180
ChevronLast,
180-
RefreshCcw,
181181
Ellipsis,
182182
} from 'lucide-vue-next';
183183

web/src/views/HomeView.vue

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ onMounted(async () => {
147147
148148
const iconKey = (value) => typeof value === 'string' ? value.toLowerCase() : ''
149149
150+
// region icon_mapping
150151
const featureIconMap = {
151152
stars: Star,
152153
issues: CheckCircle2,
@@ -169,6 +170,7 @@ const actionIconMap = {
169170
github: Github,
170171
default: Github
171172
}
173+
// endregion icon_mapping
172174
173175
const featureCards = computed(() => {
174176
const list = Array.isArray(infoStore.features) ? infoStore.features : []

0 commit comments

Comments
 (0)