Liveness Session Operations - Create Liveness Session

Service:

Azure AI Services

API Version:

v1.1-preview.1

Create uma nova sessão de detecção de vida.
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 completo 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 /detectLiveness/singleModal para até três novas tentativas.
  • Um tempo de vida do token de 10 minutos.

Observação

O acesso ao cliente pode ser revogado excluindo a sessão usando a operação Excluir Sessão de Liveness. Para recuperar um resultado, use a Sessão Obter Liveness. Para auditar as solicitações individuais que um cliente fez ao seu recurso, use As Entradas de Auditoria da Sessão de Atividade de Lista.

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

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).

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
livenessOperationMode	True	LivenessOperationMode	Tipo de modo de vida que o cliente deve seguir.
authTokenTimeToLiveInSeconds		integer	Segundos para os quais a sessão deve durar. O intervalo é de 60 a 86400 segundos. O valor padrão é 600.
deviceCorrelationId		string	Guid exclusivo por cada dispositivo de usuário final. Isso é para fornecer limitação de taxa e anti-hammering. Se 'deviceCorrelationIdSetInClient' for true nessa solicitação, esse 'deviceCorrelationId' deverá ser nulo.
deviceCorrelationIdSetInClient		boolean	Se o cliente deve ou não permitir que o cliente defina seu próprio 'deviceCorrelationId' por meio do SDK de Visão. O padrão é false e 'deviceCorrelationId' deve ser definido neste corpo da solicitação.
sendResultsToClient		boolean	Se deve ou não permitir que um corpo de resposta '200 – Sucesso' seja enviado ao cliente, o que pode ser indesejável por motivos de segurança. O padrão é false, os clientes receberão uma resposta de corpo vazia '204 - NoContent'. Independentemente da seleção, chamar Session GetResult sempre conterá um corpo de resposta permitindo que a lógica de negócios seja implementada.

Respostas

Nome	Tipo	Description
200 OK	CreateLivenessSessionResult	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. 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

Create Liveness Session

Sample Request

HTTP

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

{
  "livenessOperationMode": "Passive",
  "sendResultsToClient": true,
  "deviceCorrelationIdSetInClient": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 60
}

Sample Response

Status code:

200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm"
}

Definições

Nome	Description
CreateLivenessSessionContent	Solicitação para criar a sessão de liveness.
CreateLivenessSessionResult	Resposta da criação da sessão de liveness.
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.
LivenessOperationMode	O modo de operação de atividade para impulsionar a experiência do usuário final do cliente.

CreateLivenessSessionContent

Solicitação para criar a sessão de liveness.

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.
deviceCorrelationId	string		Guid exclusivo por cada dispositivo de usuário final. Isso é para fornecer limitação de taxa e anti-hammering. Se 'deviceCorrelationIdSetInClient' for true nessa solicitação, esse 'deviceCorrelationId' deverá ser nulo.
deviceCorrelationIdSetInClient	boolean		Se o cliente deve ou não permitir que o cliente defina seu próprio 'deviceCorrelationId' por meio do SDK de Visão. O padrão é false e 'deviceCorrelationId' deve ser definido neste corpo da solicitação.
livenessOperationMode	LivenessOperationMode		Tipo de modo de vida que o cliente deve seguir.
sendResultsToClient	boolean		Se deve ou não permitir que um corpo de resposta '200 – Sucesso' seja enviado ao cliente, o que pode ser indesejável por motivos de segurança. O padrão é false, os clientes receberão uma resposta de corpo vazia '204 - NoContent'. Independentemente da seleção, chamar Session GetResult sempre conterá um corpo de resposta permitindo que a lógica de negócios seja implementada.

CreateLivenessSessionResult

Resposta da criação da sessão de liveness.

Nome	Tipo	Description
authToken	string	Token de portador para fornecer autenticação para o SDK de 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 o tempo TTL. Ele 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.

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 do erro.

FaceErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	FaceError	O objeto de erro.

LivenessOperationMode

O modo de operação de atividade para impulsionar a experiência do usuário final do cliente.

Nome	Tipo	Description
Passive	string	Utiliza uma técnica de atividade passiva que não requer ações adicionais do usuário. Requer iluminação interna normal e brilho de tela alta para um desempenho ideal. Portanto, esse modo tem um envelope operacional estreito e não será adequado para cenários que exigem que os usuários finais estejam em condições de iluminação brilhante. Observação: esse é o único modo com suporte para a solução Móvel (iOS e Android).
PassiveActive	string	Esse modo utiliza uma técnica de atividade ativa ou passiva híbrida que exige a cooperação do usuário. Ele é otimizado para exigir movimento ativo somente em condições de iluminação abaixo do ideal. Ao contrário do modo passivo, esse modo não tem restrições de iluminação e, portanto, oferece um envelope operacional mais amplo. Esse modo é preferível em soluções baseadas na Web devido à falta de controle automático de brilho de tela disponível em navegadores, o que dificulta o envelope operacional do modo passivo em soluções baseadas na Web.