Поделиться через

Face List Operations - Get Large Face List Faces

  • Ссылка
Служба:
Azure AI Services
Версия API:
v1.2-preview.1

Список лиц " сохраненныйFaceId и userData в указанном списке крупных лиц.
Лица хранятся в алфавитном порядке сохраняемогоFaceId, созданного в разделе "Добавление лица большого списка лиц".

    • Параметр 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}/largefacelists/{largeFaceListId}/persistedfaces
С использованием необязательных параметров: 
GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/persistedfaces?start={start}&top={top}

Параметры URI

Имя В Обязательно Тип Описание
apiVersion
 path True

string

Версия API
endpoint
 path True

string

uri

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).
largeFaceListId
 path True

string

Допустимый символ — буква в нижнем регистре или цифре или "-" или "_", максимальная длина составляет 64.

Шаблон регулярного выражения: ^[a-z0-9-_]+$
start
 query

string

Вывод списка ресурсов, превышающих "start". Он содержит не более 64 символов. Значение по умолчанию пусто.
top
 query

integer

int32

Число элементов для списка, начиная от [1, 1000]. Значение по умолчанию — 1000.

Ответы

Имя Тип Описание
200 OK

LargeFaceListFace[]

Успешный вызов возвращает массив сохраненных лиц и их сведения (сохраненныеFaceId и 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 Faces from LargeFaceList

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

GET {endpoint}/face/v1.2-preview.1/largefacelists/your_large_face_list_id/persistedfaces?start=00000000-0000-0000-0000-000000000000&top=20

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

Код состояния:
200 
[
  {
    "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
    "userData": "your_user_data"
  }
]

Определения

Имя Описание
FaceError

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

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

Ресурс распознавания лиц для большого списка лиц.

FaceError

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

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

string

Один из определяемых сервером кодов ошибок.
message

string

Читаемое пользователем представление ошибки.

FaceErrorResponse

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

Имя Тип Описание
error

FaceError

Объект ошибки.

LargeFaceListFace

Ресурс распознавания лиц для большого списка лиц.

Имя Тип Описание
persistedFaceId

string

Идентификатор лица.
userData

string

Предоставленные пользователем данные, подключенные к лицу. Ограничение длины равно 1K.