查询文档解析任务结果

最近更新时间:2024-08-15 01:58:35

我的收藏

1. 接口描述

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

本接口为异步接口的查询结果接口,用于获取文档解析处理结果。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetReconstructDocumentResult。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 任务唯一id

3. 输出参数

参数名称 类型 描述
Status String 任务状态: Success->执行完成;Processing->执行中;Failed->执行失败;WaitExecute->等待执行;
DocumentRecognizeResultUrl String 输入文件中嵌入的图片中文字内容的识别结果,存储在腾讯云cos的下载地址
FailedPages Array of ReconstructDocumentFailedPage 文档解析失败的页码
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 接口调用成功示例

输入示例

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

{
    "TaskId": "123123123"
}

输出示例

{
    "Response": {
        "DocumentRecognizeResultUrl": "https://document-restruction-1258344699.cos.ap-guangzhou.myqcloud.com/doc_parse/output_files/a9c6a9482c72412fa84445a44ss125531.zip?q-sign-algorithm=sha1&q-ak=AKIDlWFaadfHLNbidLwPqOrAKGzXrx40scL7l&q-sign-time=1715503711%3B1718804311&q-key-time=1718855711%3B1718804311&q-header-list=host&q-url-param-list=&q-signature=71b568b8632d7e45gertdc3d235ef68d41fdfe7f8",
        "FailedPages": [],
        "RequestId": "a37b0d0b-c3af-44bd-iuiu-632442644a80",
        "Status": "Success"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.ResourcePackageRunOut 账号资源包耗尽。
ResourcesSoldOut.ChargeStatusException 计费状态异常。