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


Liveness Session Operations - Get Liveness Session Result

Получение результата сеанса при вызове detectLiveness/singleModal.

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}

Параметры URI

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

string

Версия API

endpoint
path True

string

uri

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

sessionId
path True

string

Уникальный идентификатор для ссылки на этот сеанс.

Ответы

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

LivenessSession

Запрос выполнен успешно.

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 LivenessSession Result

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

GET {endpoint}/face/v1.1-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e

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

{
  "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "createdDateTime": "2024-03-05T11:07:29.698Z",
  "sessionStartDateTime": "2024-03-05T11:07:29.698Z",
  "sessionExpired": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 600,
  "status": "NotStarted",
  "result": {
    "id": 4,
    "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "requestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "clientRequestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "receivedDateTime": "2024-03-05T11:07:29.698Z",
    "request": {
      "url": "/face/v1.1-preview.1/detectliveness/singlemodal",
      "method": "POST",
      "contentLength": 18,
      "contentType": "multipart/form-data",
      "userAgent": "Mozilla/5.0 (Linux) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Mobile Safari/537.36"
    },
    "response": {
      "body": {},
      "statusCode": 200,
      "latencyInMilliseconds": 1200
    },
    "digest": "1CC98BA83EAF1D0FF7F566FAEFCCCC787819FFA01251E2D9299143F7AD6651DB"
  }
}

Определения

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

Запись аудита для ответа в сеансе.

AuditRequestInfo

Запись аудита для запроса в сеансе.

FaceError

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

FaceErrorResponse

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

FaceRectangle

Прямоугольник, в котором можно найти лицо.

FaceSessionStatus

Текущее состояние сеанса.

ImageType

Тип изображения.

LivenessDecision

Результат классификации активности.

LivenessModel

Версия модели, используемая для классификации активности.

LivenessOutputsTarget

Классификация активности для целевого лица.

LivenessResponseBody

Текст ответа вызова API обнаружения активности.

LivenessSession

Результат сеанса обнаружения активности.

LivenessSessionAuditEntry

Запись аудита для запроса в сеансе.

LivenessWithVerifyImage

Сведения о лице для проверки.

LivenessWithVerifyOutputs

Выходные данные проверки лица.

QualityForRecognition

Указывает качество изображения для распознавания.

AuditLivenessResponseInfo

Запись аудита для ответа в сеансе.

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

LivenessResponseBody

Текст ответа. Схема этого поля будет зависеть от значений request.url и request.method, используемых клиентом.

latencyInMilliseconds

integer

Сервер измеряет задержку для этого запроса в миллисекундах.

statusCode

integer

Код состояния HTTP, возвращенный клиенту.

AuditRequestInfo

Запись аудита для запроса в сеансе.

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

integer

Длина текста запроса в байтах.

contentType

string

Тип контента запроса.

method

string

Метод HTTP запроса (т. е. GET, POST, DELETE).

url

string

Относительный URL-адрес и запрос запроса на трансляцию.

userAgent

string

Агент пользователя, используемый для отправки запроса.

FaceError

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

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

string

Один из серверных наборов кодов ошибок.

message

string

Понятное представление ошибки.

FaceErrorResponse

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

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

FaceError

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

FaceRectangle

Прямоугольник, в котором можно найти лицо.

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

integer

Высота прямоугольника в пикселях.

left

integer

Расстояние от левого края изображения до левого края прямоугольника в пикселях.

top

integer

Расстояние от верхнего края изображения до верхнего края прямоугольника в пикселях.

width

integer

Ширина прямоугольника в пикселях.

FaceSessionStatus

Текущее состояние сеанса.

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

string

Сеанс не запущен.

ResultAvailable

string

Сеанс имеет доступный результат.

Started

string

Сеанс запущен.

ImageType

Тип изображения.

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

string

Цветное изображение.

Depth

string

Изображение глубины.

Infrared

string

Инфракрасное изображение.

LivenessDecision

Результат классификации активности.

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

string

Алгоритм классифицировал целевое лицо как реальное.

spoofface

string

Алгоритм классифицировал целевое лицо как подделку.

uncertain

string

Алгоритм не может классифицировать целевое лицо как реальное или поддельные.

LivenessModel

Версия модели, используемая для классификации активности.

Имя Тип Описание
2020-02-15-preview.01

string

2021-11-12-preview.03

string

2022-10-15-preview.04

string

2023-03-02-preview.05

string

LivenessOutputsTarget

Классификация активности для целевого лица.

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

FaceRectangle

Область лица, в которой была сделана классификация активности.

fileName

string

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

imageType

ImageType

Тип изображения, содержащий прямоугольник лица, на котором была сделана классификация активности.

timeOffsetWithinFile

integer

Смещение времени в файле кадра, содержащего прямоугольник лица, на котором была сделана классификация активности.

LivenessResponseBody

Текст ответа вызова API обнаружения активности.

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

LivenessDecision

Классификация активности для целевого лица.

modelVersionUsed

LivenessModel

Версия модели, используемая для классификации активности.

target

LivenessOutputsTarget

Конкретные целевые объекты, используемые для классификации активности.

verifyResult

LivenessWithVerifyOutputs

Выходные данные проверки лица. Доступно только в том случае, если запрос находится в режиме активности с проверкой.

LivenessSession

Результат сеанса обнаружения активности.

Имя Тип Default value Описание
authTokenTimeToLiveInSeconds

integer

600

Секунды, на которые должен длиться сеанс. Диапазон составляет от 60 до 86400 секунд. Значение по умолчанию — 600.

createdDateTime

string

Дата и время создания этого сеанса.

deviceCorrelationId

string

Уникальный guid для каждого устройства конечного пользователя. Это необходимо для обеспечения ограничения скорости и защиты от молотка. Если в этом запросе deviceCorrelationIdSetInClient имеет значение true, то параметр deviceCorrelationId должен иметь значение NULL.

id

string

Уникальный идентификатор для ссылки на этот сеанс.

result

LivenessSessionAuditEntry

Последний результат аудита сеанса заполняется только в том случае, если состояние == "ResultAvailable".

sessionExpired

boolean

Указывает, истек ли срок действия сеанса.

sessionStartDateTime

string

Дата и время запуска этого сеанса клиентом.

status

FaceSessionStatus

Текущее состояние сеанса.

LivenessSessionAuditEntry

Запись аудита для запроса в сеансе.

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

string

Уникальный идентификатор clientRequestId, отправляемый клиентом в заголовке client-request-id.

digest

string

Серверный вычисляемый дайджест для этого запроса. Если сообщаемый клиентом хэш отличается от хэша, рассчитанного на сервере, то целостность сообщений между клиентом и службой была скомпрометирована и результат не должен быть доверенным. Дополнительные сведения см. в руководствах по использованию этого значения для защиты комплексного решения.

id

integer

Уникальный идентификатор для ссылки на этот запрос аудита. Используйте этот идентификатор с параметром запроса start, чтобы перейти к следующей странице результатов аудита.

receivedDateTime

string

Дата и время в формате UTC, в которое был получен запрос.

request

AuditRequestInfo

Запрос этой записи.

requestId

string

Уникальный идентификатор запроса, возвращаемый службой клиенту в заголовке apim-request-id.

response

AuditLivenessResponseInfo

Ответ этой записи.

sessionId

string

Уникальный идентификатор сеанса созданного сеанса. Срок действия истекает через 48 часов после создания или может быть удален раньше с помощью соответствующей операции DELETE сеанса.

LivenessWithVerifyImage

Сведения о лице для проверки.

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

FaceRectangle

Область лица, в которой была сделана классификация изображения сравнения.

qualityForRecognition

QualityForRecognition

Качество изображения лица для распознавания.

LivenessWithVerifyOutputs

Выходные данные проверки лица.

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

boolean

Соответствует ли целевое лицо живой активности и сравнение лица изображения.

matchConfidence

number

Целевое лицо живости лица и сравнение достоверности проверки лица.

verifyImage

LivenessWithVerifyImage

Сведения о лице для проверки.

QualityForRecognition

Указывает качество изображения для распознавания.

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

string

Высокое качество.

low

string

Низкое качество.

medium

string

Среднее качество.