废弃(2003)-支持文档
[TOC]
## 1.接口说明
用户向服务请求识别某张图中的所有文字,并返回文字在图中的位置信息。
## 2.请求说明
<table><thead><tr><th>参数</th><th>是否必选</th><th>类型</th><th>可选值范围</th><th>说明</th></tr></thead><tbody><tr><td>image</td><td>和url二选一</td><td>string</td><td>-</td><td>图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效</td></tr><tr><td>url</td><td>和image二选一</td><td>string</td><td>-</td><td>图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效,不支持https的图片链接</td></tr><tr><td>recognize_granularity</td><td>false</td><td>string</td><td>big、small</td><td>是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置</td></tr><tr><td>language_type</td><td>false</td><td>string</td><td>CHN_ENG、ENG、<br>POR、FRE、<br>GER、ITA、<br>SPA、RUS、<br>JAP、KOR</td><td>识别语言类型,默认为CHN_ENG。可选值包括:<br>- CHN_ENG:中英文混合;<br>- ENG:英文;<br>- POR:葡萄牙语;<br>- FRE:法语;<br>- GER:德语;<br>- ITA:意大利语;<br>- SPA:西班牙语;<br>- RUS:俄语;<br>- JAP:日语;<br>- KOR:韩语</td></tr><tr><td>detect_direction</td><td>false</td><td>string</td><td>true、false</td><td>是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:<br>- true:检测朝向;<br>- false:不检测朝向。</td></tr><tr><td>detect_language</td><td>FALSE</td><td>string</td><td>true、false</td><td>是否检测语言,默认不检测。当前支持(中文、英语、日语、韩语)</td></tr><tr><td>vertexes_location</td><td>FALSE</td><td>string</td><td>true、false</td><td>是否返回文字外接多边形顶点位置,不支持单字位置。默认为false</td></tr><tr><td>probability</td><td>false</td><td>string</td><td>true、false</td><td>是否返回识别结果中每一行的置信度</td></tr></tbody></table>
## 3.返回参数
<table><thead><tr><th>字段</th><th>是否必选</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td>log_id</td><td>是</td><td>uint64</td><td>唯一的log id,用于问题定位</td></tr><tr><td>direction</td><td>否</td><td>int32</td><td>图像方向,当detect_direction=true时存在。<br>- -1:未定义,<br>- 0:正向,<br>- 1: 逆时针90度,<br>- 2:逆时针180度,<br>- 3:逆时针270度</td></tr><tr><td>language</td><td>否</td><td>int32</td><td>语言,当detect_language=true时存在。<br>-1:未定义,<br>0:英文,<br>1: 日文,<br> 2:韩文,<br> 3:中文</td></tr><tr><td>words_result</td><td>是</td><td>array()</td><td>定位和识别结果数组</td></tr><tr><td>words_result_num</td><td>是</td><td>uint32</td><td>识别结果数,表示words_result的元素个数</td></tr><tr><td>+vertexes_location</td><td>否</td><td>array()</td><td>当前为四个顶点: 左上,右上,右下,左下。当vertexes_location=true时存在</td></tr><tr><td>++x</td><td>是</td><td>uint32</td><td>水平坐标(坐标0点为左上角)</td></tr><tr><td>++y</td><td>是</td><td>uint32</td><td>垂直坐标(坐标0点为左上角)</td></tr><tr><td>+location</td><td>是</td><td>array()</td><td>位置数组(坐标0点为左上角)</td></tr><tr><td>++left</td><td>是</td><td>uint32</td><td>表示定位位置的长方形左上顶点的水平坐标</td></tr><tr><td>++top</td><td>是</td><td>uint32</td><td>表示定位位置的长方形左上顶点的垂直坐标</td></tr><tr><td>++width</td><td>是</td><td>uint32</td><td>表示定位位置的长方形的宽度</td></tr><tr><td>++height</td><td>是</td><td>uint32</td><td>表示定位位置的长方形的高度</td></tr><tr><td>+words</td><td>否</td><td>string</td><td>识别结果字符串</td></tr><tr><td>+chars</td><td>否</td><td>array()</td><td>单字符结果,recognize_granularity=small时存在</td></tr><tr><td>++location</td><td>是</td><td>array()</td><td>位置数组(坐标0点为左上角)</td></tr><tr><td>+++left</td><td>是</td><td>uint32</td><td>表示定位位置的长方形左上顶点的水平坐标</td></tr><tr><td>+++top</td><td>是</td><td>uint32</td><td>表示定位位置的长方形左上顶点的垂直坐标</td></tr><tr><td>+++width</td><td>是</td><td>uint32</td><td>表示定位定位位置的长方形的宽度</td></tr><tr><td>+++height</td><td>是</td><td>uint32</td><td>表示位置的长方形的高度</td></tr><tr><td>++char</td><td>是</td><td>string</td><td>单字符识别结果</td></tr><tr><td>probability</td><td>否</td><td>float</td><td>识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值</td></tr></tbody></table>