Liveness Session Operations - Get Liveness With Verify Session Result

Referência

Service:: Azure AI Services

API Version:: v1.1-preview.1

Obter o resultado da sessão de detectLivenessWithVerify/singleModal call.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiVersion	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).
sessionId	path	True	string	A ID exclusiva para fazer referência a esta sessão.

Respostas

Nome	Tipo	Description
200 OK	LivenessWithVerifySession	A solicitação foi bem-sucedida.
Other Status Codes	FaceErrorResponse	Uma resposta de erro inesperada. Headers x-ms-error-code: string

Nome

Tipo

Description

200 OK

LivenessWithVerifySession

A solicitação foi bem-sucedida.

Other Status Codes

FaceErrorResponse

Uma resposta de erro inesperada.

Headers

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

A chave secreta para sua assinatura de Detecção Facial de IA do Azure.

Type: apiKey
In: header

AADToken

O Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Exemplos

Get LivenessWithVerify Session Result

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Nome	Description
AuditLivenessResponseInfo	Entrada de auditoria para uma resposta na sessão.
AuditRequestInfo	Entrada de auditoria para uma solicitação na sessã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.
FaceErrorResponse	Uma resposta que contém detalhes do erro.
FaceRectangle	Um retângulo no qual um rosto pode ser encontrado.
FaceSessionStatus	O status atual da sessão.
ImageType	O tipo de imagem.
LivenessDecision	O resultado da classificação de vida útil.
LivenessModel	A versão do modelo usada para classificação de vida útil.
LivenessOutputsTarget	A classificação de vida para o rosto de destino.
LivenessResponseBody	O corpo da resposta da chamada à API de detecção de dinâmica.
LivenessSessionAuditEntry	Entrada de auditoria para uma solicitação na sessão.
LivenessWithVerifyImage	O detalhe da face para verificação.
LivenessWithVerifyOutputs	A saída de verificação facial.
LivenessWithVerifySession	Resultado da sessão da detecção de vida com verificação.
QualityForRecognition	Indica a qualidade da imagem para reconhecimento.

AuditLivenessResponseInfo

Entrada de auditoria para uma resposta na sessão.

Nome	Tipo	Description
body	LivenessResponseBody	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 http status 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 liveness.
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 homem do erro.

FaceErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	FaceError	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 para 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 classificação de vida útil.

Nome	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 vida para o rosto de destino.

Nome	Tipo	Description
faceRectangle	FaceRectangle	A região facial 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 vida foi feita.
imageType	ImageType	O tipo de imagem que contém o retângulo facial no qual a classificação de vida 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 dinâmica.

Nome	Tipo	Description
livenessDecision	LivenessDecision	A classificação de vida da face de destino.
modelVersionUsed	LivenessModel	A versão do modelo usada para classificação de vida útil.
target	LivenessOutputsTarget	Destinos específicos usados para classificação de vida útil.
verifyResult	LivenessWithVerifyOutputs	A saída de verificação facial. Disponível somente quando a solicitação estiver em tempo de vida com verificaçã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 foi comprometida e o resultado não deve ser confiável. Para obter mais informações, confira guias sobre como aproveitar esse valor para proteger sua solução de ponta a ponta.
id	integer	A ID exclusiva a ser referenciada 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	AuditRequestInfo	A solicitação dessa entrada.
requestId	string	A requestId exclusiva retornada pelo serviço para o cliente no cabeçalho 'apim-request-id'.
response	AuditLivenessResponseInfo	A resposta dessa entrada.
sessionId	string	A sessionId exclusiva da sessão criada. Ele expirará 48 horas depois de ser criado ou poderá ser excluído mais cedo usando a operação DELETE de sessão correspondente.

LivenessWithVerifyImage

O detalhe da face para verificação.

Nome	Tipo	Description
faceRectangle	FaceRectangle	A região da face em que a classificação da imagem de comparação foi feita.
qualityForRecognition	QualityForRecognition	Qualidade da imagem facial para reconhecimento.

LivenessWithVerifyOutputs

A saída de verificação facial.

Nome	Tipo	Description
isIdentical	boolean	Se a face de vida de destino e a face da imagem de comparação correspondem.
matchConfidence	number	A face da face de destino e a confiança de verificação facial da imagem de comparação.
verifyImage	LivenessWithVerifyImage	O detalhe da face para verificação.

LivenessWithVerifySession

Resultado da sessão da detecção de vida com verificação.

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	LivenessSessionAuditEntry		O resultado da auditoria de sessão mais recente só será preenchido se status == 'ResultAvailable'.
sessionExpired	boolean		Se a sessão expirou ou não.
sessionStartDateTime	string		DateTime quando esta sessão foi iniciada pelo cliente.
status	FaceSessionStatus		O status atual da sessão.

QualityForRecognition

Indica a qualidade da imagem para reconhecimento.

Nome	Tipo	Description
high	string	Qualidade alta.
low	string	Baixa qualidade.
medium	string	Qualidade média.

Compartilhar via

Liveness Session Operations - Get Liveness With Verify Session Result

Parâmetros de URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

AADToken

Scopes

Exemplos

Get LivenessWithVerify Session Result

Sample Request

Sample Response

Definições

AuditLivenessResponseInfo

AuditRequestInfo

FaceError

FaceErrorResponse

FaceRectangle

FaceSessionStatus

ImageType

LivenessDecision

LivenessModel

LivenessOutputsTarget

LivenessResponseBody

LivenessSessionAuditEntry

LivenessWithVerifyImage

LivenessWithVerifyOutputs

LivenessWithVerifySession

QualityForRecognition

Recursos adicionais