知识引擎原子能力创建文档解析任务-原子能力相关接口-API 中心-腾讯云

1. 接口描述

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

本接口为异步接口的发起请求接口，用于发起文档解析任务。
文档解析支持将图片或PDF、DOCX、PPTX、EXCEL等文件转换成Markdown格式文件，可解析包括表格、公式、图片、标题、段落、页眉、页脚等内容元素，并将内容智能转换成阅读顺序。具体支持文件类型请查看下方输入参数列表。

体验期间单账号限制qps仅为1，若有正式接入需要请与产研团队沟通开放。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateReconstructDocumentFlow。
Version	是	String	公共参数，本接口取值：2024-05-22。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou 。
FileType	是	String	文件类型。支持的文件类型： - `PDF`、`DOC`、`DOCX`、`XLS`、`XLSX`、`PPT`、`PPTX`、`MD`、`TXT`、`PNG`、`JPG`、`JPEG`、`CSV`、`HTML`、`EPUB`、`BMP`、`GIF`、`WEBP`、`HEIC`、`EPS`、`ICNS`、`IM`、`PCX`、`PPM`、`TIFF`、`XBM`、`HEIF`、`JP2` 支持的文件大小： - `PDF` 最大500M - `DOCX`、`DOC`、`PPT`、`PPTX` 最大 200M - `TXT`、`MD` 最大10M - 其他最大20M 示例值：PDF
FileUrl	否	String	文件的 URL 地址。文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，建议文件存储于腾讯云。非腾讯云存储的 URL 速度和稳定性可能受一定影响。参考：腾讯云COS文档
FileBase64	否	String	文件的 Base64 值。支持的文件类型： PNG、JPG、JPEG、PDF、GIF、BMP、TIFF 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过 3 秒。支持的图片像素：单边介于20-10000px之间。文件的 FileUrl、FileBase64 必须提供一个，如果都提供，只使用 FileUrl。
FileStartPageNumber	否	Integer	文档的起始页码。当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的起始页码，识别的页码包含当前值。示例值：1
FileEndPageNumber	否	Integer	文档的结束页码。当传入文件是PDF、PDF、PPT、PPTX、DOC类型时，用来指定识别的结束页码，识别的页码包含当前值。示例值：100
Config	否	CreateReconstructDocumentFlowConfig	创建文档解析任务配置信息。示例值：{"TableResultType":"1"}

3. 输出参数

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

4. 示例

示例1 接口请求成功示例

输入示例

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

{
    "FileType": "PDF",
    "FileUrl": "http://example.com/example.pdf"
}

输出示例

{
    "Response": {
        "RequestId": "1d569fb4-4c9d-4141-bbd7-e1d8735bd1a9",
        "TaskId": "123123123"
    }
}

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.DownLoadError	FailedOperation.DownLoadError
FailedOperation.FileDecodeFailed	FailedOperation.FileDecodeFailed
FailedOperation.ImageDecodeFailed	FailedOperation.ImageDecodeFailed
FailedOperation.UnKnowError	内部未知错误。
FailedOperation.UnKnowFileTypeError	FailedOperation.UnKnowFileTypeError
FailedOperation.UnOpenError	服务未开通。
InvalidParameterValue.InvalidParameterValueLimit	参数值错误。
LimitExceeded.TooLargeFileError	文件太大
ResourceUnavailable.InArrears	帐号已欠费。
ResourceUnavailable.ResourcePackageRunOut	账号资源包耗尽。
ResourcesSoldOut.ChargeStatusException	计费状态异常。

创建文档解析任务

本页目录：