Person Group Operations - Get Person Group Persons

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Список всех лиц в указанной группе person, включая personId, имя, userData и сохраненные лица зарегистрированного лица.
Лица хранятся в алфавитном порядке personId, созданного в разделе "Create Person Group Person".

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия API
endpoint	path	True	string uri	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).
personGroupId	path	True	string	Идентификатор контейнера. Шаблон регулярного выражения: ^[a-z0-9-_]+$
start	query		string	Вывод списка ресурсов, превышающих "start". Он содержит не более 64 символов. Значение по умолчанию пусто.
top	query		integer int32	Число элементов для списка, начиная от [1, 1000]. Значение по умолчанию — 1000.

Ответы

Имя	Тип	Описание
200 OK	PersonGroupPerson[]	Успешный вызов возвращает массив сведений о человеке, принадлежащих группе person.
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 Persons from PersonGroup

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

HTTP

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

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

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

200

[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

Определения

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

FaceError

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

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

FaceErrorResponse

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

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

PersonGroupPerson

Пользователь в указанной группе пользователей. Чтобы добавить лицо к этому лицу, вызовите "Добавить лицо большого человека группы лиц".

Имя	Тип	Описание
name	string	Определяемое пользователем имя, максимальная длина — 128.
persistedFaceIds	string[]	Идентификаторы лиц зарегистрированных лиц в человеке.
personId	string	Идентификатор пользователя.
userData	string	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.