Liveness Session Operations - Get Liveness Session Result
Obter o resultado da sessão da chamada detectLiveness/singleModal.
GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
api
|
path | True |
string |
Versão da API |
endpoint
|
path | True |
string uri |
Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://{resource-name}.cognitiveservices.azure.com). |
session
|
path | True |
string |
A ID exclusiva para fazer referência a esta sessão. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A solicitação foi bem-sucedida. |
|
Other Status Codes |
Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string |
Segurança
Ocp-Apim-Subscription-Key
A chave secreta para sua assinatura do Azure AI Face.
Tipo:
apiKey
Em:
header
AADToken
O fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://api.example.com/oauth2/authorize
URL do Token:
https://api.example.com/oauth2/token
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemplos
Get LivenessSession Result
Solicitação de exemplo
GET {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e
Resposta de exemplo
{
"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.2-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
Nome | Description |
---|---|
Audit |
Entrada de auditoria para uma resposta na sessão. |
Audit |
Entrada de auditoria para uma solicitação na sessão. |
Face |
O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Serviço de Detecção Facial, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages. |
Face |
Uma resposta que contém detalhes do erro. |
Face |
Um retângulo no qual um rosto pode ser encontrado. |
Face |
O status atual da sessão. |
Image |
O tipo de imagem. |
Liveness |
O resultado da classificação de vida útil. |
Liveness |
A versão do modelo usada para a classificação de dinâmica. |
Liveness |
A classificação de dinâmica para o rosto de destino. |
Liveness |
O corpo da resposta da chamada à API de detecção de atividade. |
Liveness |
Resultado da sessão de detecção de vida. |
Liveness |
Entrada de auditoria para uma solicitação na sessão. |
Liveness |
O detalhe da face para verificação. |
Liveness |
A saída de verificação facial. |
Quality |
Indica a qualidade da imagem para reconhecimento. |
AuditLivenessResponseInfo
Entrada de auditoria para uma resposta na sessão.
Nome | Tipo | Description |
---|---|---|
body |
O corpo da resposta. O esquema desse campo dependerá do request.url e do request.method usados pelo cliente. |
|
latencyInMilliseconds |
integer |
O servidor mediu a latência dessa solicitação em milissegundos. |
statusCode |
integer |
O código de status HTTP retornado ao cliente. |
AuditRequestInfo
Entrada de auditoria para uma solicitação na sessão.
Nome | Tipo | Description |
---|---|---|
contentLength |
integer |
O comprimento do corpo da solicitação em bytes. |
contentType |
string |
O tipo de conteúdo da solicitação. |
method |
string |
O método HTTP da solicitação (ou seja, GET, POST, DELETE). |
url |
string |
A URL relativa e a consulta da solicitação de vida útil. |
userAgent |
string |
O agente de usuário usado para enviar a solicitação. |
FaceError
O objeto de erro. Para obter detalhes abrangentes sobre códigos de erro e mensagens retornadas pelo Serviço de Detecção Facial, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
message |
string |
Uma representação legível pelo ser humano do erro. |
FaceErrorResponse
Uma resposta que contém detalhes do erro.
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
FaceRectangle
Um retângulo no qual um rosto pode ser encontrado.
Nome | Tipo | Description |
---|---|---|
height |
integer |
A altura do retângulo, em pixels. |
left |
integer |
A distância da borda esquerda se a imagem até a borda esquerda do retângulo, em pixels. |
top |
integer |
A distância da borda superior se a imagem até a borda superior do retângulo, em pixels. |
width |
integer |
A largura do retângulo, em pixels. |
FaceSessionStatus
O status atual da sessão.
Nome | Tipo | Description |
---|---|---|
NotStarted |
string |
A sessão não foi iniciada. |
ResultAvailable |
string |
A sessão tem o resultado disponível. |
Started |
string |
A sessão foi iniciada. |
ImageType
O tipo de imagem.
Nome | Tipo | Description |
---|---|---|
Color |
string |
Imagem de cor. |
Depth |
string |
Imagem de profundidade. |
Infrared |
string |
Imagem infravermelha. |
LivenessDecision
O resultado da classificação de vida útil.
Nome | Tipo | Description |
---|---|---|
realface |
string |
O algoritmo classificou a face de destino como real. |
spoofface |
string |
O algoritmo classificou o rosto de destino como uma falsificação. |
uncertain |
string |
O algoritmo não pôde classificar o rosto de destino como real ou falsificado. |
LivenessModel
A versão do modelo usada para a classificação de dinâmica.
Nome | Tipo | Description |
---|---|---|
2022-10-15-preview.04 |
string |
|
2023-12-20-preview.06 |
string |
LivenessOutputsTarget
A classificação de dinâmica para o rosto de destino.
Nome | Tipo | Description |
---|---|---|
faceRectangle |
A região da face em que a classificação de dinâmica foi feita. |
|
fileName |
string |
O nome do arquivo que contém o retângulo facial no qual a classificação de dinâmica foi feita. |
imageType |
O tipo de imagem que contém o retângulo facial no qual a classificação de dinâmica foi feita. |
|
timeOffsetWithinFile |
integer |
O deslocamento de tempo dentro do arquivo do quadro que contém o retângulo facial no qual a classificação de dinâmica foi feita. |
LivenessResponseBody
O corpo da resposta da chamada à API de detecção de atividade.
Nome | Tipo | Description |
---|---|---|
livenessDecision |
A classificação de dinâmica para a face de destino. |
|
modelVersionUsed |
A versão do modelo usada para a classificação de dinâmica. |
|
target |
Destinos específicos usados para classificação de dinâmica. |
|
verifyResult |
A saída de verificação facial. Disponível somente quando a solicitação é dinâmica com verificação. |
LivenessSession
Resultado da sessão de detecção de vida.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
authTokenTimeToLiveInSeconds |
integer |
600 |
Segundos para os quais a sessão deve durar. O intervalo é de 60 a 86400 segundos. O valor padrão é 600. |
createdDateTime |
string |
DateTime quando esta sessão foi criada. |
|
deviceCorrelationId |
string |
Guid exclusivo por cada dispositivo de usuário final. Isso é para fornecer limitação de taxa e anti-martelada. Se 'deviceCorrelationIdSetInClient' for verdadeiro nesta solicitação, essa 'deviceCorrelationId' deverá ser nula. |
|
id |
string |
A ID exclusiva para fazer referência a esta sessão. |
|
result |
O resultado da auditoria de sessão mais recente só será preenchido se o status == 'ResultAvailable'. |
||
sessionExpired |
boolean |
Se a sessão expirou ou não. |
|
sessionStartDateTime |
string |
DateTime quando esta sessão foi iniciada pelo cliente. |
|
status |
O status atual da sessão. |
LivenessSessionAuditEntry
Entrada de auditoria para uma solicitação na sessão.
Nome | Tipo | Description |
---|---|---|
clientRequestId |
string |
O clientRequestId exclusivo que é enviado pelo cliente no cabeçalho 'client-request-id'. |
digest |
string |
O resumo calculado do servidor para essa solicitação. Se o resumo relatado pelo cliente for diferente do resumo calculado do servidor, a integridade da mensagem entre o cliente e o serviço será comprometida e o resultado não deverá ser confiável. Para obter mais informações, confira como orientar sobre como aproveitar esse valor para proteger sua solução de ponta a ponta. |
id |
integer |
A ID exclusiva para fazer referência a essa solicitação de auditoria. Use essa ID com o parâmetro de consulta 'start' para continuar na próxima página de resultados da auditoria. |
receivedDateTime |
string |
O DateTime UTC que a solicitação foi recebida. |
request |
A solicitação dessa entrada. |
|
requestId |
string |
A requestId exclusiva retornada pelo serviço para o cliente no cabeçalho 'apim-request-id'. |
response |
A resposta dessa entrada. |
|
sessionId |
string |
A sessionId exclusiva da sessão criada. Ele expirará 48 horas depois de ter sido criado ou poderá ser excluído mais cedo usando a operação DELETE de sessão correspondente. |
sessionImageId |
string |
A ID da imagem da solicitação de sessão. |
verifyImageHash |
string |
O hash sha256 da imagem de verificação na solicitação. |
LivenessWithVerifyImage
O detalhe da face para verificação.
Nome | Tipo | Description |
---|---|---|
faceRectangle |
A região do rosto em que a classificação da imagem de comparação foi feita. |
|
qualityForRecognition |
Qualidade da imagem facial para reconhecimento. |
LivenessWithVerifyOutputs
A saída de verificação facial.
Nome | Tipo | Description |
---|---|---|
isIdentical |
boolean |
Se a face da dinâmica de destino e a face da imagem de comparação correspondem. |
matchConfidence |
number |
A face de vida facial de destino e a confiança de verificação facial da imagem de comparação. |
verifyImage |
O detalhe da face para verificação. |
QualityForRecognition
Indica a qualidade da imagem para reconhecimento.
Nome | Tipo | Description |
---|---|---|
high |
string |
Alta qualidade. |
low |
string |
Baixa qualidade. |
medium |
string |
Qualidade média. |