上传知识库文档

上传知识库文档
接口详情官网地址: https://www.gugudata.com/api/details/knowledge-chat

上传文档并构建私有知识库

请求方法: POST
接口路径: /ai/knowledge-bases/{knowledge_base_id}/documents
调试地址: https://api.gugudata.com/ai/knowledge-bases/default/documents
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

knowledge_base_id (string, 必填): URL 路径中的知识库标识，默认可使用 default

appkey (string, 必填): 付费后获取的 APPKEY

files (file[], 必填): 待上传文档，支持 PDF、TXT、Markdown、HTML 和 DOCX；单次最多 5 个文件，单文件最大 20MB

tenant_id (string, 可选): 客户侧业务分组标识，不传时使用 default

metadata (object, 可选): 客户自定义元数据，需为 JSON 对象

replace_existing (boolean, 可选): 是否替换同知识库下已有同名文档，默认 false

返回字段:

DataStatus.StatusCode: 接口返回状态码

DataStatus.StatusDescription: 接口返回状态说明

DataStatus.ResponseDateTime: 接口数据返回时间

DataStatus.DataTotalCount: 本次处理文档数量

Data.knowledge_base_id: 知识库标识

Data.documents[].document_id: 文档 ID

Data.documents[].file_name: 文件名称

Data.documents[].file_size: 文件大小，单位为字节

Data.documents[].status: 文档处理状态

Data.documents[].parse_status: 文档解析状态

Data.documents[].index_status: 索引入库状态

Data.documents[].chunk_count: 文档分块数量

Data.documents[].token_estimate: 文档内容的 token 估算数量

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 请求成功

101 参数错误: 请求参数不完整或无效

102 请求频率受限: 默认每个来源 IP 对同一接口最多 5 QPS。

103 文件错误: 未提供文件、文件格式不支持或文件超出限制

104 APPKEY 错误: APPKEY 无效或未授权

接口特性:

支持 PDF、TXT、Markdown、HTML 和 DOCX 文档上传；

支持按知识库标识组织客户文档，便于多项目接入；

上传完成后可通过 AI 文档知识库问答接口进行多轮问答；

支持客户侧业务分组标识，便于按业务线隔离数据；

支持自定义 metadata，便于业务系统记录来源信息；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口调用状态与状态监控：https://www.gugudata.com/status。

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

请求参数

请求示例代码

返回响应