Person Group Operations - Create Person Group Person

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Создайте пользователя в указанной группе пользователей. Чтобы добавить лицо к этому лицу, вызовите "Добавить лицо группы пользователей".

Заметка

• • Квота подписки уровня "Бесплатный":
    • 1000 человек во всех группах пользователей.
  • Квота подписки уровня S0:
    • 10 000 человек на группу пользователей.
    • 1 000 000 групп пользователей.
    • 100 000 000 человек во всех группах лиц.

POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons

Параметры 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.
userData		string	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.

Ответы

Имя	Тип	Описание
200 OK	CreatePersonResult	Успешный вызов возвращает созданный идентификатор пользователя.
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 Person in PersonGroup

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

HTTP

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

{
  "name": "your_person_group_person_name",
  "userData": "your_user_data"
}

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

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

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
}

Определения

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

CreatePersonResult

Ответ на создание пользователя.

Имя	Тип	Описание
personId	string	Идентификатор пользователя.

FaceError

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

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

FaceErrorResponse

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

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