/ocr/general

1.接口描述

2.请求参数.

3.返回参数.

4.错误码.

5.输入示例

1.接口描述

该 API 用于识别图片中的文字

图片要求：
1. 格式为 JPG（JPEG），PNG
2. 宽和高大于 128px，小于等于 6000px
3. 小于等于 5 MB

请求方式

POST

请求 URL

http://cloudapi.deepfinch.com/ocr/general

调试工具

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 中含有不少特殊字符，若将 URL 放入 Query String 中则需要对这些字符进行转义，所有中文和特殊字符必需以UTF-8编码转义。
目前支持 http/https 等协议的网络地址。下载限时 5s，超时后仍未下载完成则属于失败。
参数 file 需把图片文件的内容以 multipart/form-data 的形式放到 POST 消息体中。

3.返回参数

字段	类型	说明
request_id	string	本次请求的id
status	string	状态，正常为 `OK`
words_count	int	检测到的words数目
words	string	words详细信息

返回结果示例

{
    "request_id": "TIDb669eaf3435741a68ddd56cd2f5dc4e6",
    "status": "OK",
    "words": [
      "这是一段文本",
      "另一段文本"
    ],
    "words_count": 2
}

4.错误码

状态码	`status` 字段	说明
`400`	INVALID_ARGUMENT	请求参数错误
`400`	DETECTION_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"
}

5.输入示例

results matching ""

No results matching ""