自定义face库接口
更新时间：2022-10-27
文档中提到的库指的是lib，库集指的是brief，库集素材指的是image。库里包含库集，库集里包含库集素材集合。 图片URL支持bos及url，如果是url格式的，仅支持http或https协议。
创建自定义face库
创建自定义face库
请求语法
POST /v<version>/face/lib HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib | String | 自定义人脸库名称 | 是 |
| description | String | 描述，最大支持256字符 | 否 |
请求示例
POST /v1/face/lib HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"lib": "test",
"description": "lib-description"
}响应参数
无
响应示例
HTTP/1.1 200 OK列出所有face库
列出所有自定义face库
请求语法
GET /v<version>/face/lib HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
无
请求示例
GET /v1/face/lib HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| libs | Array | 自定义人脸库集合 | 是 |
| +lib | String | 自定义人脸库名称 | 是 |
| +description | String | 描述，最大支持256字符 | 否 |
| +userId | String | 用户id | 是 |
| +createTime | Date | 创建时间 | 是 |
响应示例
HTTP/1.1 200 OK
{
"libs": [
{
"userId": "6dbd5b0f9fed4b40871428310b8dd0f3",
"lib": "test",
"description": "test face lib",
"createTime": "2019-11-22 17:00:00"
}
]
}删除自定义face库
谨慎使用 该接口会删除自定义face库
- 注：删除face库会导致绑定该库的审核模版不可用，删除face库前请确认已无模版绑定该库。
请求语法
DELETE /v<version>/face/lib/{lib_name} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib_name | String | 自定义人脸库名称 | 是 |
请求示例
DELETE /v1/face/lib/test HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
无
响应示例
HTTP/1.1 200 OKface库集素材添加
往指定的face库集添加图片，添加时需指定库集名称，当库集存在时即直接添加素材image，若库集不存在，则直接根据库集名创建库集并做素材image入库。
请求语法
POST /v<version>/face/lib/{face_lib_name} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| image | String | 图片URL | 是 |
| brief | String | 库集名称 | 是 |
说明：
- 对于BOS图片，
source="bos://<bos-bucket>/<bos-object>”，例如"bos://testbucket/dir/image.jpg”，用户需要确保bos路径可访问。- 对于url图片，
source="http://domain.com/dir/image.jpg"，目前支持http/https协议url，用户需要确保该url外网可访问。
请求示例
POST /v1/face/lib/face_lib_name HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
{
"image": "bos://demo_bucket/demo_image.jpg",
"brief": "name"
}响应参数
无
响应示例
HTTP/1.1 200 OKface库集素材删除
删除库集素材，需指定库集名称及删除的库集素材。
请求语法
DELETE /v<version>/face/lib/{face_lib_name}?brief={brief}&image={image} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| image | String | 图片URL | 是 |
| brief | String | brief | 是 |
请求示例
DELETE /v1/face/lib/face_lib_name?brief=name_test&image=bos://demo_bucket/demo_image.jpg HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
无
响应示例
HTTP/1.1 200 OKface库集素材列表
根据face库集名称查询库集素材集合。
请求语法
GET /v<version>/face/lib/{name}?brief={brief} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| brief | String | 库集名称 | 是 |
请求示例
GET /v1/face/lib/face_lib_name?brief=test_name HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| images | Array | 库集素材数组 |
响应示例
HTTP/1.1 200 OK
{
"images": [
"http://bos.bucket.baidu.com/demo_image0.jpg",
"http://bos.bucket.baidu.com/demo_image1.jpg"
]
}face库集删除
根据指定的face库集名称删除库集。
请求语法
DELETE /v<version>/face/lib/{face_lib_name}?brief={brief} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| brief | String | 库集名称 | 是 |
请求示例
DELETE /v1/face/lib/face_lib_name?brief=test_name HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
无
响应示例
HTTP/1.1 200 OKface库集列表
查询face库集名称集合。
请求语法
GET /v<version>/face/lib/{face_lib_name} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>
content-type: application/json请求参数
无
请求示例
GET /v1/face/lib/face_lib_name HTTP/1.1
host: vcr.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
x-bce-date: <bce-authorization-utc-date>响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| briefs | Array | 库集名称集合 |
响应示例
HTTP/1.1 200 OK
{
"briefs": [
"name0", "name1"
]
}