文字识别异步多模态文档解析（查询任务）

1. 接口描述

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

用于查询异步多模态文档解析任务的执行状态与结果，任务执行成功时返回解析结果包的下载地址，任务执行失败时返回对应错误信息。需要 SubmitMultimodalDocParseJob（创建任务）、DescribeMultimodalDocParseJob（查询任务）两个接口配套使用，计费发生在提交任务后。

创建任务接口文档地址：https://cloud.tencent.com/document/product/1024/953218

默认接口请求频率限制：5 页并发（注：可同时解析5页，且同步和异步接口共享并发资源，支持增购并发）。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeMultimodalDocParseJob。
Version	是	String	公共参数，本接口取值：2018-11-19。
Region	否	String	公共参数，此参数为可选参数。
TaskId	是	String	解析任务ID。由创建任务接口返回。示例值：1493508761820692480

3. 输出参数

参数名称	类型	描述
Status	String	任务状态。取值： Created：已创建，等待处理 Processing：处理中 Success：成功 Failed：失败 Unknown：未知示例值：Success
ErrorCode	String	任务执行错误码。当任务状态不为 Failed 时，该值为“”。示例值：InvalidParameterValue.InvalidParameterValueLimit
ErrorMessage	String	任务执行错误信息。当任务状态不为 Failed 时，该值为“”。示例值：未知错误。
ResultUrl	String	结果的临时下载地址。文件类型为 zip 压缩包，下载链接有效期 30 分钟。压缩包内包含 .md、.json 以及 images 文件夹。仅当任务状态为 Success 时返回该字段。示例值：https://ocr-smartdoc-1258344699.cos.ap-guangzhou.myqcloud.com/multimodal-doc-parse/result/251138**0/1493508761820692480/result.zip
FailedPages	Array of ReconstructDocumentFailedPage	解析失败的页码列表。仅当任务状态为 Success 时返回该字段。
SuccessPageNum	Integer	解析成功页数。示例值：1
FailPageNum	Integer	解析失败页数。示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务成功示例

输入示例

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

{
    "TaskId": "1493508761820692480"
}

输出示例

{
    "Response": {
        "ErrorCode": "",
        "ErrorMessage": "",
        "FailPageNum": 0,
        "ResultUrl": "https://ocr-smartdoc-1258344699.cos.ap-guangzhou.myqcloud.com/multimodal-doc-parse/result/251138**0/1493508761820692480/result.zip?q-sign-algorithm=sha1&q-ak=*KID1o*JyNjUcV7UbSNLo69woR0KPzLSF*VG&q-sign-time=178997464*%3B1*8*9*6447&q-key-time=17899746**%3B1789976447&q-header-list=host&q-url-param-list=&q-signature=f986bbc310f7684eef0c359a36ae5b09f35c8a68",
        "Status": "Success",
        "SuccessPageNum": 1,
        "RequestId": "376ecd73-a87f-4f61-8075-8d94260161e9"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.OcrFailed	OCR识别失败。
FailedOperation.UnKnowError	未知错误。
InvalidParameterValue.InvalidParameterValueLimit	参数值错误。

异步多模态文档解析（查询任务）

本页目录：