通用文字识别_含位置版
<h3>接口描述</h3>
<ul>
<li>通用文字识别，可返回文字在图片中的位置信息，方便用户进行版式的二次处理。</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/ocr/common-word</code></p>
<h3>请求方式</h3>
<ul>
<li>POST</li>
</ul>
<h3>请求格式</h3>
<ul>
<li>x-www-form-urlencoded</li>
</ul>
<h3>请求参数</h3>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>appId</td>
<td>String</td>
<td>是</td>
<td>服务商分配的唯一标识</td>
</tr>
<tr>
<td>timestamp</td>
<td>Long</td>
<td>是</td>
<td>当前时间的毫秒数</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名，见签名算法说明</td>
</tr>
<tr>
<td>image</td>
<td>String</td>
<td>否</td>
<td>图片base64</td>
</tr>
<tr>
<td>pdf</td>
<td>String</td>
<td>否</td>
<td>PDF文件的base64</td>
</tr>
<tr>
<td>pdfNum</td>
<td>String</td>
<td>否</td>
<td>需要识别的PDF文件的对应页码，不传默认识别第 1 页</td>
</tr>
<tr>
<td>ofd</td>
<td>String</td>
<td>否</td>
<td>OFD文件的base64</td>
</tr>
<tr>
<td>ofdNum</td>
<td>String</td>
<td>否</td>
<td>需要识别的OFD文件的对应页码，不传默认识别第 1 页</td>
</tr>
<tr>
<td>file</td>
<td>File</td>
<td>否</td>
<td>文件</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>文件地址</td>
</tr>
</tbody>
</table>
<ul>
<li>image、pdf、ofd、file、url 必须提供一个，优先级：image > pdf > ofd > file > url</li>
<li>文件不超过4M，最短边至少15px，最长边最大4096px</li>
<li>图片格式为 jpg、png、bmp、jpeg</li>
</ul>
<h3>签名算法说明</h3>
<pre><code>sign = sha256( appId + appSecret + timestamp)</code></pre>
<p>用服务商分配的 appId、服务商分配的 appSecret，当前时间毫秒数 timestamp，按上述顺序拼接成字符串，再进行 sha256 哈希得到。如下：</p>
<pre><code class="language-java">String appId = &quot;xyzxy2121zxyz&quot;；
String timestamp = &quot;1555378976238&quot;；
String appSecret = &quot;efcefcef1121cefcefc1212121&quot;；
String str = appId + appSecret + timestamp；
String sign = sha256(str)；</code></pre>
<h3>返回样例</h3>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;成功&quot;,// code 对应的描述
&quot;code&quot;: 200,// 详见code返回码说明
&quot;taskNo&quot;: &quot;316942821199035820008485&quot;,// 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;resultNum&quot;: 2,//识别结果数
&quot;result&quot;: [//识别结果
{
&quot;words&quot;: &quot;测试第一行&quot;,//识别结果字符串
&quot;location&quot;: {//位置数组（坐标0点为左上角）
&quot;top&quot;: 72,//表示定位位置的长方形左上顶点的垂直坐标
&quot;left&quot;: 89,//表示定位位置的长方形左上顶点的水平坐标
&quot;width&quot;: 52,//表示定位位置的长方形的宽度
&quot;height&quot;: 12//表示定位位置的长方形的高度
},
&quot;probability&quot;: {//表示识别结果中每一行的置信度值
&quot;average&quot;: 0.9956096411,//行置信度平均值
&quot;min&quot;: 0.9842295051,//行置信度最小值
&quot;variance&quot;: 0.00003516419747//行置信度方差
},
&quot;vertexesLocation&quot;: [//识别结果中每一行的外包四边形点坐标
{
&quot;x&quot;: 90,//水平坐标（坐标0点为左上角）
&quot;y&quot;: 73//垂直坐标（坐标0点为左上角）
},
{
&quot;x&quot;: 142,
&quot;y&quot;: 73
},
{
&quot;x&quot;: 142,
&quot;y&quot;: 85
},
{
&quot;x&quot;: 90,
&quot;y&quot;: 85
}
],
&quot;finegrainedVertexesLocation&quot;: [//识别结果中每一行的多边形轮廓点坐标
{
&quot;x&quot;: 89,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 101,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 113,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 124,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 136,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 78
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 130,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 118,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 106,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 95,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 89,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 89,
&quot;y&quot;: 78
}
]
},
],
&quot;paragraphsResult&quot;: [//段落检测结果
{
&quot;wordsResultIdx&quot;: [//一个段落包含的行序号
0,
1
],
&quot;finegrainedVertexesLocation&quot;: [//识别结果中每一行的多边形轮廓点坐标
{
&quot;x&quot;: 89,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 101,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 113,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 124,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 136,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 72
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 88
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 100
},
{
&quot;x&quot;: 141,
&quot;y&quot;: 100
},
{
&quot;x&quot;: 129,
&quot;y&quot;: 100
},
{
&quot;x&quot;: 117,
&quot;y&quot;: 100
},
{
&quot;x&quot;: 104,
&quot;y&quot;: 99
},
{
&quot;x&quot;: 92,
&quot;y&quot;: 99
},
{
&quot;x&quot;: 89,
&quot;y&quot;: 99
},
{
&quot;x&quot;: 89,
&quot;y&quot;: 99
},
{
&quot;x&quot;: 89,
&quot;y&quot;: 87
},
{
&quot;x&quot;: 89,
&quot;y&quot;: 84
},
{
&quot;x&quot;: 89,
&quot;y&quot;: 72
}
]
}
],
&quot;paragraphsResultNum&quot;: 1,//识别结果数，表示 paragraphsResult 的元素个数
&quot;pdfFileSize&quot;: 1//传入PDF文件的总页数，当 pdfFile 参数有效时返回该字段
}
}
</code></pre>
<h3>错误返回样例</h3>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;图片格式不正确&quot;,
&quot;code&quot;: 400
}</code></pre>
<h3>返回字段说明</h3>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>返回码，详见code返回码说明</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>charge</td>
<td>是否计费</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果，object类型，详见成功返回体</td>
</tr>
</tbody>
</table>
<h4>code返回码说明</h4>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功 （计费）</td>
</tr>
<tr>
<td>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>接口地址不正确</td>
</tr>
<tr>
<td>500</td>
<td>系统维护，请稍候再试</td>
</tr>
<tr>
<td>601</td>
<td>接口未开通</td>
</tr>
<tr>
<td>602</td>
<td>账号停用</td>
</tr>
<tr>
<td>603</td>
<td>余额不足请充值</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>606</td>
<td>调用超限，请稍候再试</td>
</tr>
<tr>
<td>607</td>
<td>ip不在白名单</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁，请稍候再试</td>
</tr>
<tr>
<td>610</td>
<td>请求超时</td>
</tr>
<tr>
<td>999</td>
<td>其他，以实际返回为准</td>
</tr>
</tbody>
</table>