1. 接口描述
接口请求域名: mrs.tencentcloudapi.com 。
将PDF格式的体检报告文件结构化,解析关键信息。
注意:该接口是按照体检报告 PDF 页面数量统计次数,不是按照 PDF 文件数量统计次数。通过该接口传入的报告必须是体检报告,非体检报告可能无法正确解析。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:TurnPDFToObject。 |
Version | 是 | String | 公共参数,本接口取值:2020-09-10。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PdfInfo | 是 | PdfInfo | 体检报告PDF文件信息, 目前只支持传PDF文件的Base64编码字符(PDF文件不能超过10MB,如果超过建议先压缩PDF,再转成base64) |
TextBasedPdfFlag | 否 | Boolean | PDF文件中的文字是否为文本内容. 如果该字段为true,那么就会自动判断是电子版还是图片,自动选择直接读取文字还是 OCR 方式. 如果该字段为false, 那么始终采用 OCR 方式 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Template | Template | 报告结构化结果 示例值:object |
TextTypeList | Array of TextType | 多级分类结果 示例值:[object] |
Block | Block | 报告结构化结果(体检报告PDF结构化接口返回的 json 内容非常多,建议通过本地代码调用) 示例值:object |
IsBlock | Boolean | 是否使用Block字段 示例值:true |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 体检报告PDF文件结构化
解析PDF格式的体检报告文件,提取关键信息.
输入示例
POST / HTTP/1.1
Host: mrs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: TurnPDFToObject
<公共请求参数>
{
"PdfInfo": {
"Base64": "PDF文件Base64字符串"
}
}
输出示例
{
"Response": {
"Block": {
"Indicator": [
{
"Indicators": [
{
"Arrow": "",
"Code": "SG",
"Coords": null,
"Id": 239,
"InferNormal": "正常",
"ItemString": "尿比重",
"Name": "尿比重",
"Normal": true,
"Range": "1.01--1.025",
"Result": "1.020",
"Scode": "U-SG",
"Sname": "比重",
"Unit": ""
}
]
}
],
"IndicatorV3": [],
"Maternity": [],
"MedDoc": [],
"MedDocV2": [],
"MedicalRecordInfo": [],
"Pathology": [],
"PathologyV2": [],
"PhysicalExamination": null,
"Prescription": [],
"Surgery": [],
"TextTypeListBlocks": [
{
"TextTypeList": [
{
"Id": 16,
"Level": 1,
"Name": "无文字"
}
]
},
{
"TextTypeList": [
{
"Id": 18,
"Level": 1,
"Name": "体检报告"
},
{
"Id": 232,
"Level": 2,
"Name": "物理检查"
}
]
}
],
"Timeline": [],
"VaccineCertificate": []
},
"IsBlock": true,
"RequestId": "5d59c52e-f543-4b19-b9d0-e66b5c5d0011",
"Template": {
"BirthCert": null,
"C14": null,
"Check": null,
"Covid": null,
"DiagCert": null,
"Electrocardiogram": null,
"Endoscopy": null,
"Exame": null,
"Eye": null,
"FirstPage": null,
"Hospitalization": null,
"Indicator": null,
"IndicatorV3": null,
"Maternity": null,
"MedDoc": null,
"MedDocV2": null,
"MedicalRecordInfo": null,
"OcrResult": "健康体检报告\nMEDICAL EXAMINATION REPORT\n 项目号: 性别:男\n 检查日期:\n 1/12\n\n 阳性结果和异常情况\n [1]体重指数增高\n [2]\n 无高血压病史(本次体检血压增高)\n [3]\n 轻度脂肪肝\n [4]气体干扰,胰腺显示欠清\n [5]\n 左\n 肾结晶\n [6]红细胞分布宽度-标准差降低\n [7]\n 丙氨酸氨基转移酶增高;γ-谷氨酰转移酶增高\n [8]\n 尿酸増高\n [9]\n 总胆固醇增高;低密度脂蛋白胆固醇增高;甘油三酯增高\n [10]幽门螺杆菌抗体阳性\n [11]双眼视力减退原因待查\n 专家建议与指导...",
"OcrText": "a",
"Pathology": null,
"PathologyV2": null,
"PatientInfo": {
"Address": "",
"Age": "",
"AgeNorm": "",
"BedNo": "",
"BirthPlace": "",
"Birthday": "",
"EducationBackground": "",
"Ethnicity": "",
"HealthCardNo": "",
"IdCard": "",
"Married": "",
"MarriedCode": "",
"MedicalInsuranceType": "",
"MedicalInsuranceTypeCode": "",
"Name": "",
"Nation": "",
"Nationality": "",
"Phone": "",
"Profession": "",
"ProfessionCode": "",
"Sex": "男",
"SocialSecurityCardNo": ""
},
"Prescription": null,
"ReportInfo": {
"BedNo": "",
"BillingTime": "",
"CheckItem": "",
"CheckMethod": "",
"CheckNum": "",
"DepartmentName": "",
"Diagnose": "",
"DiagnoseTime": "",
"HealthCheckupNum": "",
"Hospital": "",
"ImageNum": "",
"InHospitalNum": "",
"InspectTime": "",
"MedicalRecordNum": "",
"OtherTime": "",
"OutpatientNum": "",
"PathologyNum": "",
"PrintTime": "",
"RadiationNum": "",
"ReportName": "健康体检报告",
"ReportTime": "",
"SampleNum": "",
"SampleType": "",
"TestNum": "",
"Times": [],
"UltraNum": ""
},
"ReportType": "physical_examination",
"ReportTypeDesc": "体检报告",
"Surgery": null,
"Timeline": null,
"VaccineCertificate": null
},
"TextTypeList": [
{
"Id": 18,
"Level": 1,
"Name": ""
}
]
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ServiceNotOpen | 服务未开通。 |
InternalError.ServerTimeOutError | 服务调用超时。 |