/ocr/dimission_report
1.接口描述
该API是用于识别提取离职证明上的文字信息。
请求方式:
POST
请求URL:
https://cloudapi.deepfinch.com/ocr/dimission_report
调试工具
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 | 姓名 |
id | object | 证件号码 |
date | object | 盖章日期 |
company | object | 工作单位 |
in_date | object | 入职日期 |
out_date | object | 离职日期 |
job | object | 职务岗位 |
3.1.1 各字段的参数:
字段 | 类型 | 说明 |
---|---|---|
value | string | 提取文本 |
region | floatArray | 文本坐标 |
输出示例:
{
"status": "OK",
"request_id": "TIDe18d982690ee441dbf4af7162f8973e6",
"result": {
"company": {
"region": [
376.61,
423.88,
795.23,
423.88,
795.23,
447.56,
376.61,
447.56
],
"value": "XXXXXXXXXXX"
},
"date": {
"region": [
570.64,
526.22,
728.77,
526.22,
728.77,
548.37,
570.64,
548.37
],
"value": "2024-05-20"
},
"id": {
"region": [
327.72,
200.87,
491.96,
200.87,
491.96,
219.96,
327.72,
219.96
],
"value": "XXXXXXX"
},
"in_date": {
"region": [
518.7,
197.81,
755.51,
197.81,
755.51,
220.72,
518.7,
220.72
],
"value": "2022-09-19"
},
"job": {
"region": null,
"value": ""
},
"name": {
"region": [
241.4,
200.87,
310.91,
200.87,
310.91,
222.25,
241.4,
222.25
],
"value": "XXXXXXX"
},
"out_date": {
"region": [
518.7,
197.81,
755.51,
197.81,
755.51,
220.72,
518.7,
220.72
],
"value": "2024-05-20"
}
}
}
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"
}