人脸搜索(M:N)
<h3>接口描述</h3>
<ul>
<li>待识别的图片中,存在多张人脸的情况下,支持在一个人脸库中,一次请求,同时返回图片中所有人脸的识别结果。</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/face/multi-search</code></p>
<h3>请求方式</h3>
<ul>
<li>POST</li>
</ul>
<h3>请求格式</h3>
<ul>
<li>form-data</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>number</td>
<td>是</td>
<td>当前时间的毫秒数</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名,见签名算法说明</td>
</tr>
<tr>
<td>file</td>
<td>file</td>
<td>否</td>
<td>人脸图片,文件类型,file、base64、url 必须提供一个</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>人脸图片的Base64,file、base64、url 必须提供一个</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>人脸图片的url,file、base64、url 必须提供一个</td>
</tr>
<tr>
<td>maxFaceNum</td>
<td>Integer</td>
<td>否</td>
<td>最多处理人脸的数目,默认值为1(仅检测图片中面积最大的那个人脸) 最大值10</td>
</tr>
<tr>
<td>matchThreshold</td>
<td>Integer</td>
<td>否</td>
<td>匹配阈值(设置阈值后,score低于此阈值的用户信息将不会返回) 最大100 最小0 默认80,此阈值设置得越高,检索速度将会越快,推荐使用默认阈值80</td>
</tr>
<tr>
<td>qualityControl</td>
<td>String</td>
<td>否</td>
<td>质量控制(质量不符合要求的人脸不会出现在返回结果中), NONE: 不进行控制,LOW:较低的质量要求,NORMAL: 一般的质量要求,HIGH: 较高的质量要求,默认 NONE</td>
</tr>
<tr>
<td>livenessControl</td>
<td>String</td>
<td>否</td>
<td>活体控制(活体分数不符合要求的人脸不会出现在返回结果中),NONE: 不进行控制,LOW:较低的活体要求(高通过率 低攻击拒绝率),NORMAL: 一般的活体要求(平衡的攻击拒绝率, 通过率),HIGH: 较高的活体要求(高攻击拒绝率 低通过率),默认NONE</td>
</tr>
<tr>
<td>maxUserNum</td>
<td>Integer</td>
<td>否</td>
<td>识别返回的最大用户数,默认为1,最大20个</td>
</tr>
</tbody>
</table>
<ul>
<li>图片文件大小不超过2MB</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>{
&quot;msg&quot;: &quot;成功&quot;,
&quot;success&quot;: true,
&quot;code&quot;: 200,
&quot;taskNo&quot;: &quot;525195723178392579953620&quot;,
&quot;charge&quot;: true,
&quot;data&quot;: {
&quot;face_num&quot;: 1,
&quot;face_list&quot;: [
{
&quot;face_token&quot;: &quot;2bcef82220e41cbe57feb652c69b4db8&quot;,
&quot;location&quot;: {
&quot;top&quot;: 95.57,
&quot;left&quot;: 103.77,
&quot;rotation&quot;: 7,
&quot;width&quot;: 83,
&quot;height&quot;: 83
},
&quot;user_list&quot;: [
{
&quot;score&quot;: 99.99991607666,
&quot;group_id&quot;: &quot;groupIdtest123&quot;,
&quot;user_id&quot;: &quot;userIdtest123&quot;,
&quot;user_info&quot;: &quot;&quot;
}
]
}
]
}
}</code></pre>
<h3>错误返回样例</h3>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;用户不存在&quot;,
&quot;code&quot;: 201
}</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返回码说明(非http返回状态码)</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果,object类型,详见data返回字段描述</td>
</tr>
</tbody>
</table>
<h4>data返回字段说明</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>face_num</td>
<td>图片中的人脸数量</td>
</tr>
<tr>
<td>face_list</td>
<td>人脸信息列表</td>
</tr>
<tr>
<td>face_token</td>
<td>人脸标志</td>
</tr>
<tr>
<td>user_list</td>
<td>匹配的用户信息列表</td>
</tr>
<tr>
<td>score</td>
<td>用户的匹配得分,推荐阈值80分</td>
</tr>
<tr>
<td>group_id</td>
<td>用户所属的group_id</td>
</tr>
<tr>
<td>user_id</td>
<td>用户的user_id</td>
</tr>
<tr>
<td>user_info</td>
<td>注册用户时携带的user_info</td>
</tr>
<tr>
<td>location</td>
<td>人脸在图片中的位置</td>
</tr>
<tr>
<td>top</td>
<td>人脸区域离上边界的距离</td>
</tr>
<tr>
<td>left</td>
<td>人脸区域离左边界的距离</td>
</tr>
<tr>
<td>width</td>
<td>人脸区域的宽度</td>
</tr>
<tr>
<td>height</td>
<td>人脸区域的高度</td>
</tr>
<tr>
<td>rotation</td>
<td>人脸框相对于竖直方向的顺时针旋转角,[-180,180]</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>