手写文字识别 API 文档

2023-08-16 08:48| 来源: 网络整理| 查看: 265

# 手写文字识别 API 文档 # 接口说明手写文字识别(Handwriting words Recognition)基于深度神经网络模型的端到端文字识别系统，将图片（来源如扫描仪或数码相机）中的手写字体转化为计算机可编码的文字，支持中英文。部分开发语言demo如下，其他开发语言请参照文档进行开发，也欢迎热心的开发者到讯飞开放平台社区 (opens new window) 分享你们的demo。

手写文字识别demo go语言 (opens new window)

手写文字识别demo php语言 (opens new window)

手写文字识别demo java语言 (opens new window)

手写文字识别demo python3语言 (opens new window)

手写文字识别demo c#语言 (opens new window)

手写文字识别demo nodejs语言 (opens new window)

集成手写文字识别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。若打开IP白名单，则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中，对于没有配置到白名单中的IP发来的请求，服务端会拒绝服务。注：若需配置IP白名单，请前往控制台。

IP白名单规则

IP白名单，在控制台-我的应用-相应服务的应用管理卡片上编辑，保存后五分钟左右生效；不同Appid的不同服务都需要分别设置IP白名单； IP白名单需设置为外网IP，请勿设置局域网IP；如果服务器返回结果如下所示(illegal client_ip)，则表示由于未配置IP白名单或配置有误，服务端拒绝服务。 { "code":"10105", "desc":"illegal access|illegal client_ip", "data":"", "sid":"xxxxxx" } # 请求参数通过接口密钥基于MD5计算签名，将签名以及其他参数放在Http Request Header中，详见下方请求头。将图片数据放在Http Request Body中，以POST表单的形式提交，详见下方请求体。 # 请求头

在 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位小写）是

注：

APIKey：接口密钥，在讯飞开放平台控制台添加相应服务后即可获取，调用方注意保管，如泄露，可到控制台提交工单联系技术人员重置； X-CheckSum 有效期：出于安全性考虑，每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算)，同时 X-CurTime 要与标准时间同步，否则时间相差太大，服务端会直接认为 X-CurTime 无效； BASE64 编码采用 MIME 格式，字符包括大小写字母各26个，加上10个数字，和加号 + ，斜杠 / ，一共64个字符。

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 串各字段说明如下：

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

# 返回结果

如出现错误码，可到这里 (opens new window) 查询。返回参数示例：失败：

{ "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" }

返回参数说明：

参数类型说明 code string 结果码(具体见SDK&API错误码查询 (opens new window)) 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 对应点的纵坐标（像素） # 常见问题 # 手写文字识别使用language="cn"参数报10107错误

答：这是由于填写参数错误导致报错，language可选值"en","cn|en"这两个参数。

# 手写识别部分字体无法识别

答：可能是上传手写文字图片不清晰、字过小、过大导致识别有误或者不识别，这种情况可以尝试上传更加清晰易辨别字体来提高识别的准确性。

# 手写文字识别是否支持印刷体识别？

答：手写文字识别针对手写体效果支持更佳，对印刷体的识别效果偏弱。

# 手写文字识别调用的时候出现40202错误

答：这个是由于ip没有设置白名单导致，请将ip添加至手写识别白名单中，大约5-10min生效。

# 手写文字识别支持哪些语言文字？

答：目前支持中文版、英文版和中英文混合版。

# 手写文字识别是否可以离线使用？

答：抱歉，目前手写文字识别不支持离线使用。

# 手写文字识别是否可以和印刷文字识别集成成一个接口使用？

答：目前没有通用的识别接口，手写文字识别是针对手写文字识别做过优化的，手写识别的效果会更好，印刷文字识别也是如此，不建议混淆识别，混淆识别可能导致效果不是很好或识别不出，以实际测试结果为准。

# 返回的位置信息能否精确到每个字或者每个单词？

答：中文可以返回文本区域块的位置信息，英文暂不支持返回位置信息。

# 手写文字识别的收费价格是多少？怎么购买？

答：每个账号免费领取一次3000服务量有效期90天，套餐一:1w次服务量/350元/年，套餐二:10w次服务量/3200元/年，套餐三:100w次服务量/30000元/年，可在控制台对应服务--->实时用量--->购买服务量，套餐详细说明页 (opens new window)。

【本文地址】

手写文字识别 API 文档

手写文字识别 API 文档

今日新闻

推荐新闻