Liveness Session Operations - Get Liveness With Verify Sessions

Service:

Azure AI Services

API Version:

v1.1-preview.1

Listor sessioner för /detectLivenessWithVerify/SingleModal.
Lista sessioner från det senaste sessionId som är större än "start".

Resultatet ska sorteras efter sessionId i stigande ordning.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).
start	query		string	Visa en lista över resurser som är större än "start". Den innehåller högst 64 tecken. Standardvärdet är tomt.
top	query		integer int32	Antalet objekt att lista, i [1, 1000]. Standardvärdet är 1 000.

Svar

Name	Typ	Description
200 OK	LivenessSessionItem[]	Begäran har slutförts.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Ansiktsprenumeration på Azure AI.

Type: apiKey
In: header

AADToken

Azure Active Directory OAuth2-flödet

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Exempel

Get LivenessWithVerify Sessions

Sample Request

HTTP

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

Sample Response

Status code:

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
  }
]

Definitioner

Name	Description
FaceError	Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns på följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.
LivenessSessionItem	Sessionsdata som returneras för uppräkning.

FaceError

Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns på följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.

LivenessSessionItem

Sessionsdata som returneras för uppräkning.

Name	Typ	Standardvärde	Description
authTokenTimeToLiveInSeconds	integer	600	Sekunder sessionen ska pågå i. Intervallet är 60 till 86 400 sekunder. Standardvärdet är 600.
createdDateTime	string		DateTime när den här sessionen skapades.
deviceCorrelationId	string		Unikt GUID per varje slutanvändarenhet. Detta är för att ge hastighetsbegränsning och anti-hammering. Om "deviceCorrelationIdSetInClient" är sant i den här begäran måste "deviceCorrelationId" vara null.
id	string		Det unika ID som ska referera till den här sessionen.
sessionExpired	boolean		Om sessionen har upphört att gälla eller inte.
sessionStartDateTime	string		DateTime när den här sessionen startades av klienten.