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 vivacidade com a 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 deteção de vivacidade sem conceder acesso total ao recurso. As sessões criadas têm uma vida útil limitada 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é 3 tentativas.
  • Uma vida útil do token de 10 minutos.

Observação

• • O acesso do cliente pode ser revogado excluindo a sessão usando a operação Excluir vivacidade com verificação de sessão.
  • Para recuperar um resultado, use Get Liveness With Verify Session.
  • Para auditar as solicitações individuais que um cliente fez ao seu recurso, use a opção Listar Vivacidade com Verificar Entradas de Auditoria de Sessão.

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

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Parameters	formData	True	string	Os parâmetros para criar sessão.
VerifyImage	formData	True	file	O fluxo de imagem para verificação. O campo de cabeçalho Content-Disposition para esta parte deve ter filename.
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).

Respostas

Name	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 por um propósito 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 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

Create LivenessWithVerify Session with VerifyImage

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

Definições

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

CreateLivenessWithVerifySessionResult

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

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

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.

QualityForRecognition

Indica a qualidade da imagem para reconhecimento.

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