Person Group Operations - Get Person Group Person

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Извлеките имя пользователя и userData, а также сохраненные идентификаторы лиц, представляющие функции лиц зарегистрированного пользователя.

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	PersonGroupPerson	Успешный звонок возвращает сведения о человеке.
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 Person from PersonGroup

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

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons/25985303-c537-4467-b41d-bdb45cd95ca1

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

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

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

Object

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

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

FaceErrorResponse

Object

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

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

PersonGroupPerson

Object

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

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