Liveness Session Operations - Get Liveness Sessions

Serviço:

Azure AI Services

Versão da API:

v1.2-preview.1

Lista sessões para /detectLiveness/SingleModal.
Listar sessões da última sessionId maior que a 'start'.

O resultado deve ser ordenado por sessionId em ordem crescente.

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

Com parâmetros opcionais:

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions?start={start}&top={top}

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).
start	query		string	Listar recursos maiores que o "start". Ele não contém mais de 64 caracteres. O padrão está vazio.
top	query		integer int32	O número de itens a serem listados, variando em [1,1000]. O padrão é 1000.

Respostas

Nome	Tipo	Description
200 OK	LivenessSessionItem[]	A solicitação foi bem-sucedida.
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

Get LivenessSessions

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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

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

LivenessSessionItem

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

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.
createdDateTime	string		DateTime quando esta sessão foi criada.
deviceCorrelationId	string		Guid exclusivo por cada dispositivo de usuário final. Isso é para fornecer limitação de taxa e anti-martelada. Se 'deviceCorrelationIdSetInClient' for verdadeiro nesta solicitação, essa 'deviceCorrelationId' deverá ser nula.
id	string		A ID exclusiva 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.