Partilhar via


Liveness Session Operations - Get Liveness Session Result

Obtenha o resultado da sessão de detectLiveness/singleModal call.

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

Parâmetros do URI

Name Em Necessário Tipo Description
apiVersion
path True

string

Versão da API

endpoint
path True

string

uri

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://{resource-name}.cognitiveservices.azure.com).

sessionId
path True

string

O ID exclusivo para referenciar esta sessão.

Respostas

Name Tipo Description
200 OK

LivenessSession

O pedido foi bem-sucedido.

Other Status Codes

FaceErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

A chave secreta da sua subscrição do Azure AI Face.

Tipo: apiKey
Em: header

AADToken

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Âmbitos

Name Description
https://cognitiveservices.azure.com/.default

Exemplos

Get LivenessSession Result

Pedido de amostra

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

Resposta da amostra

{
  "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"
  }
}

Definições

Name Description
AuditLivenessResponseInfo

Entrada de auditoria para uma resposta na sessão.

AuditRequestInfo

Entrada de auditoria para um pedido na sessão.

FaceError

O objeto de erro. Para obter detalhes abrangentes sobre os códigos de erro e as mensagens devolvidas pelo Serviço Face, consulte a seguinte ligação: https://aka.ms/face-error-codes-and-messages.

FaceErrorResponse

Uma resposta que contém detalhes de erro.

FaceRectangle

Um retângulo no qual um rosto pode ser encontrado.

FaceSessionStatus

O estado atual da sessão.

ImageType

O tipo de imagem.

LivenessDecision

O resultado da classificação de liveness.

LivenessModel

A versão do modelo utilizada para a classificação de liveness.

LivenessOutputsTarget

A classificação de liveness para o rosto de destino.

LivenessResponseBody

O corpo de resposta da chamada à API de deteção de liveness.

LivenessSession

Resultado da sessão de deteção de liveness.

LivenessSessionAuditEntry

Entrada de auditoria para um pedido na sessão.

LivenessWithVerifyImage

O detalhe do rosto para verificação.

LivenessWithVerifyOutputs

O resultado da verificação facial.

QualityForRecognition

Indica a qualidade da imagem para reconhecimento.

AuditLivenessResponseInfo

Entrada de auditoria para uma resposta na sessão.

Name Tipo Description
body

LivenessResponseBody

O corpo da resposta. O esquema deste campo dependerá do request.url e do request.method utilizados pelo cliente.

latencyInMilliseconds

integer

O servidor mediu a latência para este pedido em milissegundos.

statusCode

integer

O código de estado HTTP foi devolvido ao cliente.

AuditRequestInfo

Entrada de auditoria para um pedido na sessão.

Name Tipo Description
contentLength

integer

O comprimento do corpo do pedido em bytes.

contentType

string

O tipo de conteúdo do pedido.

method

string

O método HTTP do pedido (ou seja, GET, POST, DELETE).

url

string

O URL relativo e a consulta do pedido de liveness.

userAgent

string

O agente de utilizador utilizado para submeter o pedido.

FaceError

O objeto de erro. Para obter detalhes abrangentes sobre os códigos de erro e as mensagens devolvidas pelo Serviço Face, consulte a seguinte ligação: https://aka.ms/face-error-codes-and-messages.

Name Tipo Description
code

string

Um dos conjuntos de códigos de erro definidos pelo servidor.

message

string

Uma representação legível por humanos do erro.

FaceErrorResponse

Uma resposta que contém detalhes de erro.

Name Tipo Description
error

FaceError

O objeto de erro.

FaceRectangle

Um retângulo no qual um rosto pode ser encontrado.

Name Tipo Description
height

integer

A altura do retângulo, em píxeis.

left

integer

A distância do limite esquerdo se a imagem estiver na margem esquerda do retângulo, em píxeis.

top

integer

A distância da margem superior se a imagem estiver na extremidade superior do retângulo, em píxeis.

width

integer

A largura do retângulo, em píxeis.

FaceSessionStatus

O estado atual da sessão.

Name Tipo Description
NotStarted

string

A sessão ainda não começou.

ResultAvailable

string

A sessão tem o resultado disponível.

Started

string

A sessão foi iniciada.

ImageType

O tipo de imagem.

Name Tipo Description
Color

string

Imagem de cor.

Depth

string

Imagem de profundidade.

Infrared

string

Imagem de infravermelhos.

LivenessDecision

O resultado da classificação de liveness.

Name Tipo Description
realface

string

O algoritmo classificou o rosto de destino como real.

spoofface

string

O algoritmo classificou o rosto de destino como uma spoof.

uncertain

string

O algoritmo não conseguiu classificar o rosto de destino como real ou spoof.

LivenessModel

A versão do modelo utilizada para a classificação de liveness.

Name Tipo Description
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

A classificação de liveness para o rosto de destino.

Name Tipo Description
faceRectangle

FaceRectangle

A região face na qual a classificação de liveness foi efetuada.

fileName

string

O nome do ficheiro que contém o retângulo facial onde a classificação de liveness foi efetuada.

imageType

ImageType

O tipo de imagem que contém o retângulo facial no qual a classificação de liveness foi efetuada.

timeOffsetWithinFile

integer

O desvio de tempo dentro do ficheiro da moldura que contém o retângulo facial onde a classificação de liveness foi efetuada.

LivenessResponseBody

O corpo de resposta da chamada à API de deteção de liveness.

Name Tipo Description
livenessDecision

LivenessDecision

A classificação de liveness para o rosto de destino.

modelVersionUsed

LivenessModel

A versão do modelo utilizada para a classificação de liveness.

target

LivenessOutputsTarget

Destinos específicos utilizados para a classificação de liveness.

verifyResult

LivenessWithVerifyOutputs

O resultado da verificação facial. Apenas disponível quando o pedido é dinâmico com a verificação.

LivenessSession

Resultado da sessão de deteção de liveness.

Name Tipo Default value Description
authTokenTimeToLiveInSeconds

integer

600

Segundos em que a sessão deve durar. O intervalo é de 60 a 86400 segundos. O valor predefinido é 600.

createdDateTime

string

DateTime quando esta sessão foi criada.

deviceCorrelationId

string

Guid exclusivo por cada dispositivo de utilizador final. Isto é para fornecer limitação de taxas e anti-martelação. Se "deviceCorrelationIdSetInClient" for verdadeiro neste pedido, este "deviceCorrelationId" tem de ser nulo.

id

string

O ID exclusivo para referenciar esta sessão.

result

LivenessSessionAuditEntry

O resultado da auditoria de sessão mais recente só foi preenchido se o estado == "Resultado Disponível".

sessionExpired

boolean

Se a sessão expirou ou não.

sessionStartDateTime

string

DateTime quando esta sessão foi iniciada pelo cliente.

status

FaceSessionStatus

O estado atual da sessão.

LivenessSessionAuditEntry

Entrada de auditoria para um pedido na sessão.

Name Tipo Description
clientRequestId

string

O clientRequestId exclusivo que é enviado pelo cliente no cabeçalho "client-request-id".

digest

string

O servidor calculou a digestão para este pedido. Se o resumo comunicado pelo cliente for diferente do resumo calculado do servidor, a integridade da mensagem entre o cliente e o serviço foi comprometida e o resultado não deve ser fidedigno. Para obter mais informações, veja como guias sobre como tirar partido deste valor para proteger a sua solução ponto a ponto.

id

integer

O ID exclusivo para fazer referência a este pedido de auditoria. Utilize este ID com o parâmetro de consulta "iniciar" para continuar para a página seguinte dos resultados da auditoria.

receivedDateTime

string

O DATETime UTC que o pedido foi recebido.

request

AuditRequestInfo

O pedido desta entrada.

requestId

string

O requestId exclusivo que é devolvido pelo serviço ao cliente no cabeçalho "apim-request-id".

response

AuditLivenessResponseInfo

A resposta desta entrada.

sessionId

string

O sessionId exclusivo da sessão criada. Expirará 48 horas depois de ter sido criado ou poderá ser eliminado mais cedo através da operação DELETE da sessão correspondente.

LivenessWithVerifyImage

O detalhe do rosto para verificação.

Name Tipo Description
faceRectangle

FaceRectangle

A região face onde a classificação da imagem de comparação foi efetuada.

qualityForRecognition

QualityForRecognition

Qualidade da imagem facial para reconhecimento.

LivenessWithVerifyOutputs

O resultado da verificação facial.

Name Tipo Description
isIdentical

boolean

Se o rosto de liveness de destino e a imagem de comparação correspondem.

matchConfidence

number

O rosto de cara de destino e a comparação da imagem enfrentam a confiança da verificação.

verifyImage

LivenessWithVerifyImage

O detalhe do rosto para verificação.

QualityForRecognition

Indica a qualidade da imagem para reconhecimento.

Name Tipo Description
high

string

De alta qualidade.

low

string

Baixa qualidade.

medium

string

Qualidade média.