Dela via


Liveness Session Operations - Get Liveness Session Result

Hämta sessionsresultat för detectLiveness/singleModal-anrop.

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

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).

sessionId
path True

string

Det unika ID som ska referera till den här sessionen.

Svar

Name Typ Description
200 OK

LivenessSession

Begäran har slutförts.

Other Status Codes

FaceErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

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

Typ: apiKey
I: header

AADToken

Azure Active Directory OAuth2-flödet

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

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

Exempel

Get LivenessSession Result

Exempelbegäran

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

Exempelsvar

{
  "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"
  }
}

Definitioner

Name Description
AuditLivenessResponseInfo

Granskningspost för ett svar i sessionen.

AuditRequestInfo

Granskningspost för en begäran i sessionen.

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.

FaceRectangle

En rektangel där ett ansikte kan hittas.

FaceSessionStatus

Den aktuella statusen för sessionen.

ImageType

Typ av bild.

LivenessDecision

Resultatet av livenessklassificeringen.

LivenessModel

Den modellversion som används för liveness-klassificering.

LivenessOutputsTarget

Liveness-klassificeringen för mål ansikte.

LivenessResponseBody

Svarstexten för API-anropet detect liveness.

LivenessSession

Sessionsresultat för identifiering av liveness.

LivenessSessionAuditEntry

Granskningspost för en begäran i sessionen.

LivenessWithVerifyImage

Detaljerna i ansiktet för verifiering.

LivenessWithVerifyOutputs

Ansiktsverifieringens utdata.

QualityForRecognition

Anger bildkvalitet för igenkänning.

AuditLivenessResponseInfo

Granskningspost för ett svar i sessionen.

Name Typ Description
body

LivenessResponseBody

Svarstexten. Schemat för det här fältet beror på vilken request.url och request.method som används av klienten.

latencyInMilliseconds

integer

Servern mätte svarstiden för den här begäran i millisekunder.

statusCode

integer

HTTP-statuskoden returnerades till klienten.

AuditRequestInfo

Granskningspost för en begäran i sessionen.

Name Typ Description
contentLength

integer

Längden på begärandetexten i byte.

contentType

string

Innehållstypen för begäran.

method

string

HTTP-metoden för begäran (t.ex. GET, POST, DELETE).

url

string

Den relativa URL:en och frågan för liveness-begäran.

userAgent

string

Användaragenten som används för att skicka begäran.

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.

FaceRectangle

En rektangel där ett ansikte kan hittas.

Name Typ Description
height

integer

Rektangelns höjd i bildpunkter.

left

integer

Avståndet från vänsterkanten om bilden till vänsterkanten i rektangeln, i bildpunkter.

top

integer

Avståndet från den övre kanten om bilden till rektangelns övre kant, i bildpunkter.

width

integer

Rektangelns bredd i bildpunkter.

FaceSessionStatus

Den aktuella statusen för sessionen.

Name Typ Description
NotStarted

string

Sessionen har inte startats.

ResultAvailable

string

Sessionen har tillgängligt resultat.

Started

string

Sessionen har startat.

ImageType

Typ av bild.

Name Typ Description
Color

string

Färgbild.

Depth

string

Djupbild.

Infrared

string

Infraröd bild.

LivenessDecision

Resultatet av livenessklassificeringen.

Name Typ Description
realface

string

Algoritmen har klassificerat måligenkänningen som verklig.

spoofface

string

Algoritmen har klassificerat mål ansikte som en förfalskning.

uncertain

string

Algoritmen kunde inte klassificera mål ansikte som antingen verkliga eller falska.

LivenessModel

Den modellversion som används för liveness-klassificering.

Name Typ 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

Liveness-klassificeringen för mål ansikte.

Name Typ Description
faceRectangle

FaceRectangle

Ansiktsregionen där livenessklassificeringen gjordes.

fileName

string

Filnamnet som innehåller ansiktsrektangeln där liveness-klassificeringen gjordes.

imageType

ImageType

Bildtypen som innehåller ansiktsrektangeln där livenessklassificeringen gjordes.

timeOffsetWithinFile

integer

Tidsförskjutningen i filen i ramen som innehåller ansiktsrektangeln där livenessklassificeringen gjordes.

LivenessResponseBody

Svarstexten för API-anropet detect liveness.

Name Typ Description
livenessDecision

LivenessDecision

Liveness-klassificeringen för målinsiktet.

modelVersionUsed

LivenessModel

Den modellversion som används för liveness-klassificering.

target

LivenessOutputsTarget

Specifika mål som används för liveness-klassificering.

verifyResult

LivenessWithVerifyOutputs

Ansiktsverifieringens utdata. Endast tillgängligt när begäran är liveness med verifiering.

LivenessSession

Sessionsresultat för identifiering av liveness.

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.

result

LivenessSessionAuditEntry

Det senaste sessionsgranskningsresultatet fylls endast i om status == 'ResultAvailable'.

sessionExpired

boolean

Om sessionen har upphört att gälla eller inte.

sessionStartDateTime

string

DateTime när den här sessionen startades av klienten.

status

FaceSessionStatus

Den aktuella statusen för sessionen.

LivenessSessionAuditEntry

Granskningspost för en begäran i sessionen.

Name Typ Description
clientRequestId

string

Det unika clientRequestId som skickas av klienten i rubriken "client-request-id".

digest

string

Servern beräknade sammandrag för den här begäran. Om klientens rapporterade sammandrag skiljer sig från serverns beräknade sammandrag har meddelandeintegriteten mellan klienten och tjänsten komprometterats och resultatet bör inte vara betrott. Mer information finns i guider om hur du använder det här värdet för att skydda din slutpunkt till slutpunkt-lösning.

id

integer

Det unika ID:t som refererar till den här granskningsbegäran. Använd det här ID:t med frågeparametern "start" för att fortsätta till nästa sida med granskningsresultat.

receivedDateTime

string

UTC DateTime som begäran togs emot.

request

AuditRequestInfo

Begäran om den här posten.

requestId

string

Det unika requestId som returneras av tjänsten till klienten i rubriken "apim-request-id".

response

AuditLivenessResponseInfo

Svaret för den här posten.

sessionId

string

Det unika sessions-ID:et för den skapade sessionen. Den upphör att gälla 48 timmar efter att den har skapats eller kan tas bort tidigare med hjälp av motsvarande session DELETE-åtgärd.

LivenessWithVerifyImage

Detaljerna i ansiktet för verifiering.

Name Typ Description
faceRectangle

FaceRectangle

Ansiktsregionen där jämförelsebildens klassificering gjordes.

qualityForRecognition

QualityForRecognition

Kvaliteten på ansiktsbilden för igenkänning.

LivenessWithVerifyOutputs

Ansiktsverifieringens utdata.

Name Typ Description
isIdentical

boolean

Om målets liveness ansikte och jämförelse bild ansiktsmatchning.

matchConfidence

number

Mål ansikte liveness ansikte och jämförelse bild ansikte verifiering konfidens.

verifyImage

LivenessWithVerifyImage

Detaljerna i ansiktet för verifiering.

QualityForRecognition

Anger bildkvalitet för igenkänning.

Name Typ Description
high

string

Hög kvalitet.

low

string

Låg kvalitet.

medium

string

Medelhög kvalitet.