自定义face库接口
更新时间：2024-08-02
文档中提到的库指的是lib，库集指的是brief，库集素材指的是image。库里包含库集，库集里包含库集素材集合。 图片URL仅支持http或https协议。
创建自定义face库
请求语法
POST /v{version}/face/lib HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
无
请求参数
无
请求体
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib | String | 库名称 | 是，长度不超过20，支持小写字母、数字和_，以字母开头，且必须全局唯一 |
| description | String | face库描述 | 否，长度不超过256 |
请求示例
POST /v1/face/lib HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"lib": "test",
"description": "这是一个自定义face库"
}响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OK列出所有face库
请求语法
GET /v{version}/face/lib HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
无
请求参数
无
请求体
无
请求示例
GET /v1/face/lib HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>响应头域
无
响应体
| 参数 | 类型 | 描述 |
|---|---|---|
| libs | 对象数组 | face库列表 |
| +userId | String | 用户id |
| +lib | String | face库名称 |
| +createTime | Date | face库创建时间 |
| +description | String | face库描述 |
响应示例
HTTP/1.1 200 OK
{
"libs": [
{
"userId": "xxxxxxxxxxxxxxxxxx",
"lib': 'test",
"createTime': "2019-01-01T00:00:00Z",
"description": ""
}
]
}删除自定义face库
请求语法
DELETE /v{version}/face/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| version | String | 版本 | 是 |
| lib | String | face库名 | 是 |
请求参数
无
请求体
无
请求示例
DELETE /v1/face/lib/test HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
}响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OKface库集素材添加
请求语法
POST /v{version}/face/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib | String | face库名 | 是 |
请求参数
无
请求体
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| image | String | 图片url | 是 |
| brief | String | 图片集 | 是 |
请求示例
POST /v1/face/lib/aaa HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>
{
"image": "http://image.domain.com/dir/image_path.jpg",
"brief": "name0"
}响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OKface库集素材删除
- 删除指定url的图片
请求语法
DELETE /v{version}/face/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib | String | face库名 | 是 |
请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| brief | String | 图片集 | 是 |
| image | String | 图片url | 是 |
请求体
无
请求示例
DELETE /v1/face/lib/test?brief=吴亦凡&image=http://xx.xx.xx.xx HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OKface库集素材列表
请求语法
GET /v{version}/face/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib | String | face库名 | 是 |
请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| brief | String | 图片集 | 是 |
请求体
无
请求示例
GET /v1/face/lib/aaa?brief=吴亦凡 HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>响应头域
无
响应体
| 参数 | 类型 | 描述 |
|---|---|---|
| images | String数组 | 图片url列表 |
响应示例
HTTP/1.1 200 OK
{
"images": [
"http://xx.xx.xx.xx.jpg",
"http://xx.xx.xx.yy.jpg"
]
}
face库集删除
请求语法
DELETE /v{version}/face/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib | String | face库名 | 是 |
请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| brief | String | 图片集 | 是 |
请求体
无
请求示例
DELETE /v1/face/lib/aaa?brief=吴亦凡 HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>响应头域
无
响应体
无
响应示例
HTTP/1.1 200 OKface库集列表
请求语法
GET /v{version}/face/lib/{lib} HTTP/1.1
host: vca.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json支持v1、v2
路径参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| lib | String | face库名 | 是 |
请求参数
无
请求体
无
请求示例
GET /v1/face/lib/aaa HTTP/1.1
host: vca.bj.baidubce.com
content-type: application/json
authorization: <bce-authorization-string>响应头域
无
响应体
| 参数 | 类型 | 描述 |
|---|---|---|
| briefs | String数组 | 图片集列表 |
响应示例
HTTP/1.1 200 OK
{
"briefs": [
"name0", "name1"
]
}