你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Person Group Operations - Create Person Group
使用指定的 personGroupId、名称、用户提供的 userData 和 recognitionModel 创建新的人员组。
人员组是包含上传的人员数据的容器,包括人脸识别功能。
创建后,使用“创建人员组人员”将人员添加到组中,然后调用“训练人员组”,使此组准备好“识别人员组”。
不会存储任何图像。 只有用户的提取人脸功能和 userData 才会存储在服务器上,直到调用“删除人员组人员”或“删除人员组”。
应指定“recognitionModel”以与此人员组关联。 “recognitionModel”的默认值为“recognition_01”,如果需要最新的模型,请显式指定此参数中所需的模型。 添加到现有人员组的新人脸将使用已与集合关联的识别模型。 无法将人员组中的现有人脸特征更新为另一版本的识别模型提取的功能。
注意
-
- 免费层订阅配额:1,000 个人员组。 每人最多容纳1000人。
- S0 层订阅配额:1,000,000 个人员组。 每人最多容纳10,000人。
- 若要处理较大的人脸识别问题,请考虑使用大型人员组。
PUT {endpoint}/face/{apiVersion}/persongroups/{personGroupId}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
api
|
path | True |
string |
API 版本 |
endpoint
|
path | True |
string uri |
支持的认知服务终结点(协议和主机名,例如:https://{resource-name}.cognitiveservices.azure.com)。 |
person
|
path | True |
string |
容器的 ID。 正则表达式模式: |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
name | True |
string |
用户定义的名称,最大长度为 128。 |
recognitionModel |
Recognition |
与此人脸列表关联的“recognitionModel”。 支持的“recognitionModel”值包括“recognition_01”、“recognition_02”、“recognition_03”和“recognition_04”。 默认值为“recognition_01”。 建议使用“recognition_04”,因为与“recognition_03”相比,其面部戴面具的准确性得到改善,并且与“recognition_01”和“recognition_02”相比,其整体准确性得到改善。 |
|
userData |
string |
可选用户定义数据。 长度不应超过 16K。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
请求已成功。 |
|
Other Status Codes |
意外的错误响应。 标头 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 |
示例
Create PersonGroup
示例请求
PUT {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id
{
"name": "your_person_group_name",
"userData": "your_user_data",
"recognitionModel": "recognition_01"
}
示例响应
定义
名称 | 说明 |
---|---|
Face |
错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息,请参阅以下链接:https://aka.ms/face-error-codes-and-messages。 |
Face |
包含错误详细信息的响应。 |
FaceError
错误对象。 有关人脸服务返回的错误代码和消息的综合详细信息,请参阅以下链接:https://aka.ms/face-error-codes-and-messages。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的错误代码集之一。 |
message |
string |
错误的人工可读表示形式。 |
FaceErrorResponse
包含错误详细信息的响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |