文档中心>API 中心

查询文档解析结果

最近更新时间:2024-05-24 01:53:37

我的收藏

1. 接口描述

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

查询文档解析结果。该接口需开通文档解析原子能力后调用。文档解析原子能力内测中,如有需要请联系架构师或联系客服

默认接口请求频率限制:50次/秒。

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Status String 等待 / 执行中 / 成功 / 失败
示例值:waiting / running / success / fail
Name String 解析后的文件内容
示例值:产品文档.zip
Url String 文件下载地址
示例值:https://file.download.com/产品文档.zip
Reason String 解析失败原因
示例值:convert task fail
Usage Usage 消耗量,输出页数
示例值:{"TotalPages":10}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文档解析结果

查询文档解析结果

输入示例

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

{
    "TaskId": "D78iBBGi"
}

输出示例

{
    "Response": {
        "Name": "D78iBBGi.zip",
        "Reason": "",
        "RequestId": "acd2b5f3-350f-4171-92be-e1c70f3e73d7",
        "Status": "success",
        "Url": "https://qidian-qbot-test-1251316161.cos.ap-guangzhou.myqcloud.com/%2Fatomic/2/D78iBBGi.zip?q-sign-algorithm=sha1&q-ak=xxxxxxxxx&q-sign-time=1706792626%3B1706796226&q-key-time=1706792626%3B1706796226&q-header-list=host&q-url-param-list=&q-signature=e3d46a97846b256ff89f3698*******************",
        "Usage": {
            "TotalPages": 1
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
RequestLimitExceeded 请求的次数超过了频率限制。