Face Recognition Operations - Identify From Person Directory

服務:

Azure AI Services

API 版本:

v1.2-preview.1

從人員目錄 personIds 陣列中尋找特定查詢人員臉部最接近相符專案的 1 對多識別。
針對faceIds陣列中的每個臉部，臉部識別會計算查詢臉部與人員目錄人員（由personIds提供）中所有臉部的相似度，並傳回以相似度信賴等級的候選人員。 使用具有一個元素 「*」 的數位傳遞 personId 可以在整個人員目錄上執行作業。

注意

• • 演演算法允許在同一個要求中獨立識別多個臉部，但不超過10個臉部。
  • 每個人可以有多個臉部，但不超過 248 張臉。
  • 較高的臉部影像質量意味著更好的識別精確度。 請考慮高品質的臉部：正面、清晰和臉部大小為 200x200 像素（眼睛之間 100 像素）或更大。
  • 傳回的候選項目數目受限於 maxNumOfCandidatesReturned 和 confidenceThreshold。 如果未識別人員，傳回的候選專案將會是空陣列。
  • 識別作業只能比對與查詢臉部相關聯的相同辨識模型取得的臉部。

POST {endpoint}/face/{apiVersion}/identify

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。

要求本文

名稱	必要	類型	Description
faceIds	True	string[]	查詢臉部 faceIds 的陣列，由 「Detect」 所建立。 每個臉部都會獨立識別。 faceIds 的有效數目介於 [1， 10] 之間。
personIds	True	string[]	Person Directory 「Create Person」 中建立的 personId 陣列。 有效的 personId 數目介於 [1,30] 之間。
confidenceThreshold		number	自定義的識別信賴閾值，範圍為 [0， 1]。 進階使用者可以調整此值，以覆寫預設的內部閾值，以取得更精確的案例數據。 請注意，此臨界值無法保證在其他數據和演算法更新之後運作。
maxNumOfCandidatesReturned		integer	maxNumOfCandidatesReturned 的範圍介於 1 到 100 之間。 預設值為 10。

回應

名稱	類型	Description
200 OK	IdentificationResult[]	成功的呼叫會傳回每個查詢臉部的已識別候選人員。
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

範例

Identify from PersonDirectory

範例要求

HTTP

POST {endpoint}/face/v1.2-preview.1/identify

{
  "faceIds": [
    "c5c24a82-6845-4031-9d5d-978df9175426"
  ],
  "personIds": [
    "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
  ],
  "maxNumOfCandidatesReturned": 9,
  "confidenceThreshold": 0.7
}

範例回覆

狀態碼:

200

[
  {
    "faceId": "c5c24a82-6845-4031-9d5d-978df9175426",
    "candidates": [
      {
        "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
        "confidence": 0.8
      }
    ]
  }
]

定義

名稱	Description
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
IdentificationCandidate	識別通話的候選專案。
IdentificationResult	識別結果。

FaceError

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

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
message	string	錯誤的人類可讀取表示法。

FaceErrorResponse

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

名稱	類型	Description
error	FaceError	error 物件。

IdentificationCandidate

識別通話的候選專案。

名稱	類型	Description
confidence	number	候選專案的信心值。 信賴度越高，越相似。 範圍介於 [0,1]。
personId	string	personId 的候選人員。

IdentificationResult

識別結果。

名稱	類型	Description
candidates	IdentificationCandidate[]	該臉部的識別人員候選人（按信心排名）。 陣列大小不應大於輸入 maxNumOfCandidatesReturned。 如果未識別任何人員，則會傳回空陣列。
faceId	string	查詢臉部的faceId。