知识引擎原子能力实时文档上传-RAG综合能力相关接口-API 中心-腾讯云

1. 接口描述

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

用于上传实时文档内容。
实时文档在上传后可以立即通过SearchRealtime进行实时检索，适用于在会话中对文档进行问答的场景。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UploadDocRealtime。
Version	是	String	公共参数，本接口取值：2024-05-22。
Region	是	String	公共参数，详见产品支持的地域列表。
KnowledgeBaseId	是	String	知识库ID 示例值：4901991032
FileName	是	String	文件名，可选。需带文件类型后缀，当文件名无法从传入的`FileUrl`获取时需要通过该字段来明确。示例值：example.pdf
FileType	是	String	文件类型。支持的文件类型： - `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB` 支持的文件大小： - `PDF`、`DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M - `TXT`、`MD` 最大10M - 其他最大20M 示例值：PDF
FileUrl	是	String	文件的 URL 地址。文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。非腾讯云存储的 URL 速度和稳定性可能受一定影响。参考：腾讯云COS文档示例值：https://example.com/example.pdf
ExpireTime	否	Integer	过期时间的秒数，最长24小时，默认24小时示例值：86400

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。

4. 示例

示例1 实时文档上传

实时文档上传

输入示例

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

{
    "KnowledgeBaseId": "594669442",
    "FileName": "changan-short.doc",
    "FileType": "DOC",
    "FileUrl": "https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/2024-08-20/1251316161/20548499/changan-short.doc?q-sign-algorithm=sha1&q-ak=AKxxxxxxx&q-sign-time=1726245910;1726253110&q-key-time=1726245910;1726253110&q-header-list=&q-url-param-list=&q-signature=114996cce2050ca1edbe6e69606e5c01b4c5a3a1"
}

输出示例

{
    "IsFinal": true,
    "DocId": "1828430526517084160",
    "Progress": 80,
    "PageNum": 0,
    "Status": "SUCCESS"
}

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 CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。