是否戴口罩識別
更新時間 2025-09-18 17:44:05
最近更新時間: 2025-09-18 17:44:05
分享文章
接口描述
用于檢測輸入圖像中的人臉是否戴口罩。
請求方法
POST
接口要求
- 圖片大小限制:圖片單張大小小于2MB。
- 圖片格式限制:圖片格式支持jpg/jpeg/png/bmp格式。
URI
/v1/aiop/api/2f6hycj3a9z4/face/PERSON/person/detectMaskFromBase64
請求參數
1.請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | json格式 | application/json | |
| appkey | 是 | String | 平臺應用appkey | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用戶請求 id,由用戶構造,用戶可以通過 uuid 等方法自行生成唯一字符串,用于日志請求追蹤。 詳見文檔:Python3調用示例 |
33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 請求時間,由用戶構造,形如 yyyymmddTHHMMSSZ。 詳見文檔:Python3調用示例 |
20211221T163014Z | |
| host | 是 | String | 終端節點域名,固定字段 | ai-global.ctapi.daliqc.cn | |
| Eop-Authorization | 是 | String | 由天翼云官網 accessKey 和 securityKey 經簽名后生成,參與簽名生成的字段包括天翼云官網 accessKey 、securityKey、平臺應用的appkey(非必須),用戶請求id(非必須),請求時間,終端節點域名(非必須)以及請求體內容。 簽名邏輯詳見文檔:認證鑒權和Python3調用示例 |
2.請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| imageContent | 是 | String | 傳入圖片的base64編碼,圖片使用常規的base64編碼方式,編碼后,不包含前綴,剔除前綴例如“data:image/jpeg;base64,” | - |
請求代碼示例
Curl -X POST "//ai-global.ctapi.daliqc.cn/v1/aiop/api/2f6hycj3a9z4/face/PERSON/person/detectMaskFromBase64"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "appkey:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:ai-global.ctapi.daliqc.cn"
--data '{"imageContent":"AAAAAAAAA...."}'
返回值說明
1.請求成功返回響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 返回狀態,返回 0 表示成功,返回錯誤代碼參考下面的錯誤代碼列表。 | 0 | |
| message | 是 | String | 如果 code 為 0,返回 success;如果 code 非 0,則返回對應的可讀錯誤信息。 | success | |
| returnObj | 是 | Object | 返回的是否戴口罩識別結果對象 | returnObj |
2.表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| face_num | 是 | Int | 圖片中人臉的數量 | - | |
| face_list | 是 | List | 每個人臉的詳細信息 | - | |
| face_list[].face_location | 是 | Map | 人臉所處位置 | - | |
| face_list[].Mask | 是 | Bool | 是否佩戴口罩 | - |
3.請求失敗返回響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 錯誤碼,放置API對應的錯誤碼 | 4101 | |
| message | 是 | String | 返回對應的錯誤信息 | 請求內容錯誤 | |
| details | 是 | String | 返回對應的錯誤描述 | 傳入內容為空,或者傳入的參數名錯誤 | |
| error | 是 | String | 返回對應的錯誤碼 | AI_OP_4101 |
返回值示例
1.請求成功返回值示例
{
"statusCode": 0,
"message": "success",
"returnObj":{
"face_num" : 1,
"face_list" : [{
"face_location" : {
"top" : 36,
"left" : 48,
"width" : 58,
"height" : 72
},
"Mask" : false
}]
}
}
2.請求失敗返回值示例
{
'code': 4101, 'message': '請求內容錯誤',
'details': '傳入內容為空,或者傳入的參數名錯誤',
'statusCode': 4101, 'error': 'AI_OP_4101'
}
狀態碼
| http狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功 |
錯誤碼說明
4 位錯誤碼,4 開頭為業務錯誤碼,5 開頭為服務錯誤碼。
| 錯誤碼 | 錯誤信息 | 錯誤描述 |
|---|---|---|
| AI_OP_4101 | 請求內容錯誤 | 傳入內容為空,或者傳入的參數名錯誤 |
| AI_OP_4102 | 請求參數格式錯誤 | 參數格式不滿足要求,如請求參數字段類型錯誤等 |
| AI_OP_4103 | 圖片大小超過2M | 圖片大小超過2M |
| AI_OP_4104 | 圖片解碼失敗 | 圖片為空,base64編碼內容有誤,或圖片格式不支持 |
| AI_OP_4105 | 未檢測到人臉 | 上傳圖片中不包含人臉 |
base64 編碼規則:使用常規的 safe base64 編碼方式
- python 中推薦使用
base64.urlsafe_b64encode()函數進行編碼。 - java 中推薦使用
BASE64.getUrlEncoder().encodeToString()函數進行編碼。