自定义face库接口

文档中提到的库集指的是brief,库集素材指的是image。库集里包含库集素材集合。
图片URL支持bos及url,如果是url格式的,仅支持http或https协议。

face库集素材添加

往指定的face库集添加图片。

请求语法

POST /v<version>/face/lib/{face_lib_name} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
content-type: application/json

请求参数

参数 类型 描述 是否必须
image String 图片URL
brief String 库集名称

说明:

  1. 对于BOS图片,source="bos://<bos-bucket>/<bos-object>”,例如"bos://testbucket/dir/image.jpg”,用户需要确保bos路径可访问。
  2. 对于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>

{
    "image": "bos://demo_bucket/demo_image.jpg",
    "brief": "name"
}

响应参数

响应示例

HTTP/1.1 200 OK

face库集素材删除

删除库集素材,需指定库集名称及删除的库集素材。

请求语法

DELETE /v<version>/face/lib/{face_lib_name}?brief={brief}&image={image} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
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>

响应参数

响应示例

HTTP/1.1 200 OK

face库集素材列表

根据face库集名称查询库集素材集合。

请求语法

GET /v<version>/face/lib/{name}?brief={brief} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
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>

响应参数

参数 类型 描述
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>
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>

响应参数

响应示例

HTTP/1.1 200 OK

face库集列表

查询face库集名称集合。

请求语法

GET /v<version>/face/lib/{face_lib_name} HTTP/1.1
host: vcr.bj.baidubce.com
authorization: <bce-authorization-string>
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>

响应参数

参数 类型 描述
briefs Array 库集名称集合

响应示例

HTTP/1.1 200 OK
{
    "briefs": [
        "name0", "name1"
    ]
}