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 | 图片处理参数 示例值：{ "OcrEngineType": 4 } |
| ImageInfoList.N | 否 | Array of ImageInfo | 图片列表，目前只支持传入一张图片，需要是图片base64编码，图片url暂不支持 示例值：[ { "Base64": "<图片文件的base64编码>" } ] |
| 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 | 报告结构化结果 |
| TextTypeList | Array of TextType | 多级分类结果 示例值：[ { "Id": 13, "Level": 1, "Name": "医疗文本" }, { "Id": 29, "Level": 2, "Name": "入院报告" } ] |
| 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": [
{
"Base64": "注意替换为医疗报告图片base64编码",
"Id": 1
}
]
}输出示例
{
"Response": {
"RequestId": "2835bab6-1992-4377-bab4-88e1a8a7adfb",
"Template": {
"Indicator": {
"Indicators": [
{
"Code": "HBA",
"Id": 911,
"ItemString": "血红蛋白A",
"Name": "血红蛋白A",
"Normal": true,
"Range": ">94.5",
"Scode": "HbA",
"Sname": "血红蛋白A",
"Unit": "%"
},
{
"Code": "HBF",
"Id": 912,
"ItemString": "血红蛋白F",
"Name": "血红蛋白F",
"Normal": true,
"Range": "<2.3",
"Scode": "HBF",
"Sname": "抗碱性血红蛋白",
"Unit": "%"
},
{
"Code": "HBA2",
"Id": 910,
"ItemString": "血红蛋白A2",
"Name": "血红蛋白A2",
"Normal": true,
"Range": "2.5--3.5",
"Scode": "HbA2",
"Sname": "血红蛋白A2",
"Unit": "%"
},
{
"Code": "HBH",
"ItemString": "血红蛋白H",
"Name": "血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBART'S",
"ItemString": "血红蛋白Bart's",
"Name": "血红蛋白Bart's?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBJ",
"ItemString": "血红蛋白J",
"Name": "血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBC-S",
"ItemString": "血红蛋白C-S",
"Name": "RBC血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBE",
"ItemString": "血红蛋白E",
"Name": "血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBS",
"ItemString": "血红蛋白S",
"Name": "血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBD",
"ItemString": "血红蛋白D",
"Name": "血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBG",
"ItemString": "血红蛋白G",
"Name": "血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBK",
"ItemString": "血红蛋白K",
"Name": "血红蛋白?",
"Normal": true,
"Unit": "%"
},
{
"Code": "HBOTHERS",
"ItemString": "其他异常血红蛋白。",
"Name": "其他异常血红蛋白。?",
"Normal": true,
"Unit": "%"
}
]
},
"OcrResult": " ..l2c\n 效有日当票\n H91 90\n WJ^((9\n M4ohCt\n代号\t项目名称\t结果\t单位\t参考值\t\nHbA\t血红蛋白A\t96.31\t%\t>94.5\t\nHbF\t血红蛋白F\t1.05\t%\t<2.3\t\nHbA2\t血红蛋白A2\t2.64\t%\t2.5~3.5\t\nHbH\t血红蛋白H\t未检出\t%\t\t\nHbarts\t血红蛋白Barts\t未检出\t%\t\t\nHbJ\t血红蛋白J\t未检出\t%\t\t\nHbC-S\t血红蛋白C-S\t未检出\t%\t\t\nHbE\t血红蛋白E\t未检出\t%\t\t\nHbS\t血红蛋白S\t未检出\t%\t\t\nHbD\t血红蛋白D\t未检出\t%\t\t\nHbG\t血红蛋白G\t未检出\t%\t\t\nHbK\t血红蛋白K\t未检出\t%\t\t\nHbothers\t其他异常血红蛋白。\t未检出\t%\t\t\n\n wos ro\n 0自\n 的屏示\n 门诊 xxx院检验报告单 86-1\n 全自动毛细管电泳仪-38\n 姓名: 张三 科室:产科 全血\n 性别: 男 床号: 标本类型: 标本状态: y\n 年龄: 条码号: xxxx12582 检验备注:\n 33岁 病历号:。 临床诊断: B楼四\n 15328022 体检\n 产\n 大勺\n 2021-10-31 09:41:00 查蝉响\n 申请医师:xxx 采集时间: 检验者: xxx 审核者:\n 报告时间:\n 2021-10-31 10:59:32 2021-11-05 11:05:17\n接收时间: 第1页.共1页\n※本次实验报告仅对本次标本负责。项目前*号标记为广西医院互认项目。※\n",
"OcrText": " ..l2c\n 效有日当票\n H91 90\n WJ^((9\n M4ohCt\n代号\t项目名称\t结果\t单位\t参考值\t\nHbA\t血红蛋白A\t96.31\t%\t>94.5\t\nHbF\t血红蛋白F\t1.05\t%\t<2.3\t\nHbA2\t血红蛋白A2\t2.64\t%\t2.5~3.5\t\nHbH\t血红蛋白H\t未检出\t%\t\t\nHbarts\t血红蛋白Barts\t未检出\t%\t\t\nHbJ\t血红蛋白J\t未检出\t%\t\t\nHbC-S\t血红蛋白C-S\t未检出\t%\t\t\nHbE\t血红蛋白E\t未检出\t%\t\t\nHbS\t血红蛋白S\t未检出\t%\t\t\nHbD\t血红蛋白D\t未检出\t%\t\t\nHbG\t血红蛋白G\t未检出\t%\t\t\nHbK\t血红蛋白K\t未检出\t%\t\t\nHbothers\t其他异常血红蛋白。\t未检出\t%\t\t\n\n wos ro\n 0自\n 的屏示\n 门诊 xxx医院检验报告单 86-1\n 全自动毛细管电泳仪-38\n 姓名: 张三 科室:产科 全血\n 性别: 男 床号: 标本类型: 标本状态: y\n 年龄: 条码号: xxx12582 检验备注:\n 33岁 病历号:。 临床诊断: B楼四\n 15328022 体检\n 产\n 大勺\n 2021-10-31 09:41:00 查蝉响\n 申请医师:xxx 采集时间: 检验者: xxx 审核者:\n 报告时间:\n 2021-10-31 10:59:32 2021-11-05 11:05:17\n接收时间: 第1页.共1页\n※本次实验报告仅对本次标本负责。项目前*号标记为广西医院互认项目。※\n",
"PatientInfo": {
"Age": "33岁",
"AgeNorm": "289080小时",
"BedNo": "xxx82",
"Name": "张三",
"Sex": "男"
},
"ReportInfo": {
"BedNo": "xxx582",
"DepartmentName": "体检",
"Hospital": "xxx医院",
"MedicalRecordNum": "15328022",
"ReportName": "检验报告单",
"ReportTime": "2023-11-05 11:05:17",
"Times": [
{
"Name": "报告日期",
"Value": "2023-11-05 11:05:17"
},
{
"Name": "接收日期",
"Value": "2023-10-31 10:59:32"
},
{
"Name": "采集日期",
"Value": "2023-10-31 09:41:00"
}
]
},
"ReportType": "indicator"
},
"TextTypeList": [
{
"Id": 11,
"Level": 1,
"Name": "检验报告"
},
{
"Id": 24,
"Level": 2,
"Name": "一般检验"
},
{
"Id": 316,
"Level": 3,
"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 | 当前报告类型不支持。 |
