文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>腾讯云智能体开发平台>API 文档>文档库相关接口>知识库文档录入

知识库文档录入

最近更新时间：2025-08-18 02:05:08

我的收藏

本页目录：

1. 接口描述

接口请求域名： lke.tencentcloudapi.com 。

知识库文档问答保存。
将文件存储到应用的知识库内需要三步：
1.获取临时密钥，参考接口文档。获取临时密钥不同参数组合权限不一样，可参考 智能体开发平台操作 cos 指南
2.调用腾讯云提供的 cos 存储接口，将文件存储到智能体开发平台 cos 中：具体可参考 COS SDK 概览, 注意使用的是临时密钥的方式操作 COS
3.调用本接口，将文件的基础信息存储到智能体开发平台中。
以上步骤可参考文档，文档最后有代码demo，可作为参考。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SaveDoc。
Version 是 String 公共参数，本接口取值：2023-11-30。
Region 是 String 公共参数，详见产品支持的 地域列表。
BotBizId 是 String 应用ID
示例值：1727231073371148288
FileName 是 String 文件名
示例值：测试.docx
FileType 是 String 文档支持下面类型
pdf、doc、docx、ppt、mhtml、pptx、wps、ppsx，单个文件不超过200MB；
xlsx、xls、md、txt、csv、html，单个文件不超过20MB；

图片支持下面类型：
jpg、png、jpeg、tiff、bmp、gif，单个文件不超过50MB
示例值：docx
CosUrl 是 String 平台cos路径，与DescribeStorageCredential接口查询UploadPath参数保持一致
示例值：/corp/1258039/doc/wcWoEmlMXOp.docx
ETag 是 String ETag 全称为 Entity Tag，是对象被创建时标识对象内容的信息标签，可用于检查对象的内容是否发生变化 成功上传cos后，从返回头中获取
示例值："58e88ad7665f11c4f66eba0eada383a5"
CosHash 是 String cos_hash x-cos-hash-crc64ecma 头部中的 CRC64编码进行校验上传到云端的文件和本地文件的一致性
成功上传cos后，从返回头中获取

请注意：
cos_hash为文档唯一性标识，与文件名无关 相同的cos_hash会被判定为重复文档
示例值："1de165cdf1362b18c83592c7030af992"
Size 是 String 文件大小
示例值：643000
AttrRange 否 Integer 标签适用范围，需要传参为1
示例值：1
Source 否 Integer 来源（0 从本地文档导入），默认值为0
示例值：0
WebUrl 否 String 自定义链接地址, IsRefer为true的时候，该值才有意义
示例值：https://cloud.tencent.com/
AttrLabels.N 否 Array of AttrLabelRefer 标签引用
ReferUrlType 否 Integer 外部引用链接类型 0：系统链接 1：自定义链接
值为1时，WebUrl 字段不能为空，否则不生效。
示例值：0
ExpireStart 否 String 有效开始时间，unix秒级时间戳
示例值：1753278682
ExpireEnd 否 String 有效结束时间，unix秒级时间戳，0代表永久有效
示例值：1753325001
IsRefer 否 Boolean 是否引用链接
示例值：false
Opt 否 Integer 文档操作类型：1：批量导入（批量导入问答对）；2:文档导入（正常导入单个文档） 默认为1
请注意，opt=1的时候请从腾讯云智能体开发平台页面下载excel模板
示例值：2
CateBizId 否 String 分类ID
示例值：1948014278153560
IsDownload 否 Boolean 是否可下载，IsRefer为true并且ReferUrlType为0时，该值才有意义
示例值：false
DuplicateFileHandles.N 否 Array of DuplicateFileHandle 重复文档处理方式，按顺序匹配第一个满足条件的方式处理
SplitRule 否 String 自定义切分规则

请求参数为一个 JSON Object，具体格式可参见接口示例值。包含以下主要字段：

| 字段名 | 类型 | 说明 |
|--------------------|--------|----------------------------------------|
| xlsx_splitter | Object | Excel（xlsx）文件切分策略配置，仅当处理 Excel 文件时有效 |
| common_splitter | Object | 通用文件（如 txt、pdf 等）切分策略配置，按页或按标签切分 |
| table_style | String | 表格内容的输出格式，如 HTML 或 Markdown |

---

## xlsx_splitter（Excel 切分策略）

用于配置 表格文件的切分方式。
类型：Object

json<br/>"xlsx_splitter": {<br/> "header_interval": [1, 2],<br/> "content_start": 10,<br/> "split_row": 2<br/>}<br/>


### 字段说明：

| 字段名 | 类型 | 说明 |
|-------------------|--------|----------------------------------------------------------------------|
| header_interval | Array<Number> | 表头所在的行区间，格式为 [起始行, 结束行]，行号从 1 开始计数。例如 [1, 2] 表示第 1~2 行为表头。 |
| content_start | Number | 表格内容的起始行号（从 1 开始）。 |
| split_row | Number | 切分行数。 |

---
## common_splitter（通用文件切分策略）

用于配置 非 Excel 文件（如 TXT、PDF、DOCX 等）的切分方式，支持两种策略：按页切分（page） 或 按标识符切分（tag）。

类型：Object

json<br/>"common_splitter": {<br/> "splitter": "page",<br/> "page_splitter": {<br/> "chunk_length": 1000,<br/> "chunk_overlap_length": 100<br/> }<br/>}<br/>


### 字段说明：

| 字段名 | 类型 | 说明 |
|-------------------|--------|---------------------------------------------------|
| splitter | String | 切分策略类型，可选值为："page"（按页切分） 或 "tag"（按标识符切分）。 |
| page_splitter | Object | 按页切分的配置。 |
| page_splitter.chunk_length | 1000 | 切片最大长度。 |
| page_splitter.chunk_overlap_length | 100 | 切片重叠长度。 |
| tag_splitter | Object | 自定义切分配置。 |
| tag_splitter.tag | Array<String> | 切分标识符。 |
| tag_splitter.chunk_length| Number | 切片最大长度。 |
| tag_splitter.chunk_overlap_length | Number | 切块重叠长度。 |

🔹 补充说明：

- splitter 字段的值可以是：
- "page"：只使用按页切分逻辑，此时只需要关心 page_splitter 相关字段。
- "tag"：只使用按标识符（如分号、换行等）切分逻辑，此时关注 tag_splitter。
---

## table_style（表格输出样式）

用于指定 表格类内容（比如从 Excel 或 CSV 中提取的表格）最终以何种格式返回，方便前端展示或后续处理。

类型：String

json<br/>"table_style": "md"<br/>


### 字段说明：

| 字段名 | 类型 | 说明 |
|--------------|--------|----------------------------------------------------------------------|
| table_style | String | 指定表格内容的输出格式。可用值：
• "html"：以 HTML 表格形式返回，适合网页展示。
• "md"：以 Markdown 表格语法返回，适合文档或 Markdown 渲染环境。|
示例值：{"split_config_new":{"table_style":"md","rm_spec_symbol":1,"xlsx_splitter":{"header_interval":[1,1],"content_start":2,"split_row":1},"common_splitter":{"splitter":"tag","tag_splitter":{"tag":["\n"],"chunk_length":1000,"chunk_overlap_length":100}}}}
UpdatePeriodInfo 否 UpdatePeriodInfo 文档更新频率

3. 输出参数

参数名称 类型 描述
DocBizId String 文档ID
示例值：1948014278153560
ErrorMsg String 导入错误信息
示例值：文件数据存在错误，请下载并查看错误标注文件
ErrorLink String 错误链接
示例值：https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/%2Fcorp/xxxx
ErrorLinkText String 错误链接文本
示例值：下载
DuplicateFileCheckType Integer 重复类型，0：未重复，其他取值请参考入参DuplicateFileHandle结构体的CheckType字段
示例值：0
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 知识库文档录入

输入示例

POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SaveDoc
<公共请求参数>

{
    "BotBizId": "1727231073371148288",
    "FileName": "测试.docx",
    "FileType": "docx",
    "CosUrl": "/corp/23432432/233432/doc/zeSOHIBjwcWoEmlMMXOp-1796022574489010176.docx",
    "ETag": "\"58e88ad7665f11c4f66eba0eada383a5\"",
    "CosHash": "xxxxxxxxx",
    "Size": "643000",
    "Source": 0,
    "WebUrl": "",
    "AttrRange": 1,
    "AttrLabels": [],
    "ReferUrlType": 0
}

输出示例

{
    "Response": {
        "DocBizId": "1694921462777761792",
        "ErrorMsg": "",
        "ErrorLink": "",
        "ErrorLinkText": "",
        "RequestId": "e3338103-3165-49c0-b218-245be865cca5"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
中国站
目录