有奖捉虫:云通信与企业服务文档专题,速来> HOT
注意:

  • 通用印刷体识别接口全面升级,算法更强、性能更优,支持子账号调用。欢迎立即体验 新版通用印刷体识别
  • 新老版本的接口计费模式相同,且共享计费阶梯和资源包,您可以在【文字识别控制台】>【用量统计】中查看调用情况。
  • 老版本接口我们仍继续维护,但不支持新客户开通调用,建议您使用 新版通用印刷体识别,体验更优服务。

接口描述

接口请求域名:https://recognition.image.myqcloud.com/ocr/general
本接口(general)用于提供图片整体文字的检测和识别服务,返回文字框位置与文字内容。支持多场景、任意版面下整图文字的识别,以及中英文、字母、数字的识别。应用场景:印刷文档识别、广告图文字识别、街景店招识别、菜单识别、视频标题识别、互联网头像文字识别等。

说明:

本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。

请求头 header

所有请求都要求含有以下头部信息:

参数名 必选 描述
host recognition.image.myqcloud.com 腾讯云文字识别服务器域名。
content-length 包体总长度 每个请求的包体大小限制为6MB,不支持 .gif 类型的动图。
content-type application/json 或者 multipart/form-data 根据不同接口选择:
1. 使用 application/json 格式,参数 url 或 image,其值为图片链接或图片 base64 编码。
2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。
authorization 鉴权签名 多次有效签名,用于鉴权,生成方式见 鉴权签名方法
注意:

如选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setheader 等方法设置,否则可能导致 boundary 缺失引起请求失败。

输入参数

参数名 必选 类型 参数说明
appid String 接入项目的唯一标识,可在 账号信息云 API 密钥 中查看。
image Binary/String 图片文件或图片 base64。
url String 图片 url 和 image 同时赋值时,则以 url 指定的图像作为输入。

输出参数

字段 类型 说明
data.session_id String 相应请求的 session 标识符
data.items Array(item) 识别出的所有字段信息
code Int 错误码
message String 错误描述

item 说明:

字段 类型 说明
itemstring String 字段内容
itemcoord x Int item 框左上角 x
y Int item 框左上角 y
width Int item 框宽度
height Int item 框高度
words Array(word) 每个字的信息

words 说明:

字段 类型 说明
character String 单字的内容
confidence Float 这个字的置信度,取值范围 [0,100]

示例

输入示例

使用 application/json

POST /ocr/general HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 187
Content-Type: application/json
{
"appid":"123456",
"url":"http://test-123456.image.myqcloud.com/test.jpg"
}

使用 multipart/form-data

POST /ocr/general HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 735
Content-Type: multipart/form-data;boundary=--------------acebdf13572468
----------------acebdf13572468
Content-Disposition: form-data; name="appid";
123456
----------------acebdf13572468
Content-Disposition: form-data; name="bucket";
test
----------------acebdf13572468
Content-Disposition: form-data; name="image"; filename="test.jpg"
Content-Type: image/jpeg
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
----------------acebdf13572468--

输出示例

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 404
Content-Type: application/json
{
 "data":{
"items":[
 {
   "itemstring":"手机",
   "itemcoord":{"x":0,"y":100,"width":40,"height":20},
   "words":[
     {"character":"手","confidence":90.9},
     {"character":"机","confidence":93.9}
   ]
 }
],
   "session_id":"",
 },
 "code":0,
 "message":"OK"
}

错误码

错误码 含义
3 错误的请求;其中 message:account abnormal,errorno is:2为账号欠费停服
4 签名为空
5 签名串错误
6 签名中的 APPID/Bucket 与操作目标不匹配
9 签名过期
10 APPID 不存在
11 SecretId 不存在
12 APPID 和 SecretId 不匹配
13 重放攻击
14 签名校验失败
15 操作太频繁,触发频控
16 Bucket不存在
21 无效参数
23 请求包体过大
24 没有权限
25 您购买的资源已用完
107 鉴权服务内部错误
108 鉴权服务不可用
213 内部错误
-1102 图片解码失败
-1300 图片为空
-1301 参数为空
-1304 参数过长
-1308 图片下载失败
-9021 未检测到文本
-9003 OCR 识别失败

更多其他 API 错误码请查看 错误码说明