查看 Markdown
GET/api/knowledge/library/list

查询知识库列表

分页查询当前调用方可见范围内的知识库,支持按名称关键词模糊搜索。API Key / OpenAPI 调用不传 scope 或传 app 时返回整个应用空间(X-App-Id)内的知识库;传 scope=principal 时,按当前 X-Principal-Id 查询 owner 知识库,并始终限制在当前 X-App-Id 内。用户控制台调用返回该用户自己创建的知识库,不受当前所在应用空间限制。可用 creatorType 按创建来源收窄。返回字段包含知识库 ID、名称、描述、文档数、创建时间、创建来源等摘要信息,不包含文档明细。适用于知识库管理页主列表展示。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数7 个字段

agentIdintegernullable

智能体ID(可选,传入后返回每条 enabled)

includeAgentGrantedbooleannullable

是否合并当前用户创建智能体所获的应用空间授权只读知识库

keywordstringnullable

搜索关键词(匹配创建时登记的知识库名称,内核改名后需等同步)

creatorTypestringnullable

创建来源过滤,可选值:user/apikey/app

scopestringnullable

查询范围,可选值:app/principal;principal 按当前 X-App-Id 和 X-Principal-Id 查询

pageintegernullable

页码,从1开始

pageSizeintegernullable

每页条数,取值范围1~100

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/library/create

创建知识库

在当前身份主体下创建一个新的知识库容器。知识库是文档的逻辑分组单位,后续上传的文档需指定归属知识库。名称在同一主体内不强制唯一,但建议保持业务可识别性;删除知识库会级联软删除其下所有文档。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)2 个字段

namestringrequired

知识库名称

descriptionstringnullable

知识库描述

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/library/rebuild

重建知识库

对知识库下所有文档发起语义树重建任务。当文档解析逻辑、提示词模板或LLM 模型升级后,可通过此接口批量重新生成语义树以应用新效果。API Key / OpenAPI 调用可重建整个应用空间(X-App-Id)内的知识库,用户控制台调用可重建该用户自己创建的知识库;越出范围返回 403。重建是异步任务,调用立即返回;过程中文档查询仍可访问旧版语义树。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数1 个字段

libraryIdintegerrequired

知识库ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/library/delete

删除知识库

软删除指定知识库及其下所有文档(设置 deleted_at 时间戳,不物理删除)。API Key / OpenAPI 调用可删除整个应用空间(X-App-Id)内的知识库,用户控制台调用可删除该用户自己创建的知识库;越出范围返回 403。删除后该知识库及其文档不再出现在任何查询接口中,已建立的语义树和向量索引会被异步清理。force=false 且库正被智能体引用时返回 409,data.agents 列出全部引用方(含不在本应用空间的,会带 appName 标注)。该操作不可撤销,调用前请二次确认。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数2 个字段

libraryIdintegerrequired

知识库ID

forcebooleannullable

是否强制删除(级联清理占用方)

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/knowledge/document/list

查询文档列表

分页查询指定知识库下的文档列表,支持按文件名关键词模糊搜索。API Key / OpenAPI 调用可查整个应用空间(X-App-Id)内的知识库,用户控制台调用可查该用户自己创建的知识库;越出范围返回 403。返回字段包含文档 ID、文件名、文件大小、解析状态、创建时间等摘要,不包含语义树明细。适用于知识库详情页文档列表。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数5 个字段

libraryIdintegerrequired

知识库ID

keywordstringnullable

搜索关键词

agentIdintegernullable

智能体ID,仅用于应用空间授权只读知识库

pageintegernullable

页码,从1开始

pageSizeintegernullable

每页条数,取值范围1~100

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/knowledge/document/tree

获取文档语义树

获取指定文档的完整语义树节点结构,包含每个节点的标题、层级、摘要、原文片段引用等。只能读取当前调用方可见范围内的文档:API Key / OpenAPI 调用可读整个应用空间(X-App-Id)内知识库的文档,用户控制台调用可读该用户自己创建的知识库的文档;文档不存在或越出范围均返回 403(两者不可区分,避免泄露文档是否存在)。语义树由 dianjin-agent 内核异步生成,若文档尚处于解析状态会返回空结构;前端应根据状态字段做空态展示。

请求参数

Query 参数2 个字段

documentIdintegerrequired

文档ID

agentIdintegernullable

智能体ID,仅用于应用空间授权只读知识库

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/knowledge/document/nodeContent

获取文档节点原文

按 nodeIds 批量提取指定文档语义树节点的原文正文内容。node_id 取自 knowledgeDocumentGetTree 返回的真实节点ID(4位数字,如 0001);API Key / OpenAPI 调用可读整个应用空间(X-App-Id)内知识库的文档,用户控制台调用可读该用户自己创建的知识库的文档,越出范围返回 403;同时校验文档归属该知识库;单次最多 50 个节点,超限报错;未命中的节点返回 status=not_found 占位。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数3 个字段

libraryIdintegerrequired

知识库ID

documentIdintegerrequired

文档ID

nodeIdsarrayrequired

节点ID列表(重复query参,如 &nodeIds=0001&nodeIds=0002),最多50个

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
GET/api/knowledge/document/download

下载文档原文件

校验调用方对该文档的访问权限后,生成 OSS 预签名 URL 并以 HTTP 302 重定向到该 URL,由浏览器原生触发下载。API Key / OpenAPI 调用可下载整个应用空间(X-App-Id)内知识库的文档,用户控制台调用可下载该用户自己创建的知识库的文档;文档不存在或越出范围均返回 403(两者不可区分,避免泄露文档是否存在)。预签名 URL 有短期有效期(默认数分钟),过期需重新调用本接口。响应头不附带任何业务数据,请通过 documentId 查询接口获取文件名等元信息。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数2 个字段

documentIdintegerrequired

文档ID

agentIdintegernullable

智能体ID,仅用于应用空间授权只读知识库

查看 Markdown
POST/api/knowledge/document/upload

上传知识库文件

前端通过 multipart/form-data 直传文件到后端,由后端代为上传至 OSS,返回 ossKey 后调用方再调用 /document/import 或 /document/importTable 进入解析链路。API Key / OpenAPI 调用可向整个应用空间(X-App-Id)内的知识库上传,用户控制台调用可向该用户自己创建的知识库上传;越出范围返回 403。单文件大小上限 100 MB,支持的扩展名:.pdf/.doc/.docx/.txt/.md/.markdown/.jpg/.jpeg/.png/.xlsx/.xls/.csv。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数1 个字段

libraryIdintegerrequired

目标知识库ID

Form Data1 个字段

filestringrequired

待上传文件

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/document/parseTableStructure

解析表格结构

读取已上传的 Excel/CSV 文件的列名和示例数据,作为后续配置导入映射的依据。预分析可能调用模型推断列映射,会产生知识编译用量,但不触发文档导入或语义树生成。新上传文件仅需ossKey,知识库、原始文件名及稳定文档用量身份由后端恢复。兼容显式libraryId/documentUsageId,提供时必须与上传记录一致;fileName不覆盖上传记录。升级前无上传记录的文件启用计费时仍需提供libraryId,或重新上传。表头行号 headerRow 默认 1、数据起始行号 dataStartRow 默认 2,适用于绝大多数标准模板。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)6 个字段

libraryIdintegernullable

可选目标知识库ID;新上传文件由后端恢复,提供时必须一致;历史无记录文件启用计费时需提供

documentUsageIdstringnullable

可选文档用量身份;新上传文件由后端维护,提供时必须一致;历史请求仍可沿用预分析返回值

fileNamestringnullable

可选原始文件名;以服务端上传记录为准,历史无记录时用于预分析用量展示

ossKeystringrequired

已上传文件的 OSS Key,由 /document/upload 接口返回

headerRowintegernullable

表头所在行号(从 1 开始),不传时默认 1

dataStartRowintegernullable

数据起始行号(从 1 开始),不传时默认 2

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/document/import

导入文档

将已通过 /document/upload 上传到 OSS 的文件导入指定知识库,触发后台解析与语义树生成流程。入参中的 ossKey 必须由本系统的上传接口返回,不接受外部直传的 OSS 路径。API Key / OpenAPI 调用可导入整个应用空间(X-App-Id)内的知识库,用户控制台调用可导入该用户自己创建的知识库;越出范围返回 403。导入是异步流程,文档解析状态可通过列表接口查询。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)4 个字段

libraryIdintegerrequired

所属知识库ID

ossKeystringrequired

文件上传后返回的OSS Key

fileNamestringrequired

原始文件名

fileSizeintegernullable

文件大小(字节),由上传接口返回

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/document/importTable

导入表格文档

将已上传的 Excel/CSV 表格文件按用户配置的列映射规则导入知识库,基于表头行号、数据起始行号、列到语义层级(一/二/三级标题/正文)的映射,生成结构化的语义树。导入前应先通过 /document/parseTableStructure 读取列名作为映射依据。API Key / OpenAPI 调用可导入整个应用空间(X-App-Id)内的知识库,用户控制台调用可导入该用户自己创建的知识库;越出范围返回 403。新上传文件的libraryId、fileName、fileSize、documentUsageId由后端上传记录恢复,客户端可省略;显式知识库或用量身份与记录不符时拒绝。升级前无记录的文件仍兼容原有参数。导入是异步流程。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

请求体(JSON)6 个字段

documentUsageIdstringnullable

可选文档用量身份;新上传文件自动关联预分析,提供时必须一致;历史请求仍可沿用预分析返回值

libraryIdintegernullable

可选目标知识库ID;新上传文件由后端恢复,提供时必须一致;历史无记录文件需提供

ossKeystringrequired

文件上传后返回的OSS Key

fileNamestringnullable

可选原始文件名;以服务端上传记录为准,历史无记录时兼容使用

表结构配置

fileSizeintegernullable

文件大小(字节),由上传接口返回

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/document/rebuild

重建文档语义树

对单个文档重新生成语义树。当文档解析逻辑或 LLM 模型升级后,可针对个别文档重建以验证新效果,或在文档导入失败后重试。API Key / OpenAPI 调用可重建整个应用空间(X-App-Id)内知识库的文档,用户控制台调用可重建该用户自己创建的知识库的文档;文档不存在或越出范围均返回 403(两者不可区分,避免泄露文档是否存在)。重建是异步任务,调用立即返回;过程中查询接口仍返回旧版语义树。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数1 个字段

documentIdintegerrequired

文档ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/document/delete

删除文档

软删除指定文档(设置 deleted_at 时间戳,不物理删除文件)。API Key / OpenAPI 调用可删除整个应用空间(X-App-Id)内知识库的文档,用户控制台调用可删除该用户自己创建的知识库的文档;文档不存在或越出范围均返回 403(两者不可区分,避免泄露文档是否存在)。文档对应的语义树和向量索引会被异步清理。OSS 上的原始文件保留,便于后续审计追溯;如需彻底清除原文件请联系管理员。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数1 个字段

documentIdintegerrequired

文档ID

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理

查看 Markdown
POST/api/knowledge/library/update

更新知识库

更新知识库的名称和描述。API Key / OpenAPI 调用可更新整个应用空间(X-App-Id)内的知识库,用户控制台调用可更新该用户自己创建的知识库;越出范围返回 403。改名会在本次请求内同步刷新列表搜索用的名称;同步失败时列表仍按旧名可搜,不影响改名本身。

请求参数

请求头参数1 个字段

X-Principal-Idintegernullable

身份主体ID(Long类型)。通过API访问时必须传递以标识操作主体;通过页面访问时无需传递。可通过「身份主体」模块的创建接口获取。

Query 参数3 个字段

libraryIdintegerrequired

知识库ID

namestringrequired

知识库名称

descriptionstringrequired

知识库描述

响应

200

httpStatusCodeintegernullable

HTTP状态码

messagestringnullable

响应消息

dataobjectnullable

响应数据

successbooleannullable

是否成功

requestIdstringnullable

上游请求ID,用于跨系统链路追踪排查问题

errCodestringnullable

上游错误码,前端可据此做特殊UI处理