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 | 报告结构化结果 示例值:{ "BirthCert": null, "C14": null, "Check": null, "Covid": null, "DiagCert": null, "Electrocardiogram": null, "Endoscopy": null, "Exame": null, "Eye": null, "FirstPage": null, "Hospitalization": { "AdmissionCondition": "", "AdmissionDays": "", "AdmissionDiagnosis": "", "AdmissionDignosis": "", "AdmissionTime": "0000-00-00 00:00:00", "DiagnosisTreatment": "", "DischargeDiagnosis": "", "DischargeInstruction": "", "DischargeTime": "", "Page": 0 }, "Indicator": null, "IndicatorV3": null, "Maternity": null, "MedDoc": { "Advice": { "Text": "" }, "Diagnosis": null, "DiseaseMedicalHistory": { "AllergyHistory": "否认药物过敏,否认食物过敏", "InfectHistory": "否认疟疾,否认肝炎,否认结核", "MainDiseaseHistory": "既往史:平素健康状况良好。疾病史:否认肝炎、结核、疟疾病史,否认心血管病史,否认糖尿病、脑血管疾病、精神病史,否认手术、外伤、输血史,否认食物、药物过敏史,预防接种史不详。", "OperationHistory": "", "TransfusionHistory": "否认" }, "FamilyMedicalHistory": { "GeneticHistory": "", "RelativeCancerHistory": "", "RelativeHistory": "父亲因心梗去世,母亲健在" }, "MenstrualMedicalHistory": { "LastMenstrualPeriod": "", "MenarcheAge": "", "MenstrualCycles": "", "MenstrualFlow": "", "MenstrualPeriod": "", "MenstruationOrNot": "" }, "ObstericalMedicalHistory": { "FertilityHistory": "育有1女,已育", "MarriageHistory": "已婚" }, "Page": 0, "PersonalMedicalHistory": { "AlcoholicHistory": "无饮酒史", "BirthPlace": "黑龙江省大庆市2让胡路区", "Job": "退(离)休人员", "LivePlace": "", "SmokeHistory": "无吸烟" }, "TreatmentRecord": { "AdmissionCondition": "", "AuxiliaryExamination": "", "BodyExamination": "", "CheckAndTreatmentProcess": "", "CheckRecord": "", "ChiefComplaint": "主诉:降结肠癌术后3周,突发腹痛2天。", "ConditionChanges": "", "DeathDate": "", "DischargeCondition": "", "DiseasePresent": "", "DmissionCondition": "", "ECOG": "", "FollowUpRequirements": "", "IncisionHealing": "", "InspectResult": "", "KPS": "", "MentalExamination": "", "NRS": "", "ObservationDays": "", "PTNM": "", "PTNMM": "", "PTNMN": "", "PTNMT": "", "RelapseDate": "", "SpecialistExamination": "", "SurgeryCondition": "", "SymptomsAndSigns": "", "TreatmentSuggestion": "" } }, "MedDocV2": null, "MedicalRecordInfo": null, "OcrResult": " 市立医院\n 入 院记录\n 病案号:\n 姓名: 1\n 出生地:\n 姓名: 黑龙江省大庆市 2让胡路区\n 性别:\n 男 职业:\n 退(离)休人员\n 2021-02-14 12:32\n 71岁 入院日期:\n 年龄:\n 记录日期:\n 民族: 2021-02-15 00:48\n 汉族\n 患者本人及家属\n 已婚 病史陈述者:\n 婚姻:\n 主诉:\n 降结肠癌术后3周,突发腹痛2天。\n 患者3周前因降结肠癌并梗阻在威海市立三院于2021-01-28行降结肠部分切\n 现病史:\n除+肠粘连松解+阑尾切除术+盲肠造瘘术手术,手术顺利。术后病理未见。患者术后逐步过渡饮\n食,未见明显不适。2天前因进食鸡汤、骨头汤后出现腹痛,为右上腹持续性绞痛,程度剧\n烈,无他处放射痛。感恶心,未呕吐,无畏寒发热、胸闷喘憋、头晕头痛等不适。给予低脂流质\n饮食,抗炎、抑酸、抑制消化液分泌、补液等对症治疗,未见明显好转。完善腹部CT提示:胆囊\n炎可能,局部肠梗阻可能。患者遂要求至我院进一步治疗。就诊于我院急诊科,请我科会诊后以\n 急性肠梗阻、胆囊炎收入院。患者自发病后,饮食、睡眠差,尿量及造口排便排气减少,体\n 重无明显变化。\n 既往史:\n 平素健康状况良好。\n 疾\n 病史:否认肝炎、结核、疟疾病史,否认心血管病史,否认\n 糖尿病、脑血管疾病、精神病史,否认手术、外伤、输血史,否认食物、药物过敏史,预防接种\n 史不详。\n 个人史:生于黑龙江省大庆市让胡路区,久居本地,否认14天内有国内外高、中风险地\n 区旅游史或居住史,否认接触来自国内外高、中风险地区的发热伴有呼吸道症状的患者。否认威\n 海本地疑似或确诊冠状病毒肺炎患者接触史,无牧区、矿山、高氟区、低碘区居住史,无化学性\n 物质、放射性物质、有毒物质接触史,无长期药物服用成瘾史,无吸毒史,无吸烟、饮酒史,无\n 冶游史。\n 婚姻史:\n 结婚45年,育有1女,配偶及女体健。\n 家族史:\n 父亲因心梗去世,母亲健在。兄弟姐妹4人,均健在。否认家族性遗传病、传\n 染病病史。\n 以上病史记录属实。 万元整 22年2月1日\n 患者/家属签字: 签署日期:\n 体格检查\n T 36.2℃ P74次/分 R 19次/分 Bp 122/74mmHg\n 发育正常,营养中等,自主体位,神志清楚,精神尚可,步态正常,语言清晰,查体合作。\n 全身皮肤粘膜无黄染,无皮疹、皮下出血、皮下结节,皮下无水肿,无肝掌、蜘蛛痣。全身浅表\n 淋巴结未触及肿大。头颅无畸形、压痛、包块,毛发分布均匀。眼睑无水肿,结膜无充血、无苍\n 白,眼球无震颤,巩膜无黄染,瞳孔等大同圆,对光调节反射灵敏。外耳道无异常分泌物,乳突\n 无压痛,听力无异常。鼻无畸形,通气良好,鼻翼无扇动,鼻窦区无压痛。口唇无发绀,口腔粘\n 膜无溃疡。伸舌无偏斜、震颤,齿龈无肿胀、无出血。咽部粘膜无充血,扁桃体无肿大。颈软,\n 颈动脉搏动无增强、减弱,颈静脉无怒张,气管居中,肝颈静脉回流征阴性,甲状腺未及肿大,\n 无压痛、包块、血管杂音。胸廓对称、无畸形,胸骨无叩痛。呼吸运动无增强、减弱,肋间隙无\n 增宽、变窄,呼吸规整,语颤无增强及减弱,无胸膜摩擦感,双肺呼吸音清,未闻及干湿性吗\n 音、胸膜摩擦音。心前区无隆起,心尖搏动无弥散,无震颤及心包摩擦感,心浊音界无扩大,心\n 第1页\n", "OcrText": " 市立医院\n 入 院记录\n 病案号:\n 姓名: 1\n 出生地:\n 姓名: 黑龙江省大庆市 2让胡路区\n 性别:\n 男 职业:\n 退(离)休人员\n 2021-02-14 12:32\n 71岁 入院日期:\n 年龄:\n 记录日期:\n 民族: 2021-02-15 00:48\n 汉族\n 患者本人及家属\n 已婚 病史陈述者:\n 婚姻:\n 主诉:\n 降结肠癌术后3周,突发腹痛2天。\n 患者3周前因降结肠癌并梗阻在威海市立三院于2021-01-28行降结肠部分切\n 现病史:\n除+肠粘连松解+阑尾切除术+盲肠造瘘术手术,手术顺利。术后病理未见。患者术后逐步过渡饮\n食,未见明显不适。2天前因进食鸡汤、骨头汤后出现腹痛,为右上腹持续性绞痛,程度剧\n烈,无他处放射痛。感恶心,未呕吐,无畏寒发热、胸闷喘憋、头晕头痛等不适。给予低脂流质\n饮食,抗炎、抑酸、抑制消化液分泌、补液等对症治疗,未见明显好转。完善腹部CT提示:胆囊\n炎可能,局部肠梗阻可能。患者遂要求至我院进一步治疗。就诊于我院急诊科,请我科会诊后以\n 急性肠梗阻、胆囊炎收入院。患者自发病后,饮食、睡眠差,尿量及造口排便排气减少,体\n 重无明显变化。\n 既往史:\n 平素健康状况良好。\n 疾\n 病史:否认肝炎、结核、疟疾病史,否认心血管病史,否认\n 糖尿病、脑血管疾病、精神病史,否认手术、外伤、输血史,否认食物、药物过敏史,预防接种\n 史不详。\n 个人史:生于黑龙江省大庆市让胡路区,久居本地,否认14天内有国内外高、中风险地\n 区旅游史或居住史,否认接触来自国内外高、中风险地区的发热伴有呼吸道症状的患者。否认威\n 海本地疑似或确诊冠状病毒肺炎患者接触史,无牧区、矿山、高氟区、低碘区居住史,无化学性\n 物质、放射性物质、有毒物质接触史,无长期药物服用成瘾史,无吸毒史,无吸烟、饮酒史,无\n 冶游史。\n 婚姻史:\n 结婚45年,育有1女,配偶及女体健。\n 家族史:\n 父亲因心梗去世,母亲健在。兄弟姐妹4人,均健在。否认家族性遗传病、传\n 染病病史。\n 以上病史记录属实。 万元整 22年2月1日\n 患者/家属签字: 签署日期:\n 体格检查\n T 36.2℃ P74次/分 R 19次/分 Bp 122/74mmHg\n 发育正常,营养中等,自主体位,神志清楚,精神尚可,步态正常,语言清晰,查体合作。\n 全身皮肤粘膜无黄染,无皮疹、皮下出血、皮下结节,皮下无水肿,无肝掌、蜘蛛痣。全身浅表\n 淋巴结未触及肿大。头颅无畸形、压痛、包块,毛发分布均匀。眼睑无水肿,结膜无充血、无苍\n 白,眼球无震颤,巩膜无黄染,瞳孔等大同圆,对光调节反射灵敏。外耳道无异常分泌物,乳突\n 无压痛,听力无异常。鼻无畸形,通气良好,鼻翼无扇动,鼻窦区无压痛。口唇无发绀,口腔粘\n 膜无溃疡。伸舌无偏斜、震颤,齿龈无肿胀、无出血。咽部粘膜无充血,扁桃体无肿大。颈软,\n 颈动脉搏动无增强、减弱,颈静脉无怒张,气管居中,肝颈静脉回流征阴性,甲状腺未及肿大,\n 无压痛、包块、血管杂音。胸廓对称、无畸形,胸骨无叩痛。呼吸运动无增强、减弱,肋间隙无\n 增宽、变窄,呼吸规整,语颤无增强及减弱,无胸膜摩擦感,双肺呼吸音清,未闻及干湿性吗\n 音、胸膜摩擦音。心前区无隆起,心尖搏动无弥散,无震颤及心包摩擦感,心浊音界无扩大,心\n 第1页\n", "Pathology": null, "PathologyV2": null, "PatientInfo": { "Address": "", "Age": "71岁", "AgeNorm": "621960小时", "BedNo": "", "BirthPlace": "", "Birthday": "", "EducationBackground": "", "Ethnicity": "汉族", "HealthCardNo": "", "IdCard": "", "Married": "已婚", "MarriedCode": "20", "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": [ { "Name": "记录日期", "Value": "2021-02-15 00:48:00" }, { "Name": "入院日期", "Value": "2021-02-14 12:32:00" } ], "UltraNum": "" }, "ReportType": "admission", "ReportTypeDesc": "", "Surgery": null, "Timeline": { "Page": 0, "Timeline": [ { "EndTime": "", "Place": "", "Rectangle": null, "Src": "突发腹痛", "SubType": "", "Time": "2021-02-14 12:32:00", "Type": "病变", "Value": "突发腹痛" }, { "EndTime": "", "Place": "", "Rectangle": { "H": 30, "W": 817, "X": 590, "Y": 198 }, "Src": "降结肠癌术后3周,突发腹痛2天", "SubType": "", "Time": "2021-02-14 12:32:00", "Type": "主诉", "Value": "降结肠癌术后3周,突发腹痛2天" }, { "EndTime": "", "Place": "", "Rectangle": null, "Src": "出现腹痛", "SubType": "", "Time": "2021-02-14 12:32:00", "Type": "病变", "Value": "出现腹痛" }, { "EndTime": "", "Place": "", "Rectangle": null, "Src": "降结肠癌术后", "SubType": "手术", "Time": "2021-01-24 00:00:00", "Type": "治疗", "Value": "降结肠癌术后" }, { "EndTime": "", "Place": "", "Rectangle": null, "Src": "降结肠癌并梗阻", "SubType": "", "Time": "2021-01-24 00:00:00", "Type": "病变", "Value": "降结肠癌并梗阻" }, { "EndTime": "", "Place": "", "Rectangle": null, "Src": "降结肠部分切除+肠粘连松解+阑尾切除术+盲肠造瘘术", "SubType": "", "Time": "", "Type": "治疗", "Value": "降结肠部分切除+肠粘连松解+阑尾切除术+盲肠造瘘术" }, { "EndTime": "", "Place": "", "Rectangle": null, "Src": "低脂流质饮食,抗炎、抑酸、抑制消化液分泌、补液等对症", "SubType": "", "Time": "", "Type": "治疗", "Value": "低脂流质饮食,抗炎、抑酸、抑制消化液分泌、补液等对症" } ] }, "VaccineCertificate": null } |
TextTypeList | Array of TextType | 多级分类结果 示例值:[ { "Id": 13, "Level": 1, "Name": "医疗文本" }, { "Id": 29, "Level": 2, "Name": "入院报告" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 图片结构化
输入一张图片,得到结构化结果
输入示例
输出示例
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 | 当前报告类型不支持。 |