- [接口地址](##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"
}
~~~
