本文介紹人臉人體(facebody)類目下的添加人臉數據AddFace的語法及示例。
功能描述
添加人臉數據能力可以為指定數據庫添加人臉數據,單個人臉數據庫支持最多5萬張人臉照片入庫,人臉數據是在已創建好的人臉樣本中添加,每個人臉樣本最多可以添加5張人臉照片。
人臉照片入庫量以及每個人臉樣本最多添加的照片量暫不支持擴容。
- 您可以進入在線咨詢獲取在線人工幫助。
- 阿里云視覺智能開放平臺視覺AI能力API接入、接口使用或問題咨詢等,請通過釘釘群(23109592)加入阿里云視覺智能開放平臺咨詢群聯系我們。
接入指引
1. 注冊阿里云賬號:打開阿里云官網,在阿里云官網右上角,單擊立即注冊,按照操作提示完成賬號注冊。
2. 開通能力:請確保您已開通人臉人體服務,若未開通服務請立即開通。
本能力支持企業或個人認證用戶開通。更多實名認證操作信息,請參見實名認證。
3. 創建AccessKey:請確保您已創建AccessKey,如果您使用的是子賬號AccessKey,您需要給子賬號賦予AliyunVIAPIFullAccess權限,具體操作,請參見RAM授權。
4. 前提條件:
4. 在線調試(可選):您可以通過OpenAPI Explorer在線調試能力,查看完整的調用示例代碼及SDK依賴信息,也可以下載完整的工程。
5. 開發接入步驟:
- 在SDK總覽中選擇您要接入使用的SDK語言。
- 在對應語言的SDK文檔中找到AI類目為人臉人體(facebody)的SDK包進行安裝。
- 參考文檔中提供的示例代碼進行適當修改后調用。
6. 示例代碼:該能力常用語言的示例代碼,請參見添加人臉數據示例代碼。
7. 客戶端直接調用:該能力常用的客戶端調用方式包括以下幾種。
輸入限制
- 圖像格式:JPG、JPEG、PNG。
- 圖像大小:不超過5 MB。
- 圖像分辨率:大于32×32像素,小于4096×4096像素。人臉占比不低于64×64像素。
- URL地址中不能包含中文字符。
- 圖片中若包含多個人臉,會取最大的人臉進行添加。
限制說明
添加人臉數據接口提交任務并發默認為2QPS。
計費說明
添加人臉數據能力可免費調用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | AddFace | 系統規定參數。取值:AddFace。 |
DbName | String | 是 | default | 數據庫名稱。支持小寫字母、數字、下劃線的組合,長度1~64。 |
ImageUrl | String | 是 | https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/demo/1.png | 人臉圖片地址,人臉必須是正面無遮擋人臉(若包含多張人臉則取最大人臉添加)。推薦使用上海地域的OSS鏈接,對于文件在本地或者非上海地域OSS鏈接的情況,請參見文件URL處理。 |
EntityId | String | 是 | U1 | 實體ID,用來標識用戶的唯一性,如用戶ID、員工ID等。每個實體可包含多張人臉圖片。支持大小寫字母、數字、下劃線、減號的組合,長度為1~64字符。 |
ExtraData | String | 否 | 王小二 | 自定義信息。支持字母、數字、標點符號和漢字。不超過512個字符。 |
QualityScoreThreshold | Float | 否 | 50.0 | 質量分閾值。對新增人臉圖片進行質量分析判斷,得到的質量分小于該閾值則表示新增人臉圖片質量不符合要求,添加失敗。取值范圍[0.0,100.0]。0.0或空則表示不做質量分判斷邏輯。 |
SimilarityScoreThresholdInEntity | Float | 否 | 50.0 | 類內相似度閾值。將新增人臉圖片與EntityId內已有人臉進行相似比對,小于該閾值則表示與其他人臉圖片差異較大,添加失敗.;若EntityId內沒有人臉存在,則添加成功。取值范圍[0.0,100.0]。0.0或空則表示不做類內相似度判斷邏輯。參考值見人臉比對1:1接口的返回結果字段Thresholds。 |
SimilarityScoreThresholdBetweenEntity | Float | 否 | 50.0 | 類間相似度閾值。將新增人臉圖片與其他所有EntityId內已有人臉進行相似比對,大于等于該閾值則表示其他EntityId內存在相似人臉,出現重復,添加失敗。取值范圍[0.0,100.0]。0.0或空則表示不做類間相似度判斷邏輯。參考值見人臉比對1:1接口的返回結果字段Thresholds。 說明 類間相似度閾值檢查僅適用于每個EntityId下首次上傳的第一張人臉圖片。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 2B93C43A-F824-40C8-AF79-844342B0F43A | 請求ID。 |
Data | Object | 返回的結果數據內容。 |
|
FaceId | String | 5 | 輸出人臉ID。 |
QualitieScore | Float | 99.79581 | 輸入圖像中的人臉質量分。 |
SDK參考
阿里云視覺AI人臉人體類目下的添加人臉數據能力推薦使用SDK調用,支持多種編程語言,調用時請選擇AI類目為人臉人體(facebody)的SDK包,文件參數通過SDK調用可支持本地文件及任意URL,具體可參見SDK總覽。
示例代碼
該能力常用語言的示例代碼,請參見添加人臉數據示例代碼。
示例
請求示例
http(s)://facebody.cn-shanghai.aliyuncs.com/?Action=AddFace //更多關于訪問域名(Endpoint)信息,請參見:http://bestwisewords.com/document_detail/143103.html
&DbName=default
&ImageUrl=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/demo/1.png
&EntityId=U1
&ExtraData=王小二
&QualityScoreThreshold=50.0
&SimilarityScoreThresholdInEntity=50.0
&SimilarityScoreThresholdBetweenEntity=50.0
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AddFaceResponse>
<RequestId>2B93C43A-F824-40C8-AF79-844342B0F43A</RequestId>
<Data>
<FaceId>5</FaceId>
<QualitieScore>99.79581</QualitieScore>
</Data>
</AddFaceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "2B93C43A-F824-40C8-AF79-844342B0F43A",
"Data" : {
"FaceId" : "5",
"QualitieScore" : 99.79581
}
}
錯誤碼
關于添加人臉數據的錯誤碼,詳情請參見常見錯誤碼。
安全聲明
- 請確保上傳的圖片或文件來源符合相應的法律法規。
- 通過體驗調試上傳的臨時文件有效期為1小時,在24小時后會被系統自動清理刪除。
- 平臺不存儲用戶在使用服務過程中涉及的原始人臉圖片或文件信息。
- 平臺針對超過6個月及以上沒有API服務調用的用戶的人臉特征向量數據進行凍結,確保無服務調用的客戶信息安全。如需解凍,請通過釘釘群(23109592)聯系我們。