Person Directory Operations - Get Dynamic Person Groups

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Перечислить все существующие группы динамических пользователей по dynamicPersonGroupId вместе с именем и userData.
Группы dynamic Person хранятся в алфавитном порядке dynamicPersonGroupId.

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

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	DynamicPersonGroup[]	Успешный вызов возвращает массив динамических групп person и их сведения (dynamicPersonGroupId, 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 DynamicPersonGroups

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

HTTP

GET {endpoint}/face/v1.2-preview.1/dynamicpersongroups?start=dynamic_person_group_id&top=20

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

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

200

[
  {
    "dynamicPersonGroupId": "your_dynamic_person_group_id",
    "name": "your_dynamic_person_group_name",
    "userData": "your_user_data"
  }
]

Определения

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

DynamicPersonGroup

Object

Контейнер, ссылающийся на каталог Person "Create Person".

Имя	Тип	Описание
dynamicPersonGroupId	string minLength: 1 maxLength: 64 pattern: ^[a-z0-9-_]+$	Идентификатор группы динамических пользователей.
name	string minLength: 1 maxLength: 128	Определяемое пользователем имя, максимальная длина — 128.
userData	string maxLength: 16384	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.

FaceError

Object

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

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

FaceErrorResponse

Object

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

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