Person Group Operations - Get Large Person Groups

Служба:

Azure AI Services

Версия API:

v1.1-preview.1

Перечислить все существующие крупные Группы largePersonGroupId, name, userData и recognitionModel.
Группы large Person хранятся в алфавитном порядке largePersonGroupId.

• • Параметр 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}/largepersongroups

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

GET {endpoint}/face/{apiVersion}/largepersongroups?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	LargePersonGroup[]	При успешном вызове возвращается массив Группы больших пользователей и их сведения (largePersonGroupId, 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 LargePersonGroups

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

HTTP

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

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

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

200

[
  {
    "name": "your_large_person_group_name",
    "userData": "your_user_data",
    "recognitionModel": "recognition_01",
    "largePersonGroupId": "your_large_person_group_id"
  }
]

Определения

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

FaceError

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

Имя	Тип	Описание
code	string	Один из определяемого сервером набора кодов ошибок.
message	string	Удобочитаемое представление ошибки.

FaceErrorResponse

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

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

LargePersonGroup

Контейнер отправленных данных пользователя, включая функцию распознавания лиц, и до 1 000 000 человек.

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

RecognitionModel

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

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