Liveness Session Operations - Get Liveness With Verify Sessions

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Lista sessões para /detectLivenessWithVerify/SingleModal.
Listar sessões da última sessionId maior que o "start".

O resultado deve ser ordenado por sessionId em ordem crescente.

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

Com parâmetros opcionais:

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions?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).
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	LivenessSessionItem[]	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 Sessions

Pedido de amostra

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions?start=00000000-0000-0000-0000-000000000000&top=20

Resposta da amostra

Código de estado:

200

[
  {
    "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "createdDateTime": "2024-03-05T11:07:28.540Z",
    "sessionStartDateTime": "2024-03-05T11:07:28.540Z",
    "sessionExpired": true,
    "deviceCorrelationId": "your_device_correlation_id",
    "authTokenTimeToLiveInSeconds": 60
  }
]

Definições

Name	Description
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.
LivenessSessionItem	Dados da sessão retornados para enumeraçã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.

LivenessSessionItem

Dados da sessão retornados para enumeração.

Name	Tipo	Default value	Description
authTokenTimeToLiveInSeconds	integer	600	Segundos a sessão deve durar. O alcance é de 60 a 86400 segundos. O valor padrão é 600.
createdDateTime	string		DateTime quando esta sessão foi criada.
deviceCorrelationId	string		GUID exclusivo para cada dispositivo do usuário final. Isto é para fornecer limitação de taxa e anti-martelo. Se 'deviceCorrelationIdSetInClient' for true nesta solicitação, esse 'deviceCorrelationId' deverá ser null.
id	string		O ID exclusivo para fazer referência a esta sessão.
sessionExpired	boolean		Se a sessão expirou ou não.
sessionStartDateTime	string		DateTime quando esta sessão foi iniciada pelo cliente.