Liveness Session Operations - Get Liveness Sessions

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Uvádí relace pro /detectLiveness/SingleModal.
Vypíše relace z posledního id relace větší než počáteční hodnota.

Výsledek by měl být seřazený podle id relace ve vzestupném pořadí.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
endpoint	path	True	string uri	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).
start	query		string	Uveďte prostředky větší než počáteční. Neobsahuje více než 64 znaků. Výchozí hodnota je prázdná.
top	query		integer int32	Počet položek seznamu v rozsahu od [1, 1000]. Výchozí hodnota je 1000.

Odpovědi

Name	Typ	Description
200 OK	LivenessSessionItem[]	Požadavek byl úspěšný.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

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

Příklady

Get LivenessSessions

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
FaceError	Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpověď obsahující podrobnosti o chybě.
LivenessSessionItem	Data relace vrácená pro výčet.

FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
message	string	Čitelné znázornění chyby člověkem.

FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	FaceError	Objekt chyby.

LivenessSessionItem

Data relace vrácená pro výčet.

Name	Typ	Default value	Description
authTokenTimeToLiveInSeconds	integer	600	Sekundy, na které by měla relace trvat. Rozsah je 60 až 86400 sekund. Výchozí hodnota je 600.
createdDateTime	string		DateTime při vytvoření této relace.
deviceCorrelationId	string		Jedinečný identifikátor GUID pro každé zařízení koncového uživatele. Jedná se o zajištění omezování rychlosti a proti kladivu. Pokud je v tomto požadavku hodnota deviceCorrelationIdSetInClient true, musí být hodnota deviceCorrelationId null.
id	string		Jedinečné ID pro odkaz na tuto relaci.
sessionExpired	boolean		Jestli platnost relace vypršela, nebo ne.
sessionStartDateTime	string		DateTime, kdy byla tato relace spuštěna klientem.