Large Person Group - List

Служба:

Azure AI Services

Версия API:

1.0

Перечислить все существующие группы больших пользователей в больших группахPersonGroupId, имя, userData и recognitionModel.

• Группы больших пользователей хранятся в алфавитном порядке largePersonGroupId.
• Параметр start (string, необязательный) — это предоставленное пользователем значение largePersonGroupId, которое возвращаемые записи имеют более крупные идентификаторы по сравнению со строками. Для параметра start задано пустое значение, указывающее возврат из первого элемента.
• Параметр top (int, необязательный) указывает количество возвращаемых записей. Максимальное количество записей в 1000 можно вернуть в одном вызове. Чтобы получить дополнительные сведения, можно указать "start" с идентификатором последней возвращаемой записи текущего вызова.
  Например, всего 5 больших групп пользователей: "group1", ..., "group5".
  "start=&top=" возвращает все 5 групп.
  "start=&top=2" возвращает "group1", "group2".
  "start=group2&top=3" возвращает "group3", "group4", "group5".

GET {Endpoint}/face/v1.0/largepersongroups

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

GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://westus.api.cognitive.microsoft.com).
returnRecognitionModel	query		boolean	Значение, указывающее, должна ли операция возвращать "recognitionModel" в ответ.
start	query		string maxLength: 64	Вывод списка групп больших пользователей из наименьшего размераPersonGroupId, превышающего "start".
top	query		integer minimum: 1 maximum: 1000	Количество групп больших пользователей, которые нужно перечислить.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	LargePersonGroup[]	Успешный вызов возвращает массив больших групп пользователей и их информацию.
Other Status Codes	APIError	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

List large person groups example

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

HTTP

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

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

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

200

[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

Определения

Имя	Описание
APIError	Сведения об ошибках, возвращаемые API
Error	Текст ошибки.
LargePersonGroup	Объект группы больших пользователей.
RecognitionModel	Имя модели распознавания. Модель распознавания используется, когда функции лица извлекаются и связаны с обнаруженными faceIds, (large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении распознавания лиц — обнаружение или (крупный)FaceList — создание или (большое)PersonGroup — создание. Значение по умолчанию — "recognition_01", если требуется последняя модель, явно укажите нужную модель.

APIError

Object

Сведения об ошибках, возвращаемые API

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

Error

Object

Текст ошибки.

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

LargePersonGroup

Object

Объект группы больших пользователей.

Имя	Тип	Default value	Описание
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		LargePersonGroupId целевых групп больших пользователей
name	string minLength: 1 maxLength: 128		Определяемое пользователем имя, максимальная длина — 128.
recognitionModel	RecognitionModel	recognition_01	Имя модели распознавания. Модель распознавания используется, когда функции лица извлекаются и связаны с обнаруженными faceIds, (large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении распознавания лиц — обнаружение или (крупный)FaceList — создание или (большое)PersonGroup — создание. Значение по умолчанию — "recognition_01", если требуется последняя модель, явно укажите нужную модель.
userData	string maxLength: 16384		Указанные пользователем данные. Длина не должна превышать 16 КБ.

RecognitionModel

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

Имя модели распознавания. Модель распознавания используется, когда функции лица извлекаются и связаны с обнаруженными faceIds, (large)FaceList или (Large)PersonGroup. Имя модели распознавания можно указать при выполнении распознавания лиц — обнаружение или (крупный)FaceList — создание или (большое)PersonGroup — создание. Значение по умолчанию — "recognition_01", если требуется последняя модель, явно укажите нужную модель.

Значение	Описание
recognition_01
recognition_02
recognition_03
recognition_04