/ocr/graduation_certificate
1.接口描述
该API是用于识别提取毕业证书上的文字信息。
请求方式:
POST
请求URL:
https://cloudapi.deepfinch.com/ocr/graduation_certificate
调试工具
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 | 识别结果 |
3.1 result 字段的参数
字段 | 类型 | 说明 |
---|---|---|
name | object | 姓名 |
school | object | 学校 |
major | object | 专业 |
xuexiqijian | object | 大学期间 |
end_date | object | 盖章日期 |
book_id | object | 证书编号 |
xuezhi | object | 学制 |
born_date | object | 出生日期 |
sex | object | 性别 |
3.1.1 各字段的参数:
字段 | 类型 | 说明 |
---|---|---|
value | string | 提取文本 |
region | floatArray | 文本坐标 |
输出示例:
{
"status": "OK",
"request_id": "TIDcaf52a480cb04c0784d637bfed407b4b",
"result": {
"book_id": {
"region": [
60.48,
610.06,
167.58,
610.06,
167.58,
636.53,
60.48,
636.53
],
"value": "110495201905000387"
},
"born_date": {
"region": [
109.62,
267.22,
971.46,
267.22,
971.46,
296.21,
109.62,
296.21
],
"value": "1990-03-19"
},
"end_date": {
"region": [
699.3,
611.32,
957.6,
611.32,
957.6,
641.57,
699.3,
641.57
],
"value": "2019-07-10"
},
"major": {
"region": [
601.02,
321.42,
695.52,
321.42,
695.52,
347.89,
601.02,
347.89
],
"value": "物流管理"
},
"name": {
"region": [
109.62,
267.22,
971.46,
267.22,
971.46,
296.21,
109.62,
296.21
],
"value": "周春明"
},
"school": {
"region": [
279.72,
491.58,
504.0,
491.58,
504.0,
533.17,
279.72,
533.17
],
"value": "淮明工公院"
},
"sex": {
"region": [
109.62,
267.22,
971.46,
267.22,
971.46,
296.21,
109.62,
296.21
],
"value": "男"
},
"xuexiqijian": {
"region": null,
"value": ""
},
"xuezhi": {
"region": null,
"value": ""
}
}
}
4.错误码
状态码 | status 字段 |
说明 |
---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
DETECTION_FAILED | 图片检测失败 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
输出示例:
{
"status": "INVALID_ARGUMENT",
"reason": "must specify 'file'",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}