docs: 修复文档编译错误
This commit is contained in:
parent
a31f60b0a6
commit
4a2bf3f125
10
README.md
10
README.md
@ -6,7 +6,7 @@
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/xerrors/Yuxi-Know/issues)
|
||||
[](https://github.com/xerrors/Yuxi-Know/issues)
|
||||
[](https://github.com/xerrors/Yuxi-Know/blob/main/docker-compose.yml)
|
||||
[](https://github.com/xerrors/Yuxi-Know/issues)
|
||||
[](https://github.com/xerrors/Yuxi-Know/blob/main/LICENSE)
|
||||
@ -52,10 +52,10 @@
|
||||
### 一键启动
|
||||
|
||||
1. **克隆项目**
|
||||
```bash
|
||||
git clone -b 0.2.1 https://github.com/xerrors/Yuxi-Know.git
|
||||
cd Yuxi-Know
|
||||
```
|
||||
```bash
|
||||
git clone --branch 0.2.2 --depth 1 https://github.com/xerrors/Yuxi-Know.git
|
||||
cd Yuxi-Know
|
||||
```
|
||||
如果想要使用之前的稳定版(与现版本不兼容),可以使用 `stable` 分支,`main` 分支是最新的开发版本。
|
||||
|
||||
2. **配置 API 密钥**
|
||||
|
||||
@ -22,7 +22,7 @@
|
||||
| **8081** | vLLM | - | 本地推理(可选)|
|
||||
|
||||
::: tip 端口访问
|
||||
- Web 界面: http://localhost:5173
|
||||
- API 文档: http://localhost:5050/docs
|
||||
- Neo4j 管理: http://localhost:7474
|
||||
- Web 界面: `http://localhost:5173`
|
||||
- API 文档: `http://localhost:5050/docs`
|
||||
- Neo4j 管理: `http://localhost:7474`
|
||||
:::
|
||||
|
||||
@ -12,7 +12,7 @@
|
||||
| **Milvus** | 高性能向量数据库 | 大规模生产环境、高性能查询 |
|
||||
| **LightRAG** | 图增强检索 | 复杂知识关系,构建成本较高 |
|
||||
|
||||
访问 Web 界面:http://localhost:5173,进入"知识库管理"页面,点击"新建知识库",填写知识库信息。
|
||||
访问 Web 界面:`http://localhost:5173`,进入"知识库管理"页面,点击"新建知识库",填写知识库信息。
|
||||
|
||||
这里需要**注意**的是,这里的知识库的标题和描述都会作为智能体选择工具的依据,因此尽量详尽的描述该知识库。
|
||||
|
||||
@ -60,7 +60,7 @@ Neo4j 访问信息可以参考 `docker-compose.yml` 中配置对应的环境变
|
||||
|
||||
- **默认账户**: `neo4j`
|
||||
- **默认密码**: `0123456789`
|
||||
- **管理界面**: http://localhost:7474
|
||||
- **管理界面**: `http://localhost:7474`
|
||||
- **连接地址**: bolt://localhost:7687
|
||||
|
||||
::: tip 测试数据
|
||||
@ -80,4 +80,4 @@ Neo4j 访问信息可以参考 `docker-compose.yml` 中配置对应的环境变
|
||||
|
||||
::: warning 注意事项
|
||||
确保每个节点都有 `Entity` 标签,每个关系都有 `RELATION` 类型,否则会影响图的检索与构建功能。
|
||||
:::
|
||||
:::
|
||||
|
||||
@ -14,12 +14,12 @@
|
||||
|
||||
```bash
|
||||
# 克隆稳定版本
|
||||
git clone -b 0.2.1 https://github.com/xerrors/Yuxi-Know.git
|
||||
git clone --branch 0.2.2 --depth 1 https://github.com/xerrors/Yuxi-Know.git
|
||||
cd Yuxi-Know
|
||||
```
|
||||
|
||||
::: warning 版本说明
|
||||
- `0.2.1`: 当前稳定版本(推荐)
|
||||
- `0.2.2`: 当前稳定版本(推荐)
|
||||
- `stable`: 旧版本稳定分支(与现版本不兼容)
|
||||
- `main`: 最新开发版本(可能不稳定)
|
||||
:::
|
||||
@ -57,8 +57,8 @@ docker compose up --build -d
|
||||
|
||||
服务启动完成后,访问以下地址:
|
||||
|
||||
- **Web 界面**: http://localhost:5173
|
||||
- **API 文档**: http://localhost:5050/docs
|
||||
- **Web 界面**: `http://localhost:5173`
|
||||
- **API 文档**: `http://localhost:5050/docs`
|
||||
|
||||
#### 5. 停止服务
|
||||
|
||||
@ -162,8 +162,8 @@ docker ps
|
||||
**Q: MinerU/PaddleX 健康检查失败?**
|
||||
|
||||
分别检查服务状态:
|
||||
- MinerU: http://localhost:30000/health
|
||||
- PaddleX: http://localhost:8080/
|
||||
- MinerU: `http://localhost:30000/health`
|
||||
- PaddleX: `http://localhost:8080/`
|
||||
|
||||
确认 GPU/驱动与 CUDA 版本匹配。
|
||||
|
||||
@ -182,5 +182,4 @@ docker restart api-dev
|
||||
检查默认账户信息:
|
||||
- 用户名: `neo4j`
|
||||
- 密码: `0123456789`
|
||||
- 管理界面: http://localhost:7474
|
||||
|
||||
- 管理界面: `http://localhost:7474`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user