Person Group Person - Get

Служба:

Azure AI Services

Версия API:

1.0

Получение сведений о человеке, включая зарегистрированные сохраненные лица, имя и userData.

GET {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons/{personId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://westus.api.cognitive.microsoft.com).
personGroupId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	Идентификатор, ссылающийся на определенную группу пользователей.
personId	path	True	string (uuid)	Идентификатор, ссылающийся на определенного человека.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	Person	Успешный звонок возвращает сведения о человеке.
Other Status Codes	APIError	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Get person example

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

HTTP

GET {Endpoint}/face/v1.0/persongroups/abc/persons/25985303-c537-4467-b41d-bdb45cd95ca1

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

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

200

{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
  "persistedFaceIds": [
    "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
    "fce92aed-d578-4d2e-8114-068f8af4492e",
    "b64d5e15-8257-4af2-b20a-5a750f8940e7"
  ],
  "name": "Ryan",
  "userData": "User-provided data attached to the person."
}

Определения

Имя	Описание
APIError	Сведения об ошибках, возвращаемые API
Error	Текст ошибки.
Person	Объект Person.

APIError

Object

Сведения об ошибках, возвращаемые API

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

Error

Object

Текст ошибки.

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

Person

Object

Объект Person.

Имя	Тип	Описание
name	string maxLength: 128	Определяемое пользователем имя, максимальная длина — 128.
persistedFaceIds	string[] (uuid)	СохраненныеfaceIds зарегистрированных лиц в человеке. Эти сохраненныеfaceIds возвращаются из Person — добавление лица и не истекает срок действия.
personId	string (uuid)	PersonId целевого списка лиц.
userData	string maxLength: 16384	Указанные пользователем данные. Длина не должна превышать 16 КБ.