Megosztás a következőn keresztül:


Liveness Session Operations - Get Liveness Session Result

A detectLiveness/singleModal hívás munkamenet-eredményének lekérése.

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

URI-paraméterek

Name In Kötelező Típus Description
apiVersion
path True

string

API-verzió

endpoint
path True

string

uri

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://{resource-name}.cognitiveservices.azure.com).

sessionId
path True

string

A munkamenetre hivatkozó egyedi azonosító.

Válaszok

Name Típus Description
200 OK

LivenessSession

A kérés sikeres volt.

Other Status Codes

FaceErrorResponse

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Biztonság

Ocp-Apim-Subscription-Key

Az Azure AI Face-előfizetés titkos kulcsa.

Típus: apiKey
In: header

AADToken

Az Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://api.example.com/oauth2/authorize
Jogkivonat URL-címe: https://api.example.com/oauth2/token

Hatókörök

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

Példák

Get LivenessSession Result

Mintakérelem

GET {endpoint}/face/v1.1-preview.1/detectLiveness/singleModal/sessions/b12e033e-bda7-4b83-a211-e721c661f30e

Mintaválasz

{
  "id": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "createdDateTime": "2024-03-05T11:07:29.698Z",
  "sessionStartDateTime": "2024-03-05T11:07:29.698Z",
  "sessionExpired": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 600,
  "status": "NotStarted",
  "result": {
    "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.1-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"
  }
}

Definíciók

Name Description
AuditLivenessResponseInfo

Naplóbejegyzés egy válaszhoz a munkamenetben.

AuditRequestInfo

Naplóbejegyzés egy kéréshez a munkamenetben.

FaceError

A hibaobjektum. A Face Service által visszaadott hibakódokkal és üzenetekkel kapcsolatos átfogó részletekért tekintse meg a következő hivatkozást: https://aka.ms/face-error-codes-and-messages.

FaceErrorResponse

A hiba részleteit tartalmazó válasz.

FaceRectangle

Egy téglalap, amelyen belül egy arc található.

FaceSessionStatus

A munkamenet aktuális állapota.

ImageType

A kép típusa.

LivenessDecision

A liveness besorolás eredménye.

LivenessModel

Az élőségi besoroláshoz használt modellverzió.

LivenessOutputsTarget

A cél arc élőségi besorolása.

LivenessResponseBody

A liveness API-hívás észlelésének választörzse.

LivenessSession

Az élőség észlelésének munkameneteredménye.

LivenessSessionAuditEntry

Naplóbejegyzés egy kéréshez a munkamenetben.

LivenessWithVerifyImage

Az ellenőrzéshez használt arc részletei.

LivenessWithVerifyOutputs

Az arcellenőrzés kimenete.

QualityForRecognition

A képminőséget jelzi a felismeréshez.

AuditLivenessResponseInfo

Naplóbejegyzés egy válaszhoz a munkamenetben.

Name Típus Description
body

LivenessResponseBody

A válasz törzse. A mező sémája az ügyfél által használt request.url és request.method metódustól függ.

latencyInMilliseconds

integer

A kiszolgáló ezredmásodpercben mérte a kérés késését.

statusCode

integer

Az ügyfélnek visszaadott HTTP-állapotkód.

AuditRequestInfo

Naplóbejegyzés egy kéréshez a munkamenetben.

Name Típus Description
contentLength

integer

A kérelem törzsének hossza bájtban.

contentType

string

A kérelem tartalomtípusa.

method

string

A kérés HTTP-metódusa (pl. GET, POST, DELETE).

url

string

Az élőségi kérelem relatív URL-címe és lekérdezése.

userAgent

string

A kérelem elküldéséhez használt felhasználói ügynök.

FaceError

A hibaobjektum. A Face Service által visszaadott hibakódokkal és üzenetekkel kapcsolatos átfogó részletekért tekintse meg a következő hivatkozást: https://aka.ms/face-error-codes-and-messages.

Name Típus Description
code

string

A kiszolgáló által definiált hibakódok egyike.

message

string

A hiba emberi olvasásra alkalmas ábrázolása.

FaceErrorResponse

A hiba részleteit tartalmazó válasz.

Name Típus Description
error

FaceError

A hibaobjektum.

FaceRectangle

Egy téglalap, amelyen belül egy arc található.

Name Típus Description
height

integer

A téglalap magassága képpontban.

left

integer

A bal széltől mért távolság, ha a kép a téglalap bal szélétől képpontban van.

top

integer

A felső széltől mért távolság, ha a kép a téglalap felső széléig, képpontban kifejezve.

width

integer

A téglalap szélessége képpontban.

FaceSessionStatus

A munkamenet aktuális állapota.

Name Típus Description
NotStarted

string

A munkamenet nem indult el.

ResultAvailable

string

A munkamenet elérhető eredménnyel rendelkezik.

Started

string

A munkamenet elindult.

ImageType

A kép típusa.

Name Típus Description
Color

string

Színes kép.

Depth

string

Mélységi kép.

Infrared

string

Infravörös kép.

LivenessDecision

A liveness besorolás eredménye.

Name Típus Description
realface

string

Az algoritmus valósnak minősítette a cél arcát.

spoofface

string

Az algoritmus hamisnak minősítette a cél arcot.

uncertain

string

Az algoritmus nem tudta valódiként vagy hamisként besorolni a célarcot.

LivenessModel

Az élőségi besoroláshoz használt modellverzió.

Name Típus Description
2020-02-15-preview.01

string

2021-11-12-preview.03

string

2022-10-15-preview.04

string

2023-03-02-preview.05

string

LivenessOutputsTarget

A cél arc élőségi besorolása.

Name Típus Description
faceRectangle

FaceRectangle

Az arcterület, amelyen az élőségi besorolás történt.

fileName

string

Az arc téglalapot tartalmazó fájlnév, amelyen az élőségi besorolás történt.

imageType

ImageType

Az az arc téglalapot tartalmazó képtípus, amelyen az élőségi besorolás történt.

timeOffsetWithinFile

integer

Az időeltolódás a keret fájljában, amely azt az arc téglalapot tartalmazza, amelyen az élőségi besorolás történt.

LivenessResponseBody

A liveness API-hívás észlelésének választörzse.

Name Típus Description
livenessDecision

LivenessDecision

A cél arc élőségi besorolása.

modelVersionUsed

LivenessModel

Az élőségi besoroláshoz használt modellverzió.

target

LivenessOutputsTarget

Az élőség besorolásához használt konkrét célok.

verifyResult

LivenessWithVerifyOutputs

Az arcellenőrzés kimenete. Csak akkor érhető el, ha a kérelem élő állapotú az ellenőrzéssel.

LivenessSession

Az élőség észlelésének munkameneteredménye.

Name Típus Alapértelmezett érték Description
authTokenTimeToLiveInSeconds

integer

600

A munkamenet időtartama másodpercben. A tartomány 60–86400 másodperc. Az alapértelmezett érték 600.

createdDateTime

string

A munkamenet létrehozásának dátumideje.

deviceCorrelationId

string

Egyedi GUID minden végfelhasználói eszközön. Ez a sebességkorlátozás és a kalapálás elleni védelem biztosítása. Ha a "deviceCorrelationIdSetInClient" igaz ebben a kérésben, ennek a "deviceCorrelationId"-nek null értékűnek kell lennie.

id

string

A munkamenetre hivatkozó egyedi azonosító.

result

LivenessSessionAuditEntry

A legutóbbi munkamenet-naplózási eredmény csak akkor van feltöltve, ha az állapot == "ResultAvailable".

sessionExpired

boolean

Azt jelzi, hogy a munkamenet lejárt-e.

sessionStartDateTime

string

DateTime, amikor az ügyfél elindította ezt a munkamenetet.

status

FaceSessionStatus

A munkamenet aktuális állapota.

LivenessSessionAuditEntry

Naplóbejegyzés egy kéréshez a munkamenetben.

Name Típus Description
clientRequestId

string

Az ügyfél által a client-request-id fejlécben küldött egyedi clientRequestId azonosító.

digest

string

A kiszolgáló számított kivonatot ehhez a kéréshez. Ha az ügyfél által jelentett kivonat eltér a kiszolgáló által számított kivonattól, akkor az ügyfél és a szolgáltatás közötti üzenetintegritás sérült, és az eredmény nem megbízható. További információkért tekintse meg, hogyan használhatja ki ezt az értéket a végpontok közötti megoldás védelméhez.

id

integer

Az auditkérésre hivatkozó egyedi azonosító. Ezzel az azonosítóval a "start" lekérdezési paraméterrel folytathatja a naplózási eredmények következő oldalának megnyitását.

receivedDateTime

string

A kérelem fogadásának UTC DateTime időpontja.

request

AuditRequestInfo

A bejegyzés kérése.

requestId

string

A szolgáltatás által az ügyfélnek visszaadott egyedi requestId azonosító az "apim-request-id" fejlécben.

response

AuditLivenessResponseInfo

A bejegyzés válasza.

sessionId

string

A létrehozott munkamenet egyedi sessionId azonosítója. A létrehozás után 48 órával lejár, vagy a megfelelő MUNKAMENET-TÖRLÉS művelettel hamarabb törölhető.

LivenessWithVerifyImage

Az ellenőrzéshez használt arc részletei.

Name Típus Description
faceRectangle

FaceRectangle

Az arcterület, ahol az összehasonlító kép besorolása történt.

qualityForRecognition

QualityForRecognition

Az arckép minősége a felismeréshez.

LivenessWithVerifyOutputs

Az arcellenőrzés kimenete.

Name Típus Description
isIdentical

boolean

Azt jelzi, hogy a cél élő arc és az összehasonlítási kép arca megegyezik-e.

matchConfidence

number

A cél arc élő arc és az összehasonlítás kép arc ellenőrzési megbízhatósága.

verifyImage

LivenessWithVerifyImage

Az ellenőrzéshez használt arc részletei.

QualityForRecognition

A képminőséget jelzi a felismeréshez.

Name Típus Description
high

string

Kiváló minőség.

low

string

Gyenge minőség.

medium

string

Közepes minőség.