Person Group Operations - Get Person Group Person Face

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Получение сведений о лицах пользователей. Лицо сохраняемого пользователя указывается его personGroupId, personId и persistedFaceId.

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия API
endpoint	path	True	string uri	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).
persistedFaceId	path	True	string uuid	Идентификатор лица.
personGroupId	path	True	string	Идентификатор контейнера. Шаблон регулярного выражения: ^[a-z0-9-_]+$
personId	path	True	string uuid	Идентификатор пользователя.

Ответы

Имя	Тип	Описание
200 OK	PersonGroupPersonFace	Успешный вызов возвращает сведения о целевом объекте, сохраняемом лице (сохраненные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 Face form PersonGroup Person

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

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1/persistedfaces/43897a75-8d6f-42cf-885e-74832febb055

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

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

200

{
  "persistedFaceId": "43897a75-8d6f-42cf-885e-74832febb055",
  "userData": "your_user_data"
}

Определения

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

FaceError

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

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

FaceErrorResponse

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

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

PersonGroupPersonFace

Ресурс распознавания лиц для пользователя группы пользователей.

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