Large Person Group - Create

Создайте новую группу больших пользователей с указанным пользователем largePersonGroupId, именем, необязательным userData и recognitionModel.
Большая группа людей — это контейнер отправленных данных пользователя, включая функцию распознавания лиц, и до 1000 000 человек.
После создания используйте LargePersonGroup Person — создание , чтобы добавить пользователя в группу, и вызовите LargePersonGroup — Train , чтобы получить эту группу для подготовки к распознаванию лиц — определение.
Изображение не будет сохранено. Только извлеченные функции лица пользователя и userData будут храниться на сервере до вызова LargePersonGroup Person — Delete или LargePersonGroup — Delete .
Для связи с этой большой группой пользователей необходимо указать "recognitionModel". Значение по умолчанию для "recognitionModel" равно "recognition_01", если требуется последняя модель, явно укажите нужную модель в этом параметре. Новые лица, добавленные в существующую группу больших пользователей, будут использовать модель распознавания, которая уже связана с коллекцией. Существующие функции распознавания лиц в большой группе пользователей не могут быть обновлены до компонентов, извлеченных другой версией модели распознавания. См. раздел "Указание модели распознавания лиц".

Квота группы больших пользователей:

  • Квота подписки уровня "Бесплатный": 1000 больших групп пользователей.
  • Квота подписки уровня S0: 1000 000 больших групп пользователей.
PUT {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}

Параметры URI

Name In Required Type Description
Endpoint
path True
  • string

Поддерживаемые конечные точки Cognitive Services (например, https://westus.api.cognitive.microsoft.comпротокол и имя узла).

largePersonGroupId
path True
  • string

Идентификатор, ссылающийся на определенную группу больших пользователей.

Regex pattern: ^[a-z0-9-_]+$

Заголовок запроса

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

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

Name Required Type Description
name True
  • string

Определяемое пользователем имя, максимальная длина — 128.

recognitionModel

Имя модели распознавания. Модель распознавания используется, когда функции распознавания извлекаются и связаны с обнаруженными faceIds, (Large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении face — Detect or (Large)FaceList — Create or (Large)PersonGroup — Create. Значение по умолчанию — "recognition_01", если требуется последняя модель, явно укажите нужную модель.

userData
  • string

Указанные пользователем данные. Длина не должна превышать 16 КБ.

Ответы

Name Type Description
200 OK

Успешный вызов возвращает пустой текст ответа.

Other Status Codes

Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Create new large person group example

Sample Request

PUT {Endpoint}/face/v1.0/largepersongroups/abc


{
  "name": "large-person-group-name",
  "userData": "User-provided data attached to the large person group.",
  "recognitionModel": "recognition_01"
}

Sample Response

Определения

APIError

Сведения об ошибке, возвращаемые API

Error

Текст ошибки.

MetaDataContract

Сочетание определяемого пользователем имени и указанного пользователем имени данных и имени модели распознавания для largePersonGroup/personGroup и largeFaceList/faceList.

RecognitionModel

Имя модели распознавания. Модель распознавания используется, когда функции распознавания извлекаются и связаны с обнаруженными faceIds, (Large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении face — Detect or (Large)FaceList — Create or (Large)PersonGroup — Create. Значение по умолчанию — "recognition_01", если требуется последняя модель, явно укажите нужную модель.

APIError

Сведения об ошибке, возвращаемые API

Name Type Description
error

Текст ошибки.

Error

Текст ошибки.

Name Type Description
code
  • string
message
  • string

MetaDataContract

Сочетание определяемого пользователем имени и указанного пользователем имени данных и имени модели распознавания для largePersonGroup/personGroup и largeFaceList/faceList.

Name Type Default Value Description
name
  • string

Определяемое пользователем имя, максимальная длина — 128.

recognitionModel recognition_01

Имя модели распознавания. Модель распознавания используется, когда функции распознавания извлекаются и связаны с обнаруженными faceIds, (Large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении face — Detect or (Large)FaceList — Create or (Large)PersonGroup — Create. Значение по умолчанию — "recognition_01", если требуется последняя модель, явно укажите нужную модель.

userData
  • string

Указанные пользователем данные. Длина не должна превышать 16 КБ.

RecognitionModel

Имя модели распознавания. Модель распознавания используется, когда функции распознавания извлекаются и связаны с обнаруженными faceIds, (Large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении face — Detect or (Large)FaceList — Create or (Large)PersonGroup — Create. Значение по умолчанию — "recognition_01", если требуется последняя модель, явно укажите нужную модель.

Name Type Description
recognition_01
  • string
recognition_02
  • string
recognition_03
  • string
recognition_04
  • string