mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-09-01 14:53:07 +08:00
nullkey
1c7171b2c6
Refs #890 #1049 #1168. 按集成方视角全量审计 17 个 API markdown 文档与 internal/router/router.go 对齐。每个端点新增参数说明小节（path/query/body 字段含义）和响应字段 含义说明（#1168 的核心诉求）。 【与代码对齐】 - 删除已下线端点：system.md 中的 /system/minio/buckets（代码中已无对 应路由）。 - 修正路径错误：chunk.md 中 /chunks/get-by-id/:id → /chunks/by-id/:id； /chunks/:id/delete-question → /chunks/by-id/:id/questions； organization.md 中 /organizations/preview/:invite_code → :code。 - 修正字段类型：faq tag_id / entry_id 由 string 改为 int64； knowledge.search 响应结构纠正。 - 补齐缺失端点（move-targets、batch-delete、move/progress、pin/unpin/ stop/continue-stream、tool-approvals、organization agent-shares 等 30+ 条）。 【精简】 - knowledge-base.md / model.md 把重复 5 次 / 3 次的完整对象样例 收敛为指向首次出现（"字段结构同 POST /xxx 响应"），节省约 400 行 而不损失信息（仅去重，原作者写的每个字段定义都保留可达）。 - 示例 X-API-Key 统一为 sk-xxxxx（避免读者复制看似真实的 key）。 【清理】 - 删除内部实现细节引用：mcp-service.md 中 6 处 "issue #1173"、 organization.md 中 "RegisterOrganizationRoutes" 等。 不动 initialization.md：其中端点（KB 配置、模型连通性测试、Ollama 管理） 对集成方有实用价值，保留原作者写好的内容不删。 格式统一遵循 web-search.md 重写后的范式（路由表 + 每端点方法/路径 + 参数表 + curl + 响应 JSON + 字段说明）。
204 lines
4.4 KiB
Markdown
204 lines
4.4 KiB
Markdown
# 系统管理 API
|
|
|
|
[返回目录](./README.md)
|
|
|
|
| 方法 | 路径 | 描述 |
|
|
| ------ | --------------------------------- | ---------------------- |
|
|
| GET | `/system/info` | 获取系统信息 |
|
|
| GET | `/system/parser-engines` | 获取解析引擎列表 |
|
|
| POST | `/system/parser-engines/check` | 检查解析引擎可用性 |
|
|
| POST | `/system/docreader/reconnect` | 重连文档解析服务 |
|
|
| GET | `/system/storage-engine-status` | 获取存储引擎状态 |
|
|
| POST | `/system/storage-engine-check` | 检查存储引擎连通性 |
|
|
|
|
## GET `/system/info` - 获取系统信息
|
|
|
|
**请求**:
|
|
|
|
```curl
|
|
curl --location 'http://localhost:8080/api/v1/system/info' \
|
|
--header 'X-API-Key: sk-xxxxx' \
|
|
--header 'Content-Type: application/json'
|
|
```
|
|
|
|
**响应**:
|
|
|
|
```json
|
|
{
|
|
"data": {
|
|
"version": "1.2.0",
|
|
"edition": "community",
|
|
"commit_id": "a1b2c3d",
|
|
"build_time": "2025-08-12T08:00:00Z",
|
|
"go_version": "go1.21.5",
|
|
"keyword_index_engine": "bleve",
|
|
"vector_store_engine": "milvus",
|
|
"graph_database_engine": "neo4j",
|
|
"minio_enabled": true,
|
|
"db_version": "20250810_001"
|
|
},
|
|
"success": true
|
|
}
|
|
```
|
|
|
|
## GET `/system/parser-engines` - 获取解析引擎列表
|
|
|
|
**请求**:
|
|
|
|
```curl
|
|
curl --location 'http://localhost:8080/api/v1/system/parser-engines' \
|
|
--header 'X-API-Key: sk-xxxxx' \
|
|
--header 'Content-Type: application/json'
|
|
```
|
|
|
|
**响应**:
|
|
|
|
```json
|
|
{
|
|
"data": [
|
|
{
|
|
"name": "docreader",
|
|
"label": "DocReader",
|
|
"description": "高精度文档解析引擎",
|
|
"available": true
|
|
},
|
|
{
|
|
"name": "tika",
|
|
"label": "Apache Tika",
|
|
"description": "通用文档解析引擎",
|
|
"available": false
|
|
}
|
|
],
|
|
"connected": true,
|
|
"success": true
|
|
}
|
|
```
|
|
|
|
## POST `/system/parser-engines/check` - 检查解析引擎可用性
|
|
|
|
**请求**:
|
|
|
|
```curl
|
|
curl --location 'http://localhost:8080/api/v1/system/parser-engines/check' \
|
|
--header 'X-API-Key: sk-xxxxx' \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{
|
|
"addr": "http://docreader:8000"
|
|
}'
|
|
```
|
|
|
|
**响应**:
|
|
|
|
```json
|
|
{
|
|
"data": [
|
|
{
|
|
"name": "docreader",
|
|
"label": "DocReader",
|
|
"description": "高精度文档解析引擎",
|
|
"available": true
|
|
}
|
|
],
|
|
"success": true
|
|
}
|
|
```
|
|
|
|
## POST `/system/docreader/reconnect` - 重连文档解析服务
|
|
|
|
**请求**:
|
|
|
|
```curl
|
|
curl --location 'http://localhost:8080/api/v1/system/docreader/reconnect' \
|
|
--header 'X-API-Key: sk-xxxxx' \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{
|
|
"addr": "http://docreader:8000"
|
|
}'
|
|
```
|
|
|
|
**响应**:
|
|
|
|
```json
|
|
{
|
|
"success": true
|
|
}
|
|
```
|
|
|
|
## GET `/system/storage-engine-status` - 获取存储引擎状态
|
|
|
|
**请求**:
|
|
|
|
```curl
|
|
curl --location 'http://localhost:8080/api/v1/system/storage-engine-status' \
|
|
--header 'X-API-Key: sk-xxxxx' \
|
|
--header 'Content-Type: application/json'
|
|
```
|
|
|
|
**响应**:
|
|
|
|
```json
|
|
{
|
|
"data": {
|
|
"engines": [
|
|
{
|
|
"name": "minio",
|
|
"available": true,
|
|
"description": "MinIO 对象存储"
|
|
},
|
|
{
|
|
"name": "cos",
|
|
"available": false,
|
|
"description": "腾讯云 COS 对象存储"
|
|
},
|
|
{
|
|
"name": "s3",
|
|
"available": false,
|
|
"description": "AWS S3 对象存储"
|
|
},
|
|
{
|
|
"name": "oss",
|
|
"available": false,
|
|
"description": "阿里云 OSS 对象存储"
|
|
}
|
|
],
|
|
"minio_env_available": true
|
|
},
|
|
"success": true
|
|
}
|
|
```
|
|
|
|
## POST `/system/storage-engine-check` - 检查存储引擎连通性
|
|
|
|
**请求**:
|
|
|
|
```curl
|
|
curl --location 'http://localhost:8080/api/v1/system/storage-engine-check' \
|
|
--header 'X-API-Key: sk-xxxxx' \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{
|
|
"provider": "minio",
|
|
"minio": {
|
|
"endpoint": "localhost:9000",
|
|
"access_key": "minioadmin",
|
|
"secret_key": "minioadmin",
|
|
"bucket": "weknora",
|
|
"use_ssl": false
|
|
}
|
|
}'
|
|
```
|
|
|
|
**响应**:
|
|
|
|
```json
|
|
{
|
|
"data": {
|
|
"ok": true,
|
|
"message": "连接成功",
|
|
"bucket_created": false
|
|
},
|
|
"success": true
|
|
}
|
|
```
|
|
|
|
|