Face List Operations - Get Face List

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Получите faceListId списка лиц, имя, userData, распознавание лиц и лица в списке лиц.

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

С использованием необязательных параметров:

GET {endpoint}/face/{apiVersion}/facelists/{faceListId}?returnRecognitionModel={returnRecognitionModel}

Параметры URI

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

Ответы

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

Примеры

Get FaceList

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

HTTP

GET {endpoint}/face/v1.2-preview.1/facelists/your_face_list_id?returnRecognitionModel=True

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

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

200

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

Определения

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

FaceError

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

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

FaceErrorResponse

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

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

FaceList

Список лиц — это список лиц, до 1000 лиц.

Имя	Тип	Описание
faceListId	string	Допустимый символ — буква в нижнем регистре или цифре или "-" или "_", максимальная длина составляет 64.
name	string	Определяемое пользователем имя, максимальная длина — 128.
persistedFaces	FaceListFace[]	Идентификаторы лиц зарегистрированных лиц в списке лиц.
recognitionModel	RecognitionModel	Имя модели распознавания. Модель распознавания используется при извлечении признаков лица и сопоставлении с обнаруженными идентификаторами лиц.
userData	string	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.

FaceListFace

Ресурс распознавания лиц для списка лиц.

Имя	Тип	Описание
persistedFaceId	string	Идентификатор лица.
userData	string	Предоставленные пользователем данные, подключенные к лицу. Ограничение длины равно 1K.

RecognitionModel

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

Имя	Тип	Описание
recognition_01	string	Модель распознавания по умолчанию для "Обнаружение". Все эти лица, созданные до марта 2019 года, связаны с этой моделью распознавания.
recognition_02	string	Модель распознавания выпущена в марте 2019 года.
recognition_03	string	Модель распознавания выпущена в мае 2020 года.
recognition_04	string	Модель распознавания, выпущенная в феврале 2021 года. Рекомендуется использовать эту модель распознавания для повышения точности распознавания.