共用方式為


Person Group Operations - Add Person Group Person Face

將臉部新增至人員群組,以進行臉部識別或驗證。
若要處理包含多個臉部的影像,輸入臉部可以指定為具有 targetFace 矩形的影像。 它會傳回代表新增臉部的persistedFaceId。 不會儲存任何映像。 只有 () 擷取的臉部功能會儲存在伺服器上,直到呼叫「刪除人員群組人員」、「刪除人員群組人員」或「刪除人員群組」為止。

請注意,persistedFaceId 與 「Detect」 所產生的 faceId 不同。

    • 較高的臉部影像品質表示更好的辨識精確度。 請考慮高品質的臉部:正面、清楚和臉部大小為 200x200 像素, (眼睛之間 100 像素) 或更大。
    • 每個人員專案最多可以保留 248 個臉部。
    • 支援 JPEG、PNG、GIF (第一個畫面格) 和 BMP 格式。 允許的映像檔大小從 1 KB 到 6MB。
    • “targetFace” 矩形應該包含一個臉部。 零或多個臉部會被視為錯誤。 如果提供的 「targetFace」 矩形未從 「Detect」 傳回,則不保證可以偵測並成功新增臉部。
    • 無法偵測到的臉部大小 (36x36 - 4096x4096 像素) 、大型頭部姿勢或大型遮蔽會造成失敗。
    • 影像中可偵測的臉部大小下限為 36x36 像素,不超過 1920x1080 圖元。 維度高於 1920x1080 像素的影像需要比例較大的最小臉部大小。
    • 您可以提供不同的 'detectionModel' 值。 若要使用和比較不同的偵測模型,請參閱 https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model
POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}/persistedfaces
POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}/persistedfaces?_overload=addPersonGroupPersonFace&targetFace={targetFace}&detectionModel={detectionModel}&userData={userData}

URI 參數

名稱 位於 必要 類型 Description
apiVersion
path True

string

API 版本

endpoint
path True

string

uri

支持的認知服務端點 (通訊協定和主機名,例如:https://{resource-name}.cognitiveservices.azure.com) 。

personGroupId
path True

string

容器的標識碼。

Regex 模式: ^[a-z0-9-_]+$

personId
path True

string

uuid

人員的標識碼。

detectionModel
query

DetectionModel

與偵測到的faceIds相關聯的 'detectionModel'。 支援的 'detectionModel' 值包括 'detection_01'、'detection_02' 和 'detection_03'。 預設值為 『detection_01』。

targetFace
query

integer[]

要新增目標臉部的臉部矩形,格式為 'targetFace=left,top,width,height'。

userData
query

string

附加至臉部的使用者提供數據。 大小限制為 1K。

要求本文

Media Types: "application/octet-stream"

名稱 類型 Description
imageContent

string

要分析的影像

回應

名稱 類型 Description
200 OK

AddFaceResult

成功的呼叫會傳回新的persistedFaceId。

Other Status Codes

FaceErrorResponse

非預期的錯誤回應。

標題

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 臉部訂用帳戶的秘密密鑰。

類型: apiKey
位於: header

AADToken

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://api.example.com/oauth2/authorize
權杖 URL: https://api.example.com/oauth2/token

範圍

名稱 Description
https://cognitiveservices.azure.com/.default

範例

Add Face to PersonGroup Person

範例要求

POST {endpoint}/face/v1.1-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1/persistedfaces?_overload=addPersonGroupPersonFace&targetFace=10,10,100,100&detectionModel=detection_01&userData=your_user_data

"<your-image-bytes-here>"

範例回覆

{
  "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055"
}

定義

名稱 Description
AddFaceResult

用於新增臉部的回應本文。

DetectionModel

與偵測到的faceIds相關聯的 'detectionModel'。 支援的 'detectionModel' 值包括 'detection_01'、'detection_02' 和 'detection_03'。 預設值為 『detection_01』。

FaceError

error 物件。 如需臉部服務所傳回之錯誤碼和訊息的完整詳細數據,請參閱下列連結: https://aka.ms/face-error-codes-and-messages

FaceErrorResponse

包含錯誤詳細數據的回應。

AddFaceResult

用於新增臉部的回應本文。

名稱 類型 Description
persistedFaceId

string

已新增臉部的保存臉部標識碼,該標識符會保存且不會過期。 不同於在 「偵測」中建立的faceId,會在偵測呼叫之後24小時內到期。

DetectionModel

與偵測到的faceIds相關聯的 'detectionModel'。 支援的 'detectionModel' 值包括 'detection_01'、'detection_02' 和 'detection_03'。 預設值為 『detection_01』。

名稱 類型 Description
detection_01

string

默認偵測模型。 建議用於近端臉部偵測。 對於具有極大型角度的案例, (頭部姿勢) 臉部、遮蔽臉部或錯誤的影像方向,可能無法偵測到這類情況下的臉部。

detection_02

string

2019年5月發行的偵測模型已改善精確度,特別是在小型、側邊和模糊的臉部上。

detection_03

string

2021年2月發行的偵測模型已改善精確度,特別是在小臉上。

FaceError

error 物件。 如需臉部服務所傳回之錯誤碼和訊息的完整詳細數據,請參閱下列連結: https://aka.ms/face-error-codes-and-messages

名稱 類型 Description
code

string

其中一組伺服器定義的錯誤碼。

message

string

人類可讀取的錯誤表示法。

FaceErrorResponse

包含錯誤詳細數據的回應。

名稱 類型 Description
error

FaceError

error 物件。