Поделиться через

Face List Operations - Create Face List

Служба:
Azure AI Services
Версия API:
v1.2

Создайте пустой список лиц с указанным пользователем faceListId, именем, необязательным пользователемData и recognitionModel.
В одной подписке разрешено до 64 списков лиц.

Список лиц — это список лиц, до 1000 лиц и используемый параметром "Найти похожий из списка лиц".

После создания пользователь должен использовать "Добавить лицо списка лиц" для импорта лиц. Изображение не будет сохранено. Только извлеченные функции лиц будут храниться на сервере до вызова "Удалить список лиц".

"Найти аналогичный" используется для сценария, как поиск знаменитостей, похожих на фильтрацию лиц, или как легкий способ идентификации лиц. Но если фактическое использование предназначено для идентификации человека, используйте группу пользователей / группу крупных пользователей и "Определить".

Учитывайте большой список лиц, если число лиц большое. Она может поддерживать до 1000 000 лиц.

PUT {endpoint}/face/{apiVersion}/facelists/{faceListId}

Параметры URI

Имя В Обязательно Тип Описание
apiVersion
 path True

string

Версия API
endpoint
 path True

string (uri)

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).
faceListId
 path True

string

minLength: 1
maxLength: 64
pattern: ^[a-z0-9-_]+$

Допустимый символ — буква в нижнем регистре или цифре или "-" или "_", максимальная длина составляет 64.

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

Имя Обязательно Тип Описание
name True

string

minLength: 1
maxLength: 128

Определяемое пользователем имя, максимальная длина — 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

maxLength: 16384

Необязательные пользовательские данные. Длина не должна превышать 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 FaceList

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

PUT {endpoint}/face/v1.2/facelists/your_face_list_id

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

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

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

Определения

Имя Описание
CreateCollectionRequest

Модель создания коллекции лиц.
FaceError

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

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

Модель распознавания лица.

CreateCollectionRequest

Object

Модель создания коллекции лиц.

Имя Тип Default value Описание
name

string

minLength: 1
maxLength: 128

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

RecognitionModel

recognition_01

Объект "recognitionModel", связанный с этим списком лиц. Поддерживаемые значения "recognitionModel" включают "recognition_01", "recognition_02", "recognition_03" и "recognition_04". Значение по умолчанию — "recognition_01". "recognition_04" рекомендуется, так как его точность улучшается на лицах носить маски по сравнению с "recognition_03", и его общая точность улучшается по сравнению с "recognition_01" и "recognition_02".
userData

string

maxLength: 16384

Необязательные пользовательские данные. Длина не должна превышать 16 КБ.

FaceError

Object

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

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
message

string

Читаемое пользователем представление ошибки.

FaceErrorResponse

Object

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

Имя Тип Описание
error

FaceError

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

RecognitionModel

Перечисление

Модель распознавания лица.

Значение Описание
recognition_01

Модель распознавания по умолчанию для "Обнаружение". Все эти лица, созданные до марта 2019 года, связаны с этой моделью распознавания.
recognition_02

Модель распознавания выпущена в марте 2019 года.
recognition_03

Модель распознавания выпущена в мае 2020 года.
recognition_04

Модель распознавания, выпущенная в феврале 2021 года. Рекомендуется использовать эту модель распознавания для повышения точности распознавания.