1. 接口描述
接口请求域名： mrs.tencentcloudapi.com 。
图片转结构化对象
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ImageToObject。 |
| Version | 是 | String | 公共参数，本接口取值：2020-09-10。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Type | 是 | Integer | 报告类型，目前支持11（检验报告），12（检查报告），15（病理报告），28（出院报告），29（入院报告），210（门诊病历），212（手术记录），218（诊断证明），363（心电图），27（内窥镜检查），215（处方单），219（免疫接种证明），301（C14呼气试验）。如果不清楚报告类型，可以使用分类引擎，该字段传0（同时IsUsedClassify字段必须为True，否则无法输出结果） 示例值：1 |
| IsUsedClassify | 是 | Boolean | 是否使用分类引擎，当不确定报告类型时，可以使用收费的报告分类引擎服务。若该字段为 False，则 Type 字段不能为 0，否则无法输出结果。 注意：当 IsUsedClassify 为True 时，表示使用收费的报告分类服务，将会产生额外的费用，具体收费标准参见 购买指南的产品价格。 示例值：true |
| HandleParam | 否 | HandleParam | 图片处理参数 |
| ImageInfoList.N | 否 | Array of ImageInfo | 图片列表，允许传入多张图片，目前只支持传入图片base64编码，图片url暂不支持 |
| UserType | 否 | Integer | 后付费的用户类型，新客户传1，老客户可不传或传 0。2022 年 12 月 15 新增了计费项，在此时间之前已经通过商务指定优惠价格的大客户，请不传这个字段或传 0，如果传 1 会导致以前获得的折扣价格失效。在 2022 年 12 月 15 日之后，通过商务指定优惠价格的大客户请传 1。 示例值：0 |
| ReportTypeVersion.N | 否 | Array of ReportTypeVersion | 可选。用于指定不同报告使用的结构化引擎版本，不同版本返回的JSON 数据结果不兼容。若不指定版本号，就默认用旧的版本号。 （1）检验报告 11，默认使用 V2，最高支持 V3。 （2）病理报告 15，默认使用 V1，最高支持 V2。 （3）入院记录29、出院记录 28、病历记录 216、病程记录 217、门诊记录 210，默认使用 V1，最高支持 V2。 示例值：[{"ReportType":11,"Version":2}] |
| OcrInfoList.N | 否 | Array of OcrInfo | 可选。 图片OCR信息列表，每一个元素是一张图片的OCR结果。适用于不想将医疗报告图片传入腾讯云的客户，客户可对图片OCR信息中的敏感信息去除之后再传入。与 ImageInfoList 二选一，同时存在则使用OcrInfoList 示例值：[object] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Template | Template | 报告结构化结果 注意：此字段可能返回 null，表示取不到有效值。 |
| TextTypeList | Array of TextType | 多级分类结果 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 图片结构化
输入一张图片，得到结构化结果
输入示例
POST / HTTP/1.1
Host: mrs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImageToObject
<公共请求参数>
{
"IsUsedClassify": true,
"Type": 0,
"UserType": 0,
"HandleParam": {
"OcrEngineType": 2,
"IsScale": false,
"ImageOriginalSize": 310006,
"AutoFitDirection": false,
"IsReturnText": false,
"ScaleTargetSize": 300000,
"AutoOptimizeCoordinate": true,
"RotateTheAngle": 0.0
},
"ImageInfoList": [
{
"Url": "",
"Base64": "",
"Id": 1
}
]
}输出示例
{
"Response": {
"RequestId": "c8469f68-defe-4a3d-81ec-9538e39b2483",
"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": " 处方笺 [自费]\neking Union Medical College Hospital\n性别 定点医疗机构编石 处方号 015111835596 [底方]\n 男 年龄50岁 病人ID\n 科别 特需皮肤科门诊1\nR:\t\t\n\t环孢素软胶囊[新山地明]25MG 25MG 50粒/盒X 3盒(50)\t\n用法:每次5粒\t每日两次\t口服\t\n\t\t多烯磷脂酰胆碱胶囊[易善复]228MG 24粒/盒X3盒(24)\t\n用法:每次2粒\t每日三次\t口服\t\n*白凡士林500G 500G/瓶X1瓶\t\t\t\n用法:每次10G\t每日两次\t外用\t\n\n 开单日期\n 2015-11-18 14:39\n 收费日期\n 2015-11-18 14:45\n",
"OcrText": " 处方笺 [自费]\neking Union Medical College Hospital\n性别 定点医疗机构编石 处方号 015111835596 [底方]\n 男 年龄50岁 病人ID\n 科别 特需皮肤科门诊1\nR:\t\t\n\t环孢素软胶囊[新山地明]25MG 25MG 50粒/盒X 3盒(50)\t\n用法:每次5粒\t每日两次\t口服\t\n\t\t多烯磷脂酰胆碱胶囊[易善复]228MG 24粒/盒X3盒(24)\t\n用法:每次2粒\t每日三次\t口服\t\n*白凡士林500G 500G/瓶X1瓶\t\t\t\n用法:每次10G\t每日两次\t外用\t\n\n 开单日期\n 2015-11-18 14:39\n 收费日期\n 2015-11-18 14:45\n",
"Pathology": null,
"PathologyV2": null,
"PatientInfo": {
"Address": "",
"Age": "50岁",
"AgeNorm": "438000小时",
"BedNo": "",
"BirthPlace": "",
"Birthday": "",
"EducationBackground": "",
"Ethnicity": "",
"HealthCardNo": "",
"IdCard": "",
"Married": "",
"MarriedCode": "",
"MedicalInsuranceType": "",
"MedicalInsuranceTypeCode": "",
"Name": "",
"Nation": "",
"Nationality": "",
"Phone": "",
"Profession": "",
"ProfessionCode": "",
"Sex": "男",
"SocialSecurityCardNo": ""
},
"Prescription": {
"MedicineList": [
{
"Category": "",
"DosageUnit": "粒",
"Firm": "",
"MinQuantity": "50",
"Name": "环孢素软胶囊",
"PackingUnit": "盒",
"Specification": "",
"TradeName": ""
},
{
"Category": "",
"DosageUnit": "粒",
"Firm": "",
"MinQuantity": "24",
"Name": "多烯磷脂酰胆碱胶囊",
"PackingUnit": "盒",
"Specification": "",
"TradeName": "易善复"
}
],
"Page": 0
},
"ReportInfo": {
"BedNo": "",
"BillingTime": "",
"CheckItem": "",
"CheckMethod": "",
"CheckNum": "",
"DepartmentName": "特需皮肤科门诊",
"Diagnose": "",
"DiagnoseTime": "",
"HealthCheckupNum": "",
"Hospital": "",
"ImageNum": "",
"InHospitalNum": "",
"InspectTime": "",
"MedicalRecordNum": "",
"OtherTime": "2015-11-18 14:39:00",
"OutpatientNum": "",
"PathologyNum": "",
"PrintTime": "",
"RadiationNum": "",
"ReportName": "处方笺",
"ReportTime": "",
"SampleNum": "",
"SampleType": "",
"TestNum": "",
"Times": [
{
"Name": "其它日期",
"Value": "2015-11-18 14:39:00"
}
],
"UltraNum": ""
},
"ReportType": "prescription",
"ReportTypeDesc": "",
"Surgery": null,
"Timeline": null,
"VaccineCertificate": null
},
"TextTypeList": [
{
"Id": 13,
"Level": 1,
"Name": "医疗文本"
},
{
"Id": 215,
"Level": 2,
"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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.PushUsageMessageError | 用量消息推送失败。 |
| FailedOperation.ServiceNotOpen | 服务未开通。 |
| FailedOperation.UnknownError | 未知错误。 |
| InternalError | 内部错误。 |
| InternalError.ImageOcrError | 图片ocr识别异常。 |
| InternalError.ImageProcessError | 图片处理异常。 |
| InternalError.ServerTimeOutError | 服务调用超时。 |
| InternalError.StructionError | 报告结构化异常。 |
| InternalError.TextClassifyError | 报告文本分类异常。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.AutoFitDirection | 参数AutoFitDirection无效。 |
| InvalidParameter.ImageInfoList | 参数ImageInfoList无效。 |
| InvalidParameter.ImageOriginalSize | 参数ImageOriginalSize无效。 |
| InvalidParameter.InvalidAction | 请求Action无效。 |
| InvalidParameter.OcrEngineType | 参数OcrEngineType无效。 |
| InvalidParameter.RotateTheAngle | 参数RotateTheAngle无效。 |
| InvalidParameter.Text | 参数Text无效。 |
| InvalidParameterValue.ImageCodeInvalid | 图片编码无效。 |
| InvalidParameterValue.ImageIsNoText | 图片没有文字。 |
| InvalidParameterValue.ImageURLInvalid | 图片URL无效。 |
| LimitExceeded.TextSizeLimitExceeded | 文本大小超过限制。 |
| UnauthorizedOperation.PermissionDeniedError | 当前无权限，请检查BisinsessId。 |
| UnsupportedOperation.UnSupportThisType | 当前报告类型不支持。 |
