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

1. 接口描述

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

本接口为异步多模态文档解析的任务提交接口，支持解析多种类型的文档文件（PDF、Word、PPT、Excel、Markdown、TXT、图片、WPS），服务端异步执行解析任务，提交后返回任务唯一 ID，可通过「异步多模态文档解析（查询任务）」接口获取最终解析结果。需要 SubmitMultimodalDocParseJob（创建任务）、DescribeMultimodalDocParseJob（查询任务）两个接口配套使用，计费发生在提交任务后。

查询任务接口文档地址：https://cloud.tencent.com/document/product/1024/953219

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SubmitMultimodalDocParseJob。
Version	是	String	公共参数，本接口取值：2018-11-19。
Region	否	String	公共参数，此参数为可选参数。
FileType	是	Integer	支持解析的文件类型。取值： 1：PDF 文档 2：Word 文档（.doc/.docx） 3：PPT 演示文稿（.ppt/.pptx） 4：Excel 表格（.xls/.xlsx） 5：Markdown 文档（.md） 6：纯文本文件（.txt） 7：图片文件（.png/.jpg/.jpeg 等） 8：WPS 文档支持的文件大小：PDF/WORD/PPT 支持 150M 且 300 页。示例值：7
FileUrl	否	String	文件的 Url 地址，支持 FileType 参数对应的文件格式及大小。文件下载时间不超过 3 秒。文件存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。示例值：http://example.com/doc.pdf
FileBase64	否	String	文件的 Base64 值。支持 FileType 参数对应的文件格式，支持的文件大小不超过 8M。文件下载时间不超过 3 秒。文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。示例值：/9j/4AAQSkZJRg.....s97n//2Q==
ResultType	否	Integer	输出格式。 1：json格式 2：markdown格式 3：xml格式 9：json+markdown+xml格式示例值：9
EnableSubImg	否	Boolean	是否开启子图提取，默认为 false。示例值：false
FileStartPageNumber	否	Integer	文档的起始页码。用来指定识别的起始页码，识别的页码包含当前值，不填时默认从文档第一页开始解析。本参数与 FileEndPageNumber 可分开填写，也可只填其中一个。示例值：1
FileEndPageNumber	否	Integer	文档的结束页码。用来指定识别的结束页码，识别的页码包含当前值，不填时默认解析到文档最后一页。本参数与 FileStartPageNumber 可分开填写，也可只填其中一个。示例值：100
TaskType	否	Integer	任务类型，默认为 0。取值： 0：默认 1：Free OCR 2：OCR 3：表格识别 4：代码识别示例值：0

3. 输出参数

参数名称	类型	描述
TaskId	String	任务唯一 ID。30天内可以通过DescribeMultimodalDocParseJob接口查询TaskId对应的处理结果。示例值：1491762633211215872
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功调用请求示例

输入示例

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

{
    "FileType": 7,
    "FileBase64": "/9j/4AAQSkZJRg.....s97n//2Q=="
}

输出示例

{
    "Response": {
        "TaskId": "1491762633211215872",
        "RequestId": "6ef2d07d-c954-4def-9da3-8cd693bed049"
    }
}

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	参数值错误。
LimitExceeded.TooLargeFileError	文件内容太大。
RequestLimitExceeded	请求的次数超过了频率限制。

异步多模态文档解析（创建任务）

本页目录：