Face List Operations - Get Large Face List Face

服務:

Azure AI Services

API 版本:

v1.2-preview.1

依 largeFaceListId 和 persistedFaceId 擷取大型臉部清單中保存的臉部。

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
largeFaceListId	path	True	string	有效字元為小寫或數位或 '-' 或 '_'，最大長度為 64。 Regex 模式: ^[a-z0-9-_]+$
persistedFaceId	path	True	string uuid	臉部的臉部標識碼。

回應

名稱	類型	Description
200 OK	LargeFaceListFace	成功的呼叫會傳回目標保存臉部的資訊（persistedFaceId 和 userData）。
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

範例

Get Face from LargeFaceList

範例要求

HTTP

GET {endpoint}/face/v1.2-preview.1/largefacelists/your_large_face_list_id/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

範例回覆

狀態碼:

200

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

定義

名稱	Description
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
LargeFaceListFace	大型臉部清單的臉部資源。

FaceError

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

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

FaceErrorResponse

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

名稱	類型	Description
error	FaceError	error 物件。

LargeFaceListFace

大型臉部清單的臉部資源。

名稱	類型	Description
persistedFaceId	string	臉部的臉部標識碼。
userData	string	附加至臉部的使用者提供數據。 長度限制為 1K。