接口请求域名： lkeap.intl.tencentcloudapi.com 。
查询文档拆分任务结果
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetSplitDocumentResult。 |
| Version | 是 | String | 公共参数，本接口取值：2024-05-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-jakarta 。 |
| TaskId | 是 | String | 拆分任务ID |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态。 - Success：执行完成- Processing：执行中- Pause: 暂停- Failed：执行失败- WaitExecute：等待执行 |
| DocumentRecognizeResultUrl | String | 拆分结果的临时下载地址。 文件类型为zip压缩包，下载链接有效期30分钟。 压缩包内包含*.md、*.jsonl、*mllm.json以及images文件夹。 > jsonl 结构说明： - page_content:用于生成嵌入（embedding）库，以便于检索使用。该字段中的图片将使用占位符替换。 - org_data:表示与 page_content 对应的最小语义完整性块，用于问答模型的处理。 - big_data:表示与 page_content 对应的最大语义完整性块，也用于问答模型的处理。 |
| Usage | DocumentUsage | 文档拆分任务的用量 |
| Error | ErrorInfo | 文档拆分失败的错误信息，当拆分任务失败时返回该错误信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
查询文档拆分结果
POST / HTTP/1.1
Host: lkeap.intl.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
}
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.FileParseError | 解析失败。 |
| FailedOperation.FileParseTimeout | 文档解析超时。 |
| FailedOperation.InternalError | 内部错误。 |
| InvalidParameter.FileURLInvalid | 文件url链接不正确。 |
| InvalidParameter.InvalidFileFormat | 无效的文件格式。 |
| InvalidParameter.InvalidFileType | 无效的文件类型。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceUnavailable.ResourcePackageRunOut | 账号资源包耗尽。 |
| ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |
文档反馈