宠智灵 API 文档

Appearance

获取识别报告说明文档 ​

开发者需要按照如下步骤完成： 生成识别报告成功后，开发者即可调用获取识别报告。默认返回JSON格式的详细报告数据，也可通过参数指定返回HTML格式的报告内容或报告链接。

调用接口： ​

请求方式： GET（HTTPS）
请求地址： https://ms-ai.chongzhiling.com/api/v1.0/ai-b/medical-record?report_id=[MEDICAL_RECORD_ID]&token=[ACCESS_TOKEN]

参数列表： ​

Query 参数 ​

名称类型必填说明
report_idstring是medical_record_id【通过 /session-record/session-start接口获取】
tokenstring是登录凭证
formatstring否返回格式，可选值：json（默认值，返回详细JSON数据）、html（返回HTML内容或链接）
html_typestring否当format=html时生效，可选值：content（返回HTML字符串）或link（返回HTML报告链接）

返回结果： ​

默认或format=json时（返回详细JSON数据） ​

json
{
    "data": {
        "created_at": "xxxx-xx-xxT10:14:41",
        "id": 123,
        "is_paid": 123,
        "module_type": 123,
        "pet_profile_id": 123,
        "report": "{}",
        "report_status": 2,
        "report_time": "xxxx-xx-xxT10:15:04",
        "session_id": "780db10210-21dc-247c4-938d-5928d5fd21a6e",
        "stage": null,
        "status": 2,
        "sub_module_type": "7",
        "summary": "",
        "updated_at": "xxx-xx-xxT10:15:04"
    },
    "message": "Get successfully.",
    "success": true // 返回成功状态
}

当format=html且html_type=content时（返回HTML字符串） ​

json
{
    "data": {
        "created_at": "xxxx-xx-xxT10:14:41",
        "id": 123,
        "is_paid": 123,
        "module_type": 123,
        "pet_profile_id": 123,
        "report": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>宠物耳道检测报告</title><style>body{font-family: Arial, sans-serif; margin: 20px;} .header{background-color: #f0f8ff; padding: 20px; border-radius: 5px; margin-bottom: 20px;} .section{margin-bottom: 30px; padding: 15px; border-left: 4px solid #4CAF50;} h1, h2, h3{color: #333;} ul{line-height: 1.6;}</style></head><body><div class=\"header\"><h1>宠物耳道检测报告</h1><p>报告ID: 123</p><p>生成时间: xxxx-xx-xx 10:14:41</p></div><div class=\"section\"><h2>检测结果</h2><p>经过分析，发现宠物耳道存在轻微红肿和少量褐色分泌物，疑似轻度耳螨感染。</p></div><div class=\"section\"><h2>护理建议</h2><ul><li>定期清洁耳道</li><li>咨询兽医确认治疗方案</li><li>保持耳部干燥</li><li>避免用尖锐物品掏耳朵</li></ul></div></body></html>",
        "report_status": 2,
        "report_time": "xxxx-xx-xxT10:15:04",
        "session_id": "780db10210-21dc-247c4-938d-5928d5fd21a6e",
        "stage": null,
        "status": 2,
        "sub_module_type": "7",
        "summary": "",
        "updated_at": "xxx-xx-xxT10:15:04"
    },
    "message": "Get successfully.",
    "success": true
}

当format=html且html_type=link时（返回HTML报告链接） ​

json
{
    "data": {
        "created_at": "xxxx-xx-xxT10:14:41",
        "id": 123,
        "is_paid": 123,
        "module_type": 123,
        "pet_profile_id": 123,
        "report": "https://ms-ai.chongzhiling.com/report/view/123.html",
        "report_status": 2,
        "report_time": "xxxx-xx-xxT10:15:04",
        "session_id": "780db10210-21dc-247c4-938d-5928d5fd21a6e",
        "stage": null,
        "status": 2,
        "sub_module_type": "7",
        "summary": "",
        "updated_at": "xxx-xx-xxT10:15:04"
    },
    "message": "Get successfully.",
    "success": true
}

返回参数说明： ​

名称类型说明
created_atstring创建时间，格式为 ISO 8601
idnumber唯一标识符，ID
is_paidnumber是否已支付（1：已支付，0：未支付）
module_typenumber模块类型，表示该数据属于哪个模块
pet_profile_idnumber宠物资料ID，当前为 0，表示没有关联宠物
reportobject报告内容，根据format参数返回不同格式的数据
report_statusstring报告状态 0-未生成 1-生成中 2-已完成 3-生成失败
report_timestring报告时间，格式为 ISO 8601
session_idstring会话ID，用于管理会话上下文
stagenull当前阶段，当前为 null
statusnumber状态值，2 表示某个特定状态
sub_module_typestring子模块类型，值为 "7"
summarystring文字总结内容，包含图文信息，报告内容及注意事项
updated_atstring更新时间，格式为 ISO 8601

report 字段说明： ​

字段名类型说明
img_urlstring图片地址，展示耳道检测的原始图像。可用于查看具体的检测对象和分析区域。
sub_module_typenumber子模块类型，值为 7，表示该报告属于耳道检测模块。
recgobject检测识别结果对象，包含图片描述、详细检测报告、风险评估和护理建议等信息。
recg.photostring图片描述信息，如"耳朵图"，表明当前分析的是哪种类型的图像内容。
recg.reportarray报告内容列表，由多个检测项组成，每个检测项包含名称（name）和特征描述（feature）。
recg.report.namestring检测项名称，如"外耳道"、"耳垢"、"耳廓"等，表示耳部的不同部位或观察点。
recg.report.featurestring特征描述，详细说明该检测项的具体情况，包括是否存在异常及可能的问题。
recg.report_riskarray风险评估列表，用于列出可能存在健康问题的风险项。
recg.report_risk.namestring风险项名称，如"外耳道炎"、"耳螨"、"耳廓湿疹"等，表示宠物可能存在的疾病风险。
recg.report_risk.riskstring风险等级，"1" 表示高风险，需要引起注意；"0" 表示低风险，当前未见明显问题。
recg.report_risk.causestring诊断依据，仅在 "name": "诊断依据" 的情况下出现，说明综合判断得出的结论原因。
recg.suggestobject建议内容对象，提供护理方案、具体建议和总结性指导。
recg.suggest.contentstring护理方案标题，如"🐶 炎症护理方案"，表明建议的主题方向。
recg.suggest.descriptionstring护理方案描述，解释当前耳部状况及处理建议。
recg.suggest.optionsarray具体护理建议选项列表，每个条目包含标题（title）和描述（description）。
recg.suggest.options.titlestring建议标题，如"💧 清洁耳道"、"💊 局部用药"、"⚠️ 注意事项"等，明确建议的操作方向。
recg.suggest.options.descriptionstring建议描述，详细说明操作方法和注意事项。
recg.suggest.summarystring总结性建议，简要概括整体护理流程和应对措施，便于快速理解主要操作。

使用说明 ​

返回详细JSON数据（默认方式） ​

当format参数未指定或设置为json时，接口将返回完整的JSON格式报告数据，包含所有详细信息。

返回HTML字符串 ​

当format参数设置为html且html_type参数设置为content时，接口将直接返回完整的HTML格式报告内容。客户端可以直接将该内容渲染到网页中展示。

返回报告链接 ​

当format参数设置为html且html_type参数设置为link时，接口将返回一个可访问的HTML报告链接。客户端可以引导用户在浏览器中打开该链接查看报告。

注意事项 ​

  1. 默认行为：接口默认返回详细JSON数据，保持与原有接口的兼容性。
  2. 格式选择：通过format和html_type参数组合可以灵活选择返回格式。
  3. 安全性：通过链接方式访问报告时，链接中包含了访问令牌以确保安全性。
  4. 报告内容：完整的识别报告内容包括检测结果和相关护理建议，供用户参考。
  5. 报告保存：用户可以保存或分享报告，以便后续查阅。

接口调试： ​