Large Face List - Create

Ссылка

Service:: Cognitive Services - Face

API Version:: 1.0

Создайте пустой большой список лиц с указанным пользователем largeFaceListId, именем, необязательным userData и recognitionModel.
Большой список лиц — это список лиц, до 1000 000 лиц и используемый face - Find Similar.
После создания пользователь должен использовать largeFaceList Face - Add to import the face and LargeFaceList - Train to make it ready for Face - Find Similar. Изображение не будет сохранено. Только извлеченные функции распознавания лиц хранятся на сервере до вызова LargeFaceList — Delete .
Поиск похожих используется для сценария, например поиска лиц знаменитости, аналогичной фильтрации лиц или в качестве легкого способа идентификации лиц. Но если фактическое использование заключается в идентификации человека, используйте PersonGroup / LargePersonGroup и Face - Identify.
Для связи с этим большим списком лиц необходимо указать "recognitionModel". Значение по умолчанию для "recognitionModel" равно "recognition_01", если требуется последняя модель, явно укажите нужную модель в этом параметре. Новые лица, добавленные в существующий большой список лиц, будут использовать модель распознавания, которая уже связана с коллекцией. Существующие функции распознавания лиц в большом списке лиц не могут быть обновлены до компонентов, извлеченных другой версией модели распознавания. См. раздел "Указание модели распознавания".

Квота на список лиц большого размера:

Квота подписки на бесплатный уровень: 64 больших списка лиц.
Квота подписки уровня S0: 1000 000 больших списков лиц.

PUT {Endpoint}/face/v1.0/largefacelists/{largeFaceListId}

Параметры URI

Name In Required Type Description

Name	In	Required	Type	Description
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (например, https://westus.api.cognitive.microsoft.comпротокол и имя узла).
largeFaceListId	path	True	string	Идентификатор, ссылающийся на определенный большой список лиц. Regex pattern: `^[a-z0-9-_]+$`

Endpoint

path

True

string

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

largeFaceListId

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		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	APIError	Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Create new large face list example

Sample Request

HTTP

PUT {Endpoint}/face/v1.0/largefacelists/sample_face_list


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

Sample Response

Status code:: 200

Определения

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	Текст ошибки.

Error

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

Name	Type	Description
code	string
message	string

MetaDataContract

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

Name	Type	Default Value	Description
name	string		Определяемое пользователем имя, максимальная длина — 128.
recognitionModel	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