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

Person Group Operations - Get Person Group

服务:

Azure AI Services

API 版本:

v1.2-preview.1

检索人员组名称、userData 和 recognitionModel。 若要获取此 personGroup 下的人员信息，请使用“获取人员组人员”。

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}

具有可选参数:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}?returnRecognitionModel={returnRecognitionModel}

URI 参数

名称	在	必需	类型	说明
apiVersion	path	True	string	API 版本
endpoint	path	True	string (uri)	支持的认知服务终结点（协议和主机名，例如：https://{resource-name}.cognitiveservices.azure.com）。
personGroupId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	容器的 ID。
returnRecognitionModel	query		boolean	返回“recognitionModel”或“not”。 默认值为 false。

响应

名称	类型	说明
200 OK	PersonGroup	成功的呼叫返回人员组的信息。
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 PersonGroup

示例请求

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id?returnRecognitionModel=True

示例响应

状态代码:

200

{
  "name": "your_person_group_name",
  "userData": "your_user_data",
  "recognitionModel": "recognition_01",
  "personGroupId": "your_person_group_id"
}

定义

名称	说明
FaceError	错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息，请参阅以下链接：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含错误详细信息的响应。
PersonGroup	上传的人员数据的容器，包括人脸识别功能，以及多达 10,000 人。 若要处理较大的人脸识别问题，请考虑使用大型人员组。
RecognitionModel	人脸的识别模型。

FaceError

Object

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

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

FaceErrorResponse

Object

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

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

PersonGroup

Object

上传的人员数据的容器，包括人脸识别功能，以及多达 10,000 人。 若要处理较大的人脸识别问题，请考虑使用大型人员组。

名称	类型	说明
name	string minLength: 1 maxLength: 128	用户定义的名称，最大长度为 128。
personGroupId	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	容器的 ID。
recognitionModel	RecognitionModel	识别模型的名称。 提取人脸特征并与检测到的 faceId 相关联时，将使用识别模型。
userData	string maxLength: 16384	可选用户定义数据。 长度不应超过 16K。

RecognitionModel

枚举

人脸的识别模型。

值	说明
recognition_01	“Detect”的默认识别模型。 2019 年 3 月之前创建的所有 faceId 都与此识别模型绑定在一起。
recognition_02	识别模型于 2019 年 3 月发布。
recognition_03	识别模型于 2020 年 5 月发布。
recognition_04	识别模型于 2021 年 2 月发布。 建议使用此识别模型来提高识别准确性。