Liveness Session Operations - Get Liveness With Verify Session Audit Entries

Referência

Serviço:: Azure AI Services

Versão da API:: v1.2-preview.1

Obtém solicitações de sessão e corpo de resposta para a sessão.

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

Com parâmetros opcionais:

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions/{sessionId}/audit?start={start}&top={top}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
apiVersion	path	True	string	Versão da API
endpoint	path	True	string uri	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://{resource-name}.cognitiveservices.azure.com).
sessionId	path	True	string	O ID exclusivo para fazer referência a esta sessão.
start	query		string	Listar recursos maiores que o "início". Não contém mais de 64 caracteres. O padrão está vazio.
top	query		integer int32	O número de itens a listar, variando em [1, 1000]. O padrão é 1000.

Respostas

Name	Tipo	Description
200 OK	LivenessSessionAuditEntry[]	O pedido foi bem-sucedido.
Other Status Codes	FaceErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

LivenessSessionAuditEntry[]

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 para sua assinatura do Azure AI Face.

Tipo: apiKey
Em: header

AADToken

O fluxo OAuth2 do Azure Ative 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 LivenessWithVerify Session Audit Entries

Pedido de amostra

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e/audit?start=0&top=20

Resposta da amostra

Código de estado:: 200

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

Name	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 Face Service, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Uma resposta contendo detalhes do erro.
FaceRectangle	Um retângulo dentro do qual um rosto pode ser encontrado.
ImageType	O tipo de imagem.
LivenessDecision	O resultado da classificação de vivacidade.
LivenessModel	A versão do modelo utilizada para a classificação da vivacidade.
LivenessOutputsTarget	A classificação de vivacidade para o rosto alvo.
LivenessResponseBody	O corpo de resposta da chamada da API de deteção de vivacidade.
LivenessSessionAuditEntry	Entrada de auditoria para uma solicitação na sessão.
LivenessWithVerifyImage	O detalhe do rosto para verificação.
LivenessWithVerifyOutputs	A saída de 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 request.method usados pelo cliente.
latencyInMilliseconds	integer	O servidor mediu a latência para essa solicitação em milissegundos.
statusCode	integer	O código de status HTTP retornou ao cliente.

AuditRequestInfo

Entrada de auditoria para uma solicitação na sessão.

Name	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 vivacidade.
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 Face Service, consulte o seguinte link: https://aka.ms/face-error-codes-and-messages.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
message	string	Uma representação legível por humanos do erro.

FaceErrorResponse

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	FaceError	O objeto de erro.

FaceRectangle

Um retângulo dentro do qual um rosto pode ser encontrado.

Name	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 para a borda superior do retângulo, em pixels.
width	integer	A largura do retângulo, em pixels.

ImageType

O tipo de imagem.

Name	Tipo	Description
Color	string	Imagem colorida.
Depth	string	Imagem de profundidade.
Infrared	string	Imagem infravermelha.

LivenessDecision

O resultado da classificação de vivacidade.

Name	Tipo	Description
realface	string	O algoritmo classificou o rosto alvo como real.
spoofface	string	O algoritmo classificou o rosto alvo como uma paródia.
uncertain	string	O algoritmo não conseguiu classificar o rosto alvo como real ou falso.

LivenessModel

A versão do modelo utilizada para a classificação da vivacidade.

Name	Tipo	Description
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOutputsTarget

A classificação de vivacidade para o rosto alvo.

Name	Tipo	Description
faceRectangle	FaceRectangle	A região do rosto onde a classificação de vivacidade foi feita.
fileName	string	O nome do arquivo que contém o retângulo facial onde a classificação de vivacidade foi feita.
imageType	ImageType	O tipo de imagem que contém o retângulo facial onde a classificação de vivacidade foi feita.
timeOffsetWithinFile	integer	O deslocamento de tempo dentro do arquivo do quadro que contém o retângulo facial onde a classificação de vivacidade foi feita.

LivenessResponseBody

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

Name	Tipo	Description
livenessDecision	LivenessDecision	A classificação de vivacidade para o rosto alvo.
modelVersionUsed	LivenessModel	A versão do modelo utilizada para a classificação da vivacidade.
target	LivenessOutputsTarget	Alvos específicos utilizados para a classificação da vivacidade.
verifyResult	LivenessWithVerifyOutputs	A saída de verificação facial. Disponível apenas quando o pedido estiver vivo com verificar.

LivenessSessionAuditEntry

Entrada de auditoria para uma solicitação na sessão.

Name	Tipo	Description
clientRequestId	string	O clientRequestId exclusivo que é enviado pelo cliente no cabeçalho 'client-request-id'.
digest	string	O resumo calculado pelo servidor para essa solicitação. Se o digest relatado pelo cliente for diferente do digest calculado pelo 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, consulte como obter guias sobre como aproveitar esse valor para proteger sua solução completa.
id	integer	A ID exclusiva para se referir a esta solicitação de auditoria. Use este id com o parâmetro de consulta 'start' para continuar para a próxima página de resultados da auditoria.
receivedDateTime	string	O UTC DateTime em que a solicitação foi recebida.
request	AuditRequestInfo	O pedido desta entrada.
requestId	string	O requestId exclusivo que é retornado 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. Ele expirará 48 horas após ter sido criado ou poderá ser excluído mais cedo usando a operação DELETE de sessão correspondente.
sessionImageId	string	O 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 do rosto para verificação.

Name	Tipo	Description
faceRectangle	FaceRectangle	A região da face onde foi feita a classificação da imagem de comparação.
qualityForRecognition	QualityForRecognition	Qualidade da imagem do rosto para reconhecimento.

LivenessWithVerifyOutputs

A saída de verificação facial.

Name	Tipo	Description
isIdentical	boolean	Se o rosto de vivacidade alvo e a imagem de comparação correspondem.
matchConfidence	number	A vivacidade do rosto alvo e a imagem de comparação face verificação confiança.
verifyImage	LivenessWithVerifyImage	O detalhe do rosto para verificação.

QualityForRecognition

Indica a qualidade da imagem para reconhecimento.

Name	Tipo	Description
high	string	Alta qualidade.
low	string	Baixa qualidade.
medium	string	Qualidade média.

Partilhar via

Liveness Session Operations - Get Liveness With Verify Session Audit Entries

Parâmetros do URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

AADToken

Âmbitos

Exemplos

Get LivenessWithVerify Session Audit Entries

Pedido de amostra

Resposta da amostra

Definições

AuditLivenessResponseInfo

AuditRequestInfo

FaceError

FaceErrorResponse

FaceRectangle

ImageType

LivenessDecision

LivenessModel

LivenessOutputsTarget

LivenessResponseBody

LivenessSessionAuditEntry

LivenessWithVerifyImage

LivenessWithVerifyOutputs

QualityForRecognition

Recursos adicionais