你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Person Directory Operations - Get Person

服务:

Azure AI Services

API 版本:

v1.2-preview.1

从 Person Directory 检索人员的姓名和 userData。

GET {endpoint}/face/{apiVersion}/persons/{personId}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的认知服务终结点（协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com）。
personId	path	True	string uuid	人员的人员 ID。

响应

名称	类型	说明
200 OK	PersonDirectoryPerson	成功的呼叫返回人员的信息。
Other Status Codes	FaceErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 人脸订阅的密钥。

类型: apiKey
在: header

AADToken

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://api.example.com/oauth2/authorize
令牌 URL: https://api.example.com/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Get Person from PeronDirectory

示例请求

HTTP

GET {endpoint}/face/v1.2-preview.1/persons/85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5

示例响应

状态代码:

200

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5",
  "name": "your_person_name",
  "userData": "your_user_data"
}

定义

名称	说明
FaceError	错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。
PersonDirectoryPerson	人员目录的人员资源

FaceError

错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
message	string	错误的人工可读表示形式。

FaceErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	FaceError	错误对象。

PersonDirectoryPerson

人员目录的人员资源

名称	类型	说明
name	string	用户定义的名称，最大长度为 128。
personId	string	人员的人员 ID。
userData	string	可选用户定义数据。 长度不应超过 16K。