Person Group Operations - Get Person Groups

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

List Person Groups's personGroupId, name, userData и recognitionModel.
Группы пользователей хранятся в алфавитном порядке personGroupId.

• • Параметр start (string, необязательный) задает значение идентификатора, из которого возвращенные записи будут иметь более крупные идентификаторы на основе сравнения строк. При задании "start" значение пустого значения указывает, что записи должны быть возвращены начиная с первого элемента.
  • Параметр top (int, необязательный) определяет максимальное количество возвращаемых записей с ограничением до 1000 записей на вызов. Чтобы получить дополнительные записи, превышающие это ограничение, укажите "start" с идентификатором personId последней записи, возвращенной в текущем вызове.

Кончик

• Например, имеется всего 5 элементов с идентификаторами: itemId1, ..., itemId5.
  • "start=&top=" возвращает все 5 элементов.
  • "start=&top=2" возвращает "itemId1", "itemId2".
  • "start=itemId2&top=3" возвращает "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/persongroups

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

GET {endpoint}/face/{apiVersion}/persongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия API
endpoint	path	True	string uri	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).
returnRecognitionModel	query		boolean	Возвращает значение "recognitionModel" или нет. Значение по умолчанию — false.
start	query		string	Вывод списка ресурсов, превышающих "start". Он содержит не более 64 символов. Значение по умолчанию пусто.
top	query		integer int32	Число элементов для списка, начиная от [1, 1000]. Значение по умолчанию — 1000.

Ответы

Имя	Тип	Описание
200 OK	PersonGroup[]	Успешный вызов возвращает массив групп пользователей и их сведения (personGroupId, name и userData).
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 PersonGroups

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

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups?start=00000000-0000-0000-0000-000000000000&top=20&returnRecognitionModel=True

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

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

200

[
  {
    "name": "your_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "personGroupId": "your_person_group_id"
  }
]

Определения

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

FaceError

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

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

FaceErrorResponse

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

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

PersonGroup

Контейнер переданных данных пользователя, включая функцию распознавания лиц и до 10 000 человек. Чтобы справиться с более крупномасштабной проблемой идентификации лиц, рассмотрите возможность использования группы крупных пользователей.

Имя	Тип	Описание
name	string	Определяемое пользователем имя, максимальная длина — 128.
personGroupId	string	Идентификатор контейнера.
recognitionModel	RecognitionModel	Имя модели распознавания. Модель распознавания используется при извлечении признаков лица и сопоставлении с обнаруженными идентификаторами лиц.
userData	string	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.

RecognitionModel

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

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