调用addFaces新增人脸_内容安全(Content Moderation)-阿里云帮助中心

调用addFaces接口为个体新增一组人脸图片。

一个个体最多允许包含20张人脸图片。

重要

如果您在添加人脸图片后的1年内未调用过任何人脸检索相关的接口（请参见图片人脸检索），人脸图片和人脸分组会被清空。

QPS限制

本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

请求语法

POST /green/sface/face/add HTTPS|HTTP

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求头。

请求参数

名称	类型	是否必选	示例值	描述
clientInfo	JSONObject	否	{"userId":"120234234","userNick":"Mike","userType":"others"}	客户端信息，由ClientInfo结构体通过JSON序列化获得，包含umid、imei等信息，具体结构描述，请参见ClientInfo。

RequestBody

RequestBody中还需要填入以下参数，用来指定个体和人脸图片信息。

名称	类型	是否必选	示例值	描述
bizType	String	否	edu	业务场景类型。
personId	String	是	person1	目标个体的ID。说明您可以调用/green/sface/group/persons获取所有个体ID。
urls	StringArray	是	["http://www.aliyundoc.com/xxx01.jpg","http://www.aliyundoc.com/xxx02.jpg"]	要添加的人脸图片的URL列表。

返回数据

所有请求均返回JSON格式的数据。关于返回数据中的公共字段，请参见公共返回参数。返回数据中的data字段表示与业务相关的数据，一般是一个JSON结构体或数组。

说明

响应出错的情况下，data字段可能为空。

该接口返回的data字段包含以下参数。

名称	类型	示例值	描述
code	Integer	200	错误码，和HTTP状态码一致。更多信息，请参见公共错误码。
groupId	StringArray	["foreign1"]	个体所属的个体组ID。
personId	String	person1	个体ID。
faceImageItems	JSONArray		已添加的人脸信息。具体结构描述，请参见faceImageItem。

表 1. faceImageItem

名称

类型

示例值

描述

faceId

Float

23088737259260929

人脸ID。

success

Boolean

true

是否成功添加人脸。取值：

true：是。
false：否。

示例

请求示例

POST /green/sface/face/add HTTP/1.1
公共请求头
{
    "personId": "person1",
    "urls": [
        "http://www.aliyundoc.com/xxx01.jpg",
        "http://www.aliyundoc.com/xxx02.jpg"
    ]
}

正常返回示例

{
    "msg": "OK",
    "code": 200,
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
    "data": {
        "code": 200,
        "groupIds": [
            "foreign1"
        ],
        "personId": "person1",
        "faceImageItems": [
            {
                "success": true,
                "faceId": 23088737259260929
            }
        ]
    }
}

错误码

访问错误中心查看更多错误码。