获取任务信息
<p>[TOC]</p>
<h1>简要描述</h1>
<ul>
<li>通过该接口获取指定人脸分析任务信息（状态、进度、结果）</li>
</ul>
<h1>请求URL</h1>
<ul>
<li><code>http://IP:PORT/LVFaceService/task/{task_id}</code></li>
</ul>
<h1>请求方式</h1>
<ul>
<li>get</li>
</ul>
<h1>参数</h1>
<h2>请求参数</h2>
<h3>Query 参数</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">task_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>任务ID</td>
<td>--</td>
</tr>
</tbody>
</table>
<h3>请求样例</h3>
<pre><code> get http://IP:PORT/LVFaceService/person?task_id=task001</code></pre>
<h5>返回体示例</h5>
<pre><code>{
&quot;task_id&quot;: &quot;task001&quot;,
&quot;task_process&quot;: 100,
&quot;task_status&quot;: &quot;finished&quot;,
&quot;result_file&quot;: &quot;http://10.0.5.149:20060/LVFaceService/task/task001/result/task001.json&quot;
}</code></pre>
<h5>人脸分析结果文件内容示例</h5>
<pre><code>[
{
&quot;face_id&quot;: &quot;3&quot;,
&quot;face_segments&quot;: [
{
&quot;start_ms&quot;: 100000,
&quot;end_ms&quot;: 100000,
&quot;start_frame&quot;: 2500,
&quot;end_frame&quot;: 2500,
&quot;start_face_box&quot;: [
407,
18,
447,
70
],
&quot;end_face_box&quot;: [
407,
18,
447,
70
]
}
],
&quot;best_face_frame&quot;: 2500,
&quot;best_face_ms&quot;: 100000,
&quot;best_face_box&quot;: [407,
18,
447,
70]
},
{
&quot;face_id&quot;: &quot;4&quot;,
&quot;face_segments&quot;: [
{
&quot;start_ms&quot;: 107000,
&quot;end_ms&quot;: 107000,
&quot;start_frame&quot;: 2675,
&quot;end_frame&quot;: 2675,
&quot;start_face_box&quot;: [
516,
261,
540,
296
],
&quot;end_face_box&quot;: [
516,
261,
540,
296
]
}
],
&quot;best_face_frame&quot;: 2675,
&quot;best_face_ms&quot;: 107000,
&quot;best_face_box&quot;: [ 516,
261,
540,
296]
}
]</code></pre>
<h5>返回体说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">error</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">object</td>
<td>错误信息</td>
<td>如果返回该字段，说明服务报错；接口参见 ErrorInfo</td>
</tr>
<tr>
<td style="text-align: left;">task_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>任务ID</td>
<td>-</td>
</tr>
<tr>
<td style="text-align: left;">task_process</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">float</td>
<td>任务运行阶段，返回的进度</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">task_status</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>任务状态</td>
<td>状态枚举：finished（完成），pending（等待），running（运行中），error（错误）</td>
</tr>
<tr>
<td style="text-align: left;">result_file</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>结果文件url</td>
<td>使用该文件保存人脸分析结果，文件内部采用json结构，是一个对象列表，列表内对象结构具体参考 FaceAnalyzeResult 结构</td>
</tr>
</tbody>
</table>
<h5>ErrorInfo</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">error_code</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">integer</td>
<td>错误码</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">error_desc</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>错误描述</td>
</tr>
</tbody>
</table>
<h5>FaceAnalyzeResult</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">face_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>人脸在分析资源中的唯一标识</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">best_face_ms</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">integer</td>
<td>最优人脸时间位置</td>
<td>单位ms,只有视频有效</td>
</tr>
<tr>
<td style="text-align: left;">best_face_frame</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">integer</td>
<td>最优人脸帧位置</td>
<td>只有视频有效</td>
</tr>
<tr>
<td style="text-align: left;">best_face_box</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">integer array</td>
<td>最优人脸画面位置</td>
<td>[左上角点x坐标，左上角点y坐标，右下角点x坐标，右下角点y坐标]</td>
</tr>
<tr>
<td style="text-align: left;">face_segments</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">object array</td>
<td>人脸片段列表</td>
<td>列表内结构参见 FaceSegmentInfo</td>
</tr>
</tbody>
</table>
<h5>FaceSegmentInfo</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">start_ms</td>
<td style="text-align: left;">integer</td>
<td style="text-align: left;">片段开始时间位置</td>
<td>单位ms</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">end_ms</td>
<td style="text-align: left;">integer</td>
<td style="text-align: left;">片段结束时间位置</td>
<td>单位ms</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">start_frame</td>
<td style="text-align: left;">integer</td>
<td style="text-align: left;">片段开始帧位置</td>
<td>--</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">end_frame</td>
<td style="text-align: left;">integer</td>
<td style="text-align: left;">片段结束帧位置</td>
<td>--</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">start_face_box</td>
<td style="text-align: left;">integer array</td>
<td style="text-align: left;">开始时间点人脸画面位置</td>
<td>[左上角点x坐标，左上角点y坐标，右下角点x坐标，右下角点y坐标]</td>
</tr>
<tr>
<td style="text-align: left;">end_face_box</td>
<td style="text-align: left;">integer array</td>
<td style="text-align: left;">结束时间点人脸画面位置</td>
<td>[左上角点x坐标，左上角点y坐标，右下角点x坐标，右下角点y坐标]</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>
<p>[TOC]</p>
<h1>简要描述</h1>
<ul>
<li>通过该接口创建人物</li>
</ul>
<h1>请求URL</h1>
<ul>
<li><code>http://IP:PORT/LVFaceService/person</code></li>
</ul>
<h1>请求方式</h1>
<ul>
<li>put </li>
</ul>
<h1>参数</h1>
<h2>请求参数</h2>
<h3>Body 参数</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">db_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>库ID</td>
<td>英文、数字、下划线(_)、中划线（-）组成，不能包含中文及其他特殊字符</td>
</tr>
<tr>
<td style="text-align: left;">person_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>人物ID</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">person_name</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>人物姓名</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">person_des</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>人物描述</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">object</td>
<td>用户数据</td>
<td>用户自定义数据</td>
</tr>
</tbody>
</table>
<h3>请求样例</h3>
<pre><code> put http://IP:PORT/LVFaceService/person
{
&quot;db_id&quot;: &quot;test001&quot;,
&quot;person_id&quot;: &quot;person001&quot;,
&quot;person_name&quot;: &quot;测试人物001&quot;,
&quot;data&quot;: {
&quot;testData&quot;:&quot;&quot;
}
}</code></pre>
<h5>返回体示例</h5>
<pre><code>{
&quot;db_id&quot;: &quot;test001&quot;,
&quot;person_id&quot;: &quot;person001&quot;,
&quot;person_name&quot;: &quot;测试人物001&quot;,
&quot;data&quot;: {
&quot;testData&quot;: &quot;&quot;
},
&quot;create_time&quot;: &quot;2024-10-21 13:38:27&quot;
}</code></pre>
<h5>返回体说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">error</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">object</td>
<td>错误信息</td>
<td>如果返回该字段，说明服务报错；接口参见 ErrorInfo</td>
</tr>
<tr>
<td style="text-align: left;">db_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>库ID</td>
<td>-</td>
</tr>
<tr>
<td style="text-align: left;">person_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>人物名称</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">person_name</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>人物姓名描述</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">object</td>
<td>用户数据</td>
<td>用户自定义数据结构</td>
</tr>
</tbody>
</table>
<h5>ErrorInfo</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">error_code</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">integer</td>
<td>错误码</td>
<td>--</td>
</tr>
<tr>
<td style="text-align: left;">error_desc</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>错误描述</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>