Person Group Operations - Create Person Group

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Создайте новую группу пользователей с указанным personGroupId, именем, предоставленным пользователем userData и recognitionModel.
Группа пользователей — это контейнер, содержащий переданные данные пользователя, включая функции распознавания лиц.

После создания используйте команду "Create Person Group Person" (Создать пользователя группы пользователей), чтобы добавить людей в группу, а затем вызвать "Train Person Group" (Обучение группы пользователей), чтобы подготовить эту группу к "Идентификация из группы пользователей".

Изображение не будет сохранено. Только извлеченные функции лица пользователя и userData будут храниться на сервере до тех пор, пока не будет вызван параметр Delete Person Group Person или Delete Person Group(Удалить группу лиц).

Для связи с этой группой пользователей необходимо указать "recognitionModel". Значение по умолчанию для "recognitionModel" равно "recognition_01", если требуется последняя модель, явно укажите нужную модель в этом параметре. Новые лица, добавленные в существующую группу лиц, будут использовать модель распознавания, которая уже связана с коллекцией. Существующие функции распознавания лиц в группе пользователей не могут быть обновлены до функций, извлеченных другой версией модели распознавания.

Заметка

• • Квота подписки на бесплатный уровень: 1000 групп пользователей. Каждый содержит до 1000 человек.
  • Квота подписки уровня S0: 1000 000 групп пользователей. Каждый содержит до 10 000 человек.
  • чтобы справиться с более крупномасштабной проблемой идентификации лиц, рекомендуется использовать группу крупных пользователей.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия API
endpoint	path	True	string uri	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).
personGroupId	path	True	string	Идентификатор контейнера. Шаблон регулярного выражения: ^[a-z0-9-_]+$

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Определяемое пользователем имя, максимальная длина — 128.
recognitionModel		RecognitionModel	Объект "recognitionModel", связанный с этим списком лиц. Поддерживаемые значения "recognitionModel" включают "recognition_01", "recognition_02", "recognition_03" и "recognition_04". Значение по умолчанию — "recognition_01". "recognition_04" рекомендуется, так как его точность улучшается на лицах носить маски по сравнению с "recognition_03", и его общая точность улучшается по сравнению с "recognition_01" и "recognition_02".
userData		string	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.

Ответы

Имя	Тип	Описание
200 OK		Запрос выполнен успешно.
Other Status Codes	FaceErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Секретный ключ для подписки Azure AI Face.

Тип: apiKey
В: header

AADToken

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://api.example.com/oauth2/authorize
URL-адрес токена: https://api.example.com/oauth2/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Create PersonGroup

Образец запроса

HTTP

PUT {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id

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

Пример ответа

Код состояния:

200

Определения

Имя	Описание
FaceError	Объект ошибки. Подробные сведения о кодах ошибок и сообщениях, возвращаемых службой распознавания лиц, см. по следующей ссылке: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ответ, содержащий сведения об ошибке.

FaceError

Объект ошибки. Подробные сведения о кодах ошибок и сообщениях, возвращаемых службой распознавания лиц, см. по следующей ссылке: https://aka.ms/face-error-codes-and-messages.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
message	string	Читаемое пользователем представление ошибки.

FaceErrorResponse

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	FaceError	Объект ошибки.