体检报告PDF文件结构化-异步接口

最近更新时间:2024-03-12 01:42:08

我的收藏

1. 接口描述

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

体检报告PDF文件结构化-异步接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:TurnPDFToObjectAsync。
Version String 公共参数,本接口取值:2020-09-10。
Region String 公共参数,详见产品支持的 地域列表
PdfInfo PdfInfo 体检报告PDF文件信息, 目前只支持传PDF文件的Base64编码字符(PDF文件不能超过10MB,如果超过建议先压缩PDF,再转成base64)
TextBasedPdfFlag Boolean PDF文件中的文字是否为文本内容.
如果该字段为true,那么就会自动判断是电子版还是图片,自动选择直接读取文字还是 OCR 方式.
如果该字段为false, 那么始终采用 OCR 方式

3. 输出参数

参数名称 类型 描述
TaskID String 加密任务ID。
1、此 ID 是经过加密生成,是用于获取 PDF 返回 json 的凭证,需要由客户存储该 TaskID。
2、建议在获取到TaskID 后,5-10分钟后再调用 TurnPDFToObjectAsyncGetResult 接口获取 json 结果。
3、使用此接口,腾讯不会存储传入的 PDF 文件,但是会临时加密存储对应的 json 结果。如果不希望腾讯临时加密存储 json 结果,请使用 TurnPDFToObject 接口。
4、加密存储的 json 结果会24小时后定时自动删除,因此TaskID 仅 24 小时内有效,请在24小时内调用接口 TurnPDFToObjectAsyncGetResult 获取对应 json 结果。
5、TaskID 与腾讯云的账号绑定,通过 TurnPDFToObjectAsync 传入PDF文件和通过 TurnPDFToObjectAsyncGetResult 获取 json 结果,必须是同一个腾讯云账号。即其它人就算获取到 TaskID 也无法获取到 json 结果。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 体检报告PDF文件结构化异步接口

输入示例

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

{
    "PdfInfo": {
        "Base64": "PDF文件转base64之后的信息"
    }
}

输出示例

{
    "Response": {
        "TaskID": "taskID",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AsyncQueueFullError 异步队列中待处理消息较多,请待处理完成后再调用异步接口。
InternalError.ServerTimeOutError 服务调用超时。