1. 接口描述
接口请求域名： lkeap.tencentcloudapi.com 。
用于上传文档内容。上传的文档将存储在知识库中，可以通过RetrieveKnowledge知识库内容检索接口进行检索。
使用场景：适用于需要长期存储和检索的文档内容，如产品手册、用户指南等。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UploadDoc。 |
| Version | 是 | String | 公共参数，本接口取值：2024-05-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| KnowledgeBaseId | 是 | String | 知识库ID 示例值：4901991032 |
| FileName | 是 | String | 文件名。 需带文件类型后缀 示例值：example.pdf |
| FileType | 是 | String | 文件类型。 支持的文件类型： - PDF、DOC、DOCX、XLS、XLSX、PPT、PPTX、MD、TXT、PNG、JPG、JPEG、CSV支持的文件大小： - PDF、DOCX、DOC、PPT、PPTX 最大 200M- TXT、MD 最大10M- 其他 最大20M 示例值：PDF |
| FileUrl | 是 | String | 文件的 URL 地址。 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。 非腾讯云存储的 URL 速度和稳定性可能受一定影响。 参考：腾讯云COS文档 示例值：https://example.com/example.pdf |
| AttributeLabels.N | 否 | Array of AttributeLabelReferItem | 属性标签引用 |
| Config | 否 | SegmentationConfig | 分段信息 示例值：{"MaxChunkSize":4800} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DocId | String | 文档ID 示例值：1830996257452865536 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 上传无属性标签文档
上传无属性标签文档
输入示例
POST / HTTP/1.1
Host: lkeap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UploadDoc
<公共请求参数>
{
"KnowledgeBaseId": "4901991032",
"FileName": "example.pdf",
"FileType": "PDF",
"FileUrl": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.pdf"
}输出示例
{
"Response": {
"DocId": "1830996257459865536",
"RequestId": "804c3fe0-05b1-48f9-8003-ab118658fec7"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
