Liveness Session Operations - Get Liveness Sessions

Service:

Azure AI Services

API-versie:

v1.2-preview.1

Bevat sessies voor /detectLiveness/SingleModal.
Lijst met sessies van de laatste sessionId groter dan de 'start'.

Het resultaat moet in oplopende volgorde worden geordend op sessionId.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
apiVersion	path	True	string	API-versie
endpoint	path	True	string uri	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://{resource-name}.cognitiveservices.azure.com).
start	query		string	Resources weergeven die groter zijn dan het begin. Het bevat niet meer dan 64 tekens. De standaardwaarde is leeg.
top	query		integer int32	Het aantal te vermelden items, variërend in [1, 1000]. De standaardwaarde is 1000.

Antwoorden

Name	Type	Description
200 OK	LivenessSessionItem[]	De aanvraag is voltooid.
Other Status Codes	FaceErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure AI Face-abonnement.

Type: apiKey
In: header

AADToken

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://api.example.com/oauth2/authorize
Token-URL: https://api.example.com/oauth2/token

Bereiken

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

Voorbeelden

Get LivenessSessions

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
FaceError	Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Een antwoord met foutdetails.
LivenessSessionItem	Sessiegegevens geretourneerd voor opsomming.

FaceError

Het foutobject. Raadpleeg de volgende koppeling voor uitgebreide informatie over foutcodes en berichten die worden geretourneerd door de Face-service: https://aka.ms/face-error-codes-and-messages.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
message	string	Een leesbare weergave van de fout.

FaceErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	FaceError	Het foutobject.

LivenessSessionItem

Sessiegegevens geretourneerd voor opsomming.

Name	Type	Default value	Description
authTokenTimeToLiveInSeconds	integer	600	Seconden waarop de sessie moet duren. Het bereik is 60 tot 86400 seconden. De standaardwaarde is 600.
createdDateTime	string		Datum/tijd waarop deze sessie is gemaakt.
deviceCorrelationId	string		Unieke GUID per elk apparaat van de eindgebruiker. Dit is om snelheidsbeperking en anti-hamering te bieden. Als 'deviceCorrelationIdSetInClient' waar is in deze aanvraag, moet deze 'deviceCorrelationId' null zijn.
id	string		De unieke id om naar deze sessie te verwijzen.
sessionExpired	boolean		Of de sessie al dan niet is verlopen.
sessionStartDateTime	string		Datum/tijd waarop deze sessie is gestart door de client.