人脸库管理接口
人脸库创建接口
接口描述
在添加人脸之前首先要创建人脸库，该接口提供创建人脸库的功能。
权限说明
请求发起人需要填写从token接口获取到的有效的token才能发起请求。
请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/group/create
Header如下：
| 头域 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| Authorization | String | 填写根据token接口获取到的token | 必须 |
请求参数
Body中放置请求参数，参数详情如下：
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| groupId | String | 人脸库ID，项目级别唯一，提交后不可修改。数字、字母、下划线组成，长度不超过32个字符 | 必须 |
| groupName | String | 长度不超过40个字符，可修改，项目级别唯一。 | 必须 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| error_code | int | 错误码 |
| error_msg | String | 操作结果提示信息 |
| result | Object | 操作结果展示Model |
result的数据类型如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupId | String | 人脸库ID |
| groupName | String | 人脸库Name |
| createTime | long | 创建时间 |
| updateTime | long | 更新时间 |
请求示例
POST HTTP/1.1
Host: robot.baidu.com
Content-Type: application/json;charset=UTF-8
Authorization: authorization string
{
"groupId":"face_group_id_1",
"groupName":"face_group_name_1"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"error_code":0,
"error_msg":"操作成功",
"result": {
"groupId":"face_group_id_1",
"groupName":"face_group_name_1",
"createTime":1547119839635,
"updateTime":1547119839635
}
}人脸库修改接口
接口描述
修改指定人脸库ID的人脸库信息，目前只能修改人脸库名称。
权限说明
请求发起人需要具有合法的根据token接口获取到的token才能发起请求。
请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/group/update
Header如下：
| 头域 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| Authorization | String | 填写根据token接口获取到的token | 必须 |
请求参数
Body中放置请求参数，参数详情如下：
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| groupId | String | 人脸库ID | 必须 |
| groupName | String | 长度不超过40个字符，可修改，项目级别唯一。 | 必须 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| error_code | int | 错误码 |
| error_msg | String | 操作结果提示信息 |
请求示例
POST HTTP/1.1
Host: robot.baidu.com
Content-Type: application/json;charset=UTF-8
Authorization: authorization string
{
"groupId":"face_group_id_1",
"groupName":"face_group_name_1_update"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"error_code":0,
"error_msg":"操作成功"
}人脸库详情接口
接口描述
查询指定的人脸库详情信息。
权限说明
请求发起人需要具有合法的根据token接口获取到的token才能发起请求。
请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/group/detail
Header如下：
| 头域 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| Authorization | String | 填写根据token接口获取到的token | 必须 |
请求参数
Body中放置请求参数，参数详情如下：
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| groupId | String | 人脸库ID | 必须 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| error_code | int | 错误码 |
| error_msg | String | 错误提示信息 |
| result | Object | 操作结果展示Model |
result的数据类型如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupId | String | 人脸库ID |
| groupName | String | 人脸库Name |
| createTime | long | 创建时间 |
| updateTime | long | 更新时间 |
请求示例
POST HTTP/1.1
Host: robot.baidu.com
Content-Type: application/json;charset=UTF-8
Authorization: authorization string
{
"groupId":"face_group_id_1"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"error_code":0,
"error_msg":"操作成功",
"result": {
"groupId":"face_group_id_1",
"groupName":"face_group_name_1_update",
"createTime":1547119839635,
"updateTime":1547119839635
}
}人脸库删除接口
接口描述
删除一个指定的人脸库和该人脸库下所有的人脸，如果一个人脸在多个人脸库中存在，该操作不会删除其他人脸库中的人脸。
权限说明
请求发起人需要具有合法的根据token接口获取到的token才能发起请求。
请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/group/delete
Header如下：
| 头域 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| Authorization | String | 填写根据token接口获取到的token | 必须 |
请求参数
Body中放置请求参数，参数详情如下：
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| groupId | String | 人脸库ID | 必须 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| error_code | int | 错误码 |
| error_msg | String | 错误提示信息 |
请求示例
POST HTTP/1.1
Host: robot.baidu.com
Content-Type: application/json;charset=UTF-8
Authorization: authorization string
{
"groupId":"face_group_id_1"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"error_code":0,
"error_msg":"操作成功"
}人脸库查询接口
接口描述
查询人脸库列表。
权限说明
请求发起人需要具有合法的根据token接口获取到的token才能发起请求。
请求结构
HTTP方法：POST
请求URL： https://robot.baidu.com/abc-robot/openapi/v1/face-manage/group/query
Header如下：
| 头域 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| Authorization | String | 填写根据token接口获取到的token | 必须 |
请求参数 Body中放置请求参数，参数详情如下：
| 名称 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| pageNo | int | 查询页数，大小不能小于1 | 必须 |
| pageSize | int | 每页显示数量，范围为1-100 | 必须 |
返回头域 除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| error_code | int | 错误码 |
| error_msg | String | 提示信息 |
| result | Object | 操作结果展示Model |
result的数据类型如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| pageSize | int | 每页显示数量 |
| curPage | int | 当前页 |
| totalPage | long | 总页数 |
| totalNumber | long | 总条数 |
| content | Array | 列表内容 |
content的数据类型如下：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| groupId | String | 人脸库ID |
| groupName | String | 人脸库名称 |
| createTime | long | 创建时间 |
| updateTime | long | 更新时间 |
| faceCount | long | 人脸库包含的人脸数量 |
请求示例
POST HTTP/1.1
Host: robot.baidu.com
Content-Type: application/json;charset=UTF-8
Authorization: authorization string
{
"pageNo":1
"pageSize":15
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"error_code":0,
"error_msg":"操作成功",
"result": {
"pageSize":15,
"curPage":1,
"totalPage":1,
"totalNumber":1,
"content":[
{
"groupId":"Default",
"groupName":"Default",
"createTime":1558340478928,
"updateTime":1558340478928,
"faceCount":1
}
]
}
}