Person Group Operations - Get Person Groups

Служба:

Azure AI Services

Версия API:

v1.1-preview.1

List Person Группы'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[]	При успешном вызове возвращается массив Группы person и его сведения (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.1-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 000.

RecognitionModel

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

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