智能结构化识别
<p>[TOC]</p>
<h3>接口描述</h3>
<ul>
<li>支持智能提取图片中的字段结构化信息，适用于各类证照、票据、表单等版式中的结构化信息录入场景。</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/ocr/struct</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>file</td>
<td>File</td>
<td>否</td>
<td>图片文件或pdf文件</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>图片或pdf的url</td>
</tr>
<tr>
<td>returnRelation</td>
<td>String</td>
<td>否</td>
<td>是否返回结构化对应关系及单文本行结果，为true时返回，默认false，针对relations、line_info</td>
</tr>
</tbody>
</table>
<ul>
<li>image、pdf、file、url 必须提供一个，优先级：image > pdf > file > url</li>
<li>图片、pdf文件不超过4M，最短边至少15px，最长边最大4096px，支持jpg/jpeg/png/bmp格式</li>
<li>图片支持jpg/jpeg/png/bmp格式</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;code&quot;: 200, //返回码，详见返回码说明
&quot;msg&quot;: &quot;成功&quot;, //返回码对应描述
&quot;charge&quot;: true, //计费标志
&quot;taskNo&quot;: &quot;868944265154130726683014&quot;, //本次请求号
&quot;data&quot;: {
&quot;object_id_num&quot;: &quot;58&quot;,//文本行结果数，当 returnRelation=true 时返回
&quot;pdf_size&quot;: &quot;1&quot;,//传入PDF文件的总页数，当pdf参数有效时返回该字段
&quot;result&quot;: {//识别结果
&quot;line_info&quot;: [//文字行的识别结果、类别、置信度、位置信息等
{
&quot;line__probability&quot;: 15.97,//文字行的文字结果识别置信度
&quot;top&quot;: 62.13,//表示文字行定位位置的长方形左上顶点的垂直坐标
&quot;left&quot;: 176.34,//表示文字行定位位置的长方形左上顶点的水平坐标
&quot;line_location&quot;: {},//文字行的位置
&quot;line_class&quot;: &quot;other&quot;,//文字行的类别，key 表示非表格区的 key 值，value 表示非表格区的 value 值，table_value 表格区的 value 值，other 表示无结构化关系的文本行
&quot;width&quot;: 403.42,//表示文字行定位位置的长方形的宽度
&quot;line_class_probability&quot;: 0.9859102964401245,//line_class 的分类置信度
&quot;object_id&quot;: 0,//文字行的 id，唯一标识，按从上到下从左到右顺序，依次顺位排列
&quot;word&quot;: &quot;江苏省车辆通行费通用(电子)发票&quot;,//文字行的文字结果
&quot;block_id&quot;: -1,//换行文字的 id，另一唯一标识，属于同一个词义的 n 个文字行的 block_id一致，按从上到下从左到右顺序，依次顺位排列。说明：block 只针非表格区 key、表格区 key、表格区 value。非换行的 block 元素固定返回 -1
&quot;height&quot;: 27.74 //表示文字行定位位置的长方形的高度
}
],
&quot;struct_info&quot;: {//非表格区的 k-v 按结构化对应展示信息
&quot;group&quot;: [
{
&quot;value&quot;: [//value 文字行的信息
{
&quot;word&quot;: &quot;132152300123&quot; //value 文字行的文字结果
}
],
&quot;key&quot;: [//key 文字行的信息
{
&quot;word&quot;: &quot;发票代码&quot; //key 文字行的文字结果
}
]
}
]
},
&quot;relations&quot;: {//结构化对应关系
&quot;table_relations&quot;: {//表格区的结构关系
&quot;vv_relations&quot;: [//表格区的v-v结构关系，可支持一对一、一对多的关系
{
&quot;leaf_nodes&quot;: [//由【前者 value】根节点指向叶子节点【后者 value】的 object_id
22,
23
],
&quot;root_node&quot;: 21 //根节点的 object_id，即表格区v-v关系的【前者 value】
}
],
&quot;kv_relations&quot;: [//表格区的k-v结构关系，可支持一对一、一对多的关系
{
&quot;leaf_nodes&quot;: [//由根节点指向叶子节点的 object_id，即表格/表单区k-v关系的values
21
],
&quot;root_node&quot;: 18 //根节点的 object_id，即表格区 k-v 关系的 key
}
],
&quot;kk_relations&quot;: [//表格区的 k-k 结构关系，即多级表头的结构关系，可支持一对一、一对多的关系
{
&quot;leaf_nodes&quot;: [//由【前者 key】根节点指向叶子节点【后者 key】的object_id
11
],
&quot;root_node&quot;: 9 //根节点的 object_id，即表格/表单区 k-k 关系的【前者 key】
}
]
},
&quot;kv_relations&quot;: [//非表格区的 k-v 结构化关系，可支持一对一、一对多的关系
{
&quot;leaf_nodes&quot;: [//由根节点指向叶子节点的 object_id，即 k-v 区的 values
2
],
&quot;root_node&quot;: 1 //根节点的 object_id，即 k-v 区的 key
}
]
}
}
}
}
</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>
<h3>code返回码说明</h3>
<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>