手写文字识别(Handwriting words Recognition)基于深度神经网络模型的端到端文字识别系统,将图片(来源如扫描仪或数码相机)中的手写字体转化为计算机可编码的文字,支持中英文。
该能力是通过HTTP API的方式给开发者提供一个通用的接口,适用于一次性交互数据传输的AI服务场景,块式传输。相较于SDK,API具有轻量、跨语言的特点,不过请注意该接口使用的HTTP API协议不支持跨域。
示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo,其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。
集成手写文字识别API时,需按照以下要求。
内容 | 说明 |
---|---|
请求协议 | http[s] (为提高安全性,强烈推荐https) |
请求地址 | http[s]: //webapi.xfyun.cn/v1/service/v1/ocr/handwriting 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
请求方式 | POST |
接口鉴权 | 签名机制,见授权认证 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
图片格式 | jpg/png/bmp |
图片属性 | 最短边至少15px,最长边最大4096px |
图片大小 | 图像数据按要求编码后(base64编码后进行urlencode)大小不超过4M |
文字语种 | 中英文 |
注: 若需配置IP白名单,请前往控制台。IP白名单规则请参照 IP白名单。
接口地址示例:
POST http[s]://webapi.xfyun.cn/v1/service/v1/ocr/handwriting HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8
在调用该业务接口时
IP白名单规则
{
"code":"10105",
"desc":"illegal access|illegal client_ip",
"data":"",
"sid":"xxxxxx"
}
在 Http Request Header 中配置以下参数。
以下参数用于授权认证:
参数 | 格式 | 说明 | 必须 |
---|---|---|---|
X-Appid | string | 讯飞开放平台注册申请应用的应用ID(appid) | 是 |
X-CurTime | string | 当前UTC时间戳 从1970年1月1日0点0 分0 秒开始到现在的秒数 | 是 |
X-Param | string | 相关参数JSON串经Base64编码后的字符串,详见业务参数 | 是 |
X-CheckSum | string | 令牌,计算方法:MD5(APIKey + X-CurTime + X-Param),三个值拼接的字符串,进行MD5哈希计算(32位小写) | 是 |
注:
*X-CheckSum *生成示例:
String APIKey="abcd1234";
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);
X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串,原始 JSON 串各字段说明如下:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
language | string | 是 | 语言,可选值:en(英文),cn|en(中文或中英混合) | en |
location | string | 否 | 是否返回文本位置信息,可选值:false(否),true(是),默认为false | true |
imei | string | 否 | 手机序列号 | 12345678 |
osid | string | 否 | 操作系统版本 | Android |
ua | string | 否 | 厂商|全称|机型信息|操作系统版本|分辨率 | vivo|vivoY67L|PD1612|ANDROID6.0|720*1280 |
X-Param生成示例:
原始JSON串:
{
"language": "en",
"location": "false"
}
BASE64编码(即X-Param):
eyJsYW5ndWFnZSI6ImVuIiwibG9jYXRpb24iOiJmYWxzZSJ9
以POST表单的形式提交以下参数:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
image | string | 是 | 图像数据 base64编码后进行urlencode 要求base64编码和urlencode后大小不超过4M 最短边至少15px,最长边最大4096px 支持jpg/png/bmp格式 | exSI6ICJ... |
注:
1)一般基础类库会默认进行urlencode处理,请注意不要重复处理
2)base64编码后大小会增加约1/3
返回值为json串,各字段如下:
参数 | 类型 | 说明 |
---|---|---|
code | string | 结果码(具体见SDK&API错误码查询) |
data | json | 详见data说明 |
desc | string | 描述 |
sid | string | 会话ID |
其中sid字段主要用于追查问题,如果出现问题,可以提供sid给讯飞技术人员帮助确认问题。
data各字段说明如下:
参数 | 类型 | 说明 |
---|---|---|
block | 对象数组 | 区域块信息 |
type | string | 区域块类型(text-文本,image-图片) |
line | 对象数组 | 行信息 |
word | 对象数组 | 字(中文),单词(英文) |
content | string | 内容 |
confidence | float | 后验概率 |
location | 对象 | 位置信息 |
top_left | 对象 | 左上角位置信息 |
right_bottom | 对象 | 右下角位置信息 |
x | int | 对应点的横坐标(像素) |
y | int | 对应点的纵坐标(像素) |
示例如下:
失败:
{
"code": "10106",
"desc": "invalid parameter|invalid X-Appid",
"data": "",
"sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}
成功
含位置信息
{
"code":"0",
"data":{
"block":[
{
"line":[
{
"confidence":1,
"word":[
{
"content":"with"
}
],
"location":{
"right_bottom":{
"y":52,
"x":180
},
"top_left":{
"y":10,
"x":113
}
}
}
],
"type":"text"
}
]
},
"sid":"wcr00000009@ch0fc40d9e4cdf000100",
"desc":"success"
}
不含位置信息
{
"code":"0",
"data":{
"block":[
{
"line":[
{
"confidence":1,
"word":[
{
"content":"with"
}
]
}
],
"type":"text"
}
]
},
"sid":"wcr00000008@ch0fc40d9e4c73000100",
"desc":"success"
}
答:这是由于填写参数错误导致报错,language可选值"en","cn|en"这两个参数。
答:可能是上传手写文字图片不清晰、字过小、过大导致识别有误或者不识别,这种情况可以尝试上传更加清晰易辨别字体来提高识别的准确性。
答:手写文字识别针对手写体效果支持更佳,对印刷体的识别效果偏弱。
答:这个是由于ip没有设置白名单导致,请将ip添加至手写识别白名单中,大约5-10min生效。
答:目前支持中文版、英文版和中英文混合版。
答:抱歉,目前手写文字识别不支持离线使用。
答:目前没有通用的识别接口,手写文字识别是针对手写文字识别做过优化的,手写识别的效果会更好,印刷文字识别也是如此,不建议混淆识别,混淆识别可能导致效果不是很好或识别不出,以实际测试结果为准。
答:中文可以返回文本区域块的位置信息,英文暂不支持返回位置信息。
答:每个账号免费领取一次3000服务量有效期90天,套餐一:1w次服务量/350元/年,套餐二:10w次服务量/3200元/年,套餐三:100w次服务量/30000元/年,可在控制台对应服务--->实时用量--->购买服务量,套餐详细说明页。