Liveness Session Operations - Get Liveness Session Audit Entries

Reference

Služba:: Azure AI Services

Verze rozhraní API:: v1.2-preview.1

Získá požadavky na relaci a text odpovědi pro relaci.

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

S volitelnými parametry:

GET {endpoint}/face/{apiVersion}/detectLiveness/singleModal/sessions/{sessionId}/audit?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).
sessionId	path	True	string	Jedinečné ID pro odkaz na tuto relaci.
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	LivenessSessionAuditEntry[]	Požadavek byl úspěšný.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

LivenessSessionAuditEntry[]

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 LivenessSession Audit Entries

Ukázkový požadavek

HTTP

GET {endpoint}/face/v1.2-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e/audit?start=0&top=20

Ukázková odpověď

Stavový kód:: 200

[
  {
    "id": 4,
    "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
    "requestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "clientRequestId": "4af681e9-0e25-43e9-9922-a7adebf13b2f",
    "receivedDateTime": "2024-03-05T11:07:29.698Z",
    "request": {
      "url": "/face/v1.2-preview.1/detectliveness/singlemodal",
      "method": "POST",
      "contentLength": 18,
      "contentType": "multipart/form-data",
      "userAgent": "Mozilla/5.0 (Linux) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Mobile Safari/537.36"
    },
    "response": {
      "body": {},
      "statusCode": 200,
      "latencyInMilliseconds": 1200
    },
    "digest": "1CC98BA83EAF1D0FF7F566FAEFCCCC787819FFA01251E2D9299143F7AD6651DB"
  }
]

Definice

Name	Description
AuditLivenessResponseInfo	Auditovat položku pro odpověď v relaci.
AuditRequestInfo	Auditovat položku pro požadavek v relaci.
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ě.
FaceRectangle	Obdélník, ve kterém lze najít tvář.
ImageType	Typ obrázku.
LivenessDecision	Výsledek klasifikace aktivity.
LivenessModel	Verze modelu používaná pro klasifikaci aktivity.
LivenessOutputsTarget	Klasifikace aktivity pro cílovou tvář.
LivenessResponseBody	Tělo odpovědi volání rozhraní API pro detekci aktivity
LivenessSessionAuditEntry	Auditovat položku požadavku v relaci.
LivenessWithVerifyImage	Podrobnosti o tváři pro ověření.
LivenessWithVerifyOutputs	Výstup ověření tváře.
QualityForRecognition	Označuje kvalitu obrázku pro rozpoznávání.

AuditLivenessResponseInfo

Auditovat položku pro odpověď v relaci.

Name	Typ	Description
body	LivenessResponseBody	Tělo odpovědi. Schéma tohoto pole bude záviset na adrese request.url a request.method používané klientem.
latencyInMilliseconds	integer	Server měří latenci pro tento požadavek v milisekundách.
statusCode	integer	Stavový kód HTTP vrácený klientovi.

AuditRequestInfo

Auditovat položku pro požadavek v relaci.

Name	Typ	Description
contentLength	integer	Délka textu požadavku v bajtech.
contentType	string	Typ obsahu požadavku.
method	string	Metoda HTTP požadavku (tj. GET, POST, DELETE).
url	string	Relativní adresa URL a dotaz žádosti o liveness.
userAgent	string	Uživatelský agent použitý k odeslání požadavku.

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.

FaceRectangle

Obdélník, ve kterém lze najít tvář.

Name	Typ	Description
height	integer	Výška obdélníku v pixelech.
left	integer	Vzdálenost od levého okraje, pokud je obrázek na levém okraji obdélníku v pixelech.
top	integer	Vzdálenost od horního okraje, pokud je obrázek na horním okraji obdélníku v pixelech.
width	integer	Šířka obdélníku v pixelech.

ImageType

Typ obrázku.

Name	Typ	Description
Color	string	Barevný obrázek
Depth	string	Obrázek hloubky
Infrared	string	Infračervený obraz.

LivenessDecision

Výsledek klasifikace aktivity.

Name	Typ	Description
realface	string	Algoritmus klasifikoval cílovou tvář jako skutečnou.
spoofface	string	Algoritmus klasifikoval cílovou tvář jako falšování identity.
uncertain	string	Algoritmus nemohl klasifikovat cílovou tvář jako skutečnou ani jako falšování identity.

LivenessModel

Verze modelu používaná pro klasifikaci aktivity.

Name	Typ	Description
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOutputsTarget

Klasifikace aktivity pro cílovou tvář.

Name	Typ	Description
faceRectangle	FaceRectangle	Oblast tváře, ve které byla klasifikace aktivity provedena.
fileName	string	Název souboru, který obsahuje obdélník tváře, na kterém byla provedena klasifikace liveness.
imageType	ImageType	Typ obrázku, který obsahuje obdélník tváře, na kterém byla provedena klasifikace aktivity.
timeOffsetWithinFile	integer	Časový posun v souboru rámce, který obsahuje obdélník tváře, na kterém byla provedena klasifikace živé aktivity.

LivenessResponseBody

Tělo odpovědi volání rozhraní API pro detekci aktivity

Name	Typ	Description
livenessDecision	LivenessDecision	Klasifikace aktivity pro cílovou tvář.
modelVersionUsed	LivenessModel	Verze modelu používaná pro klasifikaci aktivity.
target	LivenessOutputsTarget	Konkrétní cíle používané pro klasifikaci aktivity
verifyResult	LivenessWithVerifyOutputs	Výstup ověření tváře. K dispozici pouze v případech, kdy je žádost aktivní s ověřením.

LivenessSessionAuditEntry

Auditovat položku požadavku v relaci.

Name	Typ	Description
clientRequestId	string	Jedinečný clientRequestId, který je odeslán klientem v hlavičce client-request-id.
digest	string	Server vypočítal hodnotu hash pro tento požadavek. Pokud se hodnota hash hlášeného klientem liší od počítané hodnoty hash serveru, došlo k ohrožení integrity zpráv mezi klientem a službou a výsledek by neměl být důvěryhodný. Další informace najdete v průvodcích, jak tuto hodnotu využít k zabezpečení kompletního řešení.
id	integer	Jedinečné ID odkazující na tuto žádost o audit. Toto ID použijte s parametrem dotazu Start a pokračujte na další stránku výsledků auditu.
receivedDateTime	string	Datum a čas UTC, který žádost přijala.
request	AuditRequestInfo	Žádost o tuto položku.
requestId	string	Jedinečné ID požadavku vrácené službou klientovi v hlavičce apim-request-id.
response	AuditLivenessResponseInfo	Odpověď této položky.
sessionId	string	Jedinečné ID relace vytvořené relace. Platnost vyprší 48 hodin po vytvoření nebo může být odstraněna dříve pomocí odpovídající operace DELETE relace.
sessionImageId	string	ID image žádosti o relaci.
verifyImageHash	string	Hodnota hash sha256 obrázku verify-image v požadavku.

LivenessWithVerifyImage

Podrobnosti o tváři pro ověření.

Name	Typ	Description
faceRectangle	FaceRectangle	Oblast tváře, ve které byla provedena klasifikace srovnávacího obrázku.
qualityForRecognition	QualityForRecognition	Kvalita obrázku tváře pro rozpoznávání.

LivenessWithVerifyOutputs

Výstup ověření tváře.

Name	Typ	Description
isIdentical	boolean	Určuje, jestli cílová tvář naživotnost a porovnání odpovídá tváři obrázku.
matchConfidence	number	Míra spolehlivosti ověření tváře cílové tváře a porovnání obrázku ověření tváře.
verifyImage	LivenessWithVerifyImage	Podrobnosti o tváři pro ověření.

QualityForRecognition

Označuje kvalitu obrázku pro rozpoznávání.

Name	Typ	Description
high	string	Vysoce kvalitní.
low	string	Nízká kvalita.
medium	string	Střední kvalita.

Sdílet prostřednictvím

Liveness Session Operations - Get Liveness Session Audit Entries

Parametry identifikátoru URI

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

AADToken

Rozsahy

Příklady

Get LivenessSession Audit Entries

Ukázkový požadavek

Ukázková odpověď

Definice

AuditLivenessResponseInfo

AuditRequestInfo

FaceError

FaceErrorResponse

FaceRectangle

ImageType

LivenessDecision

LivenessModel

LivenessOutputsTarget

LivenessResponseBody

LivenessSessionAuditEntry

LivenessWithVerifyImage

LivenessWithVerifyOutputs

QualityForRecognition

Další materiály