知识引擎原子能力查询文档拆分任务结果

1. 接口描述

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

查询文档拆分任务结果

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetSplitDocumentResult。
Version	是	String	公共参数，本接口取值：2024-05-22。
Region	是	String	公共参数，详见产品支持的地域列表。
TaskId	是	String	拆分任务ID 示例值：236e51fd-827b-41cb-b303-56003a817ce5

3. 输出参数

参数名称	类型	描述
Status	String	任务状态。 - `Success`：执行完成 - `Processing`：执行中 - `Pause`: 暂停 - `Failed`：执行失败 - `WaitExecute`：等待执行示例值：Success
DocumentRecognizeResultUrl	String	拆分结果的临时下载地址。文件类型为zip压缩包，下载链接有效期30分钟。压缩包内包含.md、.jsonl、mllm.json以及images文件夹。 > jsonl* 结构说明： - `page_content`: 用于生成嵌入（embedding）库，以便于检索使用。该字段中的图片将使用占位符替换。 - `org_data`: 表示与 page_content 对应的最小语义完整性块，用于问答模型的处理。 - `big_data`: 表示与 page_content 对应的最大语义完整性块，也用于问答模型的处理。示例值：https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.zip
Usage	DocumentUsage	文档拆分任务的用量示例值：{"PageNumber":10,"TotalTokens":2048}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文档拆分结果

查询文档拆分结果

输入示例

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

{
    "TaskId": "236e51fd-827b-41cb-b303-56003a817ce5"
}

输出示例

{
    "Response": {
        "DocumentRecognizeResultUrl": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/example/example.zip",
        "RequestId": "ffe23ed8-2b64-4835-aedc-ca9a5b5a7384",
        "Status": "Success",
        "Usage": {
            "PageNumber": 10,
            "TotalTokens": 2048
        }
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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