Liveness Session Operations - Create Liveness With Verify Session With Verify Image

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Crie uma nova sessão de dinâmica com verificação. Forneça a imagem de verificação durante a criação da sessão.
Uma sessão é melhor para cenários de dispositivo cliente em que os desenvolvedores desejam autorizar um dispositivo cliente a executar apenas uma detecção de atividade sem conceder acesso total ao recurso. As sessões criadas têm um tempo de vida limitado e só autorizam os clientes a executar a ação desejada antes que o acesso expire.

As permissões incluem...

• • Capacidade de chamar /detectLivenessWithVerify/singleModal para até três tentativas.
  • Um tempo de vida do token de 10 minutos.

Nota

• • O acesso ao cliente pode ser revogado excluindo a sessão usando a operação Excluir Liveness With Verify Session.
  • Para recuperar um resultado, use a sessão Get Liveness With Verify.
  • Para auditar as solicitações individuais feitas por um cliente ao seu recurso, use o Modo de Vida da Lista com As Entradas de Auditoria de Sessão de Verificação.

Opção recomendada: VerifyImage é fornecido durante a criação da sessão.

POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Parameters	formData	True	string	Os parâmetros para criar sessão.
VerifyImage	formData	True	file	O fluxo de imagem para verificar. O campo de cabeçalho Content-Disposition para essa parte deve ter nome de arquivo.
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).

Respostas

Nome	Tipo	Description
200 OK	CreateLivenessWithVerifySessionResult	Uma chamada bem-sucedida cria uma sessão para um dispositivo cliente e fornece um token de autorização para uso pelo aplicativo cliente para uma finalidade e tempo limitados.
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 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

Create LivenessWithVerify Session with VerifyImage

Solicitação de exemplo

HTTP

POST {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions

Resposta de exemplo

Código de status:

200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "verifyImage": {
    "faceRectangle": {
      "width": 78,
      "height": 78,
      "left": 394,
      "top": 54
    },
    "qualityForRecognition": "high"
  }
}

Definições

Nome	Description
CreateLivenessWithVerifySessionResult	Resposta da sessão de atividade com verificação da criação com a imagem de verificação fornecida.
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.
LivenessWithVerifyImage	O detalhe da face para verificação.
QualityForRecognition	Indica a qualidade da imagem para reconhecimento.

CreateLivenessWithVerifySessionResult

Resposta da sessão de atividade com verificação da criação com a imagem de verificação fornecida.

Nome	Tipo	Description
authToken	string	Token de portador para fornecer autenticação para o SDK da Visão em execução em um aplicativo cliente. Esse token de portador tem permissões limitadas para executar apenas a ação necessária e expira após a hora TTL. Também é auditável.
sessionId	string	A ID de sessão 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.
verifyImage	LivenessWithVerifyImage	O detalhe da face para verificaçã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	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 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.

LivenessWithVerifyImage

O detalhe da face para verificação.

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

QualityForRecognition

Indica a qualidade da imagem para reconhecimento.

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