/ocr/medical/v2/medical_classify
1.接口描述
该 API 用于对医疗票据类图片进行分类,目前支持类型:住院发票、门诊发票、住院电子发票、门诊电子发票、结算单(分割单)、费用清单、出院小结、入院记录、门诊病历、增值税发票、身份证、银行卡。
- 图片要求:
- 格式为 JPG(JPEG), PNG
- 宽和高大于 128px, 小于等于 6000px
- 小于等于 5 MB
请求方式
POST
请求 URL
https://cloudapi.deepfinch.com/ocr/medical/v2/medical_classify
调试工具
2.请求参数
2.1 请求头域
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API调用凭证信息,详细信息请参考API调用 |
| X-DF-API-SECRET | string | 是 | API调用凭证信息,详细信息请参考API调用 |
2.2 请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| file | file | 见下方注释 | 需上传的图片文件,上传本地图片进行检测时选取此参数 |
| url | string | 见下方注释 | 图片网络地址,采用抓取网络图片方式时需选取此参数 |
请求参数
file与url二选一。
url 中若含有特殊字符,则需要对这些字符进行转义,所有中文和特殊字符必需以UTF-8编码转义。
目前支持 http/https 协议的网络地址。下载限时 5s,超时后仍未下载完成则属于失败。
参数file需把图片文件以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
| 字段 | 类型 | 说明 |
|---|---|---|
| request_id | string | 本次请求的id |
| status | string | 状态,正常为 OK |
| result | object | 分类结果 |
result字段
| 字段 | 类型 | 说明 |
|---|---|---|
| degree | int | 图片旋转角度 |
| classification | string | 单证类型 |
| province | string | 所属省份(当票据是医疗发票或电子发票时返回此字段) |
| invoice_type | string | 1-门诊发票 2-住院发票(当票据是医疗发票或电子发票时返回此字段) |
classification字段票据类型取值:
invoice: 发票
e-invoice: 电子发票
vat-invoice: 增值税
settlement: 结算单(分割单)
detail: 明细清单
discharge_report: 出院小结
admission_note: 入院记录
case_history: 门诊病例
idcard: 身份证
bankcard: 银行卡
unknown: 其他
province字段所属省份取值:
| 省份 | 输出值 |
|---|---|
| 其他 | 00 |
| 北京市(含中央) | 01 |
| 上海市 | 02 |
| 浙江省 | 03 |
| 天津市 | 04 |
| 山东省 | 05 |
| 河南省 | 06 |
| 广东省 | 07 |
| 江苏省 | 08 |
| 河北省 | 09 |
| 山西省 | 10 |
| 内蒙古 | 11 |
| 辽宁省 | 12 |
| 吉林省 | 13 |
| 黑龙江省 | 14 |
| 安徽省 | 15 |
| 福建省 | 16 |
| 江西省 | 17 |
| 湖北省 | 18 |
| 湖南省 | 19 |
| 广西 | 20 |
| 海南省 | 21 |
| 重庆市 | 22 |
| 四川省 | 23 |
| 贵州省 | 24 |
| 云南省 | 25 |
| 陕西省 | 26 |
| 甘肃省 | 27 |
| 宁夏 | 28 |
| 新疆 | 29 |
| 青海 | 30 |
| 西藏 | 31 |
| 解放军(含武警) | 32 |
返回结果示例
{
"request_id": "TIDc6500243286b4761be83493edc93729b",
"status": "OK",
"result": {
"degree": 0,
"classification": "detail"
}
}
4.错误码
| 状态码 | status 字段 |
说明 |
|---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
DETETION_FAILED | 图片检测失败 |
400 |
DOWNLOAD_ERROR | 网络地址图片获取失败 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
401 |
KEY_EXPIRED | 账号过期 |
403 |
NO_PERMISSION | 无调用权限 |
403 |
OUT_OF_QUOTA | 调用次数超出限额 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
备注: 以上40X系列错误描述请参考reason字段
输出样例
{
"status": "INVALID_ARGUMENT",
"reason": "must specify 'file' or 'url' argument",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}