- [接口地址](##1)
- [请求参数](##2)
- [返回值](##3)
- [请求示例](##4)
<a name = "#1"></a>
## 接口地址
POST http://base_url/v1/service/v1/ocr/handwriting HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8
<a name = "#2"></a>
## 请求参数
<span style="color:red">在 Http Request Header 中配置授权认证参数，见【接口概述-授权认证】</span>。
其中 *X-Param* 为各配置参数组成的JSON串经BASE64编码之后的字符串，原始JSON串各字段说明如下：
|参数|类型|必须|说明|示例|
|:-------------|:-------------|:-------------|:-------------|:-------------|
|language | string | 是 | 语言，可选值：en（英文） |en|
|location | string | 否 | 是否返回文本位置信息，可选值：false（否），true（是），默认为false|true |
*X-Param生成示例：*
原始JSON串：
{
"language": "en",
"location": "false"
}
BASE64编码（即X-Param）：
ewoJICAgICJsYW5ndWFnZSI6ICJlbiIsCgkgICAgInBvc2l0aW9uIjogImZhbHNlIgoJfQ==
<span style="color:red">在 Http Request Body 中配置以下参数：</span>
|参数|类型|必须|说明|示例|
|:-----|:------|:---------|:-----------|:---------|
|image| string | 是 | 图像数据，base64编码后进行urlencode，要求base64编码和urlencode后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式|exSI6ICJlbiIsCgkgICAgInBvc2l0aW9uIjogImZhbHNlIgoJf...|
<a name = "#3"></a>
## 返回值
返回值为json串，各字段如下：
|参数|类型|说明|
|:------|:-----|:-----|
|code|string|结果码(具体见错误码)|
|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",
"desc": "success",
"data": {
"block": [
{
"location": {
"top_left": {
"x": 0,
"y": 0
},
"right_bottom": {
"x": 10,
"y": 10
}
},
"type": "text",
"line": [
{
"confidence": 0.89,
"location": {
"top_left": {
"x": 0,
"y": 0
},
"right_bottom": {
"x": 10,
"y": 10
}
},
"word": [
{
"location": {
"top_left": {
"x": 0,
"y": 0
},
"right_bottom": {
"x": 10,
"y": 10
}
},
"content": "hello"
}
]
}
]
}
]
},
"sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}
> 不含位置信息
{
"code": "0",
"desc": "success",
"data": {
"block": [
{
"type": "text",
"line": [
{
"confidence": 0.89,
"word": [
{
"content": "hello"
}
]
}
]
}
]
},
"sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}
<a name = "#4"></a>
## 请求示例
~~~[api]
post:http://api.xfyun.cn/v1/service/v1/ocr/handwriting
*X-Appid=123456#应用ID
*X-CurTime=123456#时间戳
*X-Param=123456#配置参数json串base64编码
*X-CheckSum=123456#令牌
*image=xxxx#图片数据base64编码
<<<
success
{
"code": "0",
"desc": "success",
"data": {
"block": [
{
"location": {
"top_left": {
"x": 0,
"y": 0
},
"right_bottom": {
"x": 10,
"y": 10
}
},
"type": "text",
"line": [
{
"confidence": 0.89,
"location": {
"top_left": {
"x": 0,
"y": 0
},
"right_bottom": {
"x": 10,
"y": 10
}
},
"word": [
{
"location": {
"top_left": {
"x": 0,
"y": 0
},
"right_bottom": {
"x": 10,
"y": 10
}
},
"content": "hello"
}
]
}
]
}
]
},
"sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}
<<<
error
{
"code": "10106",
"desc": "invalid parameter|invalid X-Appid",
"data": "",
"sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}
~~~
