調用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 | 是否成功添加人臉。取值:
|
樣本
請求樣本
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
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。