共用方式為


Person Group Operations - Get Person Group Person Face

擷取人員臉部資訊。 保存的人臉是由其personGroupId、personId和persistedFaceId所指定。

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}

URI 參數

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

string

API 版本

endpoint
path True

string

uri

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

persistedFaceId
path True

string

uuid

臉部的臉部標識碼。

personGroupId
path True

string

容器的標識碼。

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

personId
path True

string

uuid

人員的標識碼。

回應

名稱 類型 Description
200 OK

PersonGroupPersonFace

成功的呼叫會傳回目標保存臉部的資訊(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 form PersonGroup Person

範例要求

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

範例回覆

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

定義

名稱 Description
FaceError

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

FaceErrorResponse

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

PersonGroupPersonFace

人員群組人員的臉部資源。

FaceError

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

名稱 類型 Description
code

string

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

message

string

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

FaceErrorResponse

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

名稱 類型 Description
error

FaceError

error 物件。

PersonGroupPersonFace

人員群組人員的臉部資源。

名稱 類型 Description
persistedFaceId

string

臉部的臉部標識碼。

userData

string

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