Skip to main content

数据集 — web/lib/api 模块

模块位置

web/lib/api/datasets.ts 导出 datasetApi 对象,通过 openapiRequest / apiClient 调用后端 REST API。

方法索引

分组方法HTTP说明
CRUDcreatePOST /datasets/新建数据集
listGET /datasets/分页列表,支持 category_id 过滤
getGET /datasets/{id}单条详情
updatePATCH /datasets/{id}更新元数据
deleteDELETE /datasets/{id}删除
purgePOST /datasets/{id}/purge清理已删除文档
clonePOST /datasets/{id}/clone克隆数据集
分类树listTreeGET /datasets/categories/tree完整分类树
getCategories / setCategoriesGET/PUT数据集所属分类
入库策略getIngestionPolicyGET获取策略
updateIngestionPolicyPUT更新策略
importIngestionPolicyPOST (FormData)导入策略文件
exportIngestionPolicyGET → Blob导出策略
rollbackIngestionPolicyPOST回滚到历史版本
画像getProfileSummaryGET画像摘要
startProfileScanPOST启动画像扫描
listProfileScanRunsGET扫描历史
预检startPrecheckScanPOST启动预检扫描
getPrecheckSummaryGET预检摘要
suggestPrecheckIngestionPolicyGET根据预检结果建议策略
表 / TAGqueryTablePOSTSQL 查询
askTablePOST自然语言查询
lotusSemFilterPOST语义过滤
健康getHealthGET数据集健康度
getIngestionStatsGET入库统计
info

所有类型定义来自 @/types(由 openapi-typescript 生成)。后端 OpenAPI 变更后需重新生成前端类型。

调用示例

// 获取数据集列表(带分类过滤)
const result = await datasetApi.list({
category_id: selectedCategoryId,
skip: page * pageSize,
limit: pageSize,
});

// 启动预检扫描
const run = await datasetApi.startPrecheckScan(datasetId);

SSE 流式接口

web/lib/api/streaming.ts 提供 sseApi.streamPrecheckScanEvents(),用于预检扫描实时事件推送。

tip

SSE 连接断开时前端会自动降级为轮询模式,无需手动处理重连。

请求取消

所有 API 方法支持传入 AbortSignal 参数。页面卸载或切换数据集时,前端通过 AbortController 取消进行中的请求,避免状态竞争。

相关链接