Delen via


Liveness Session Operations - Get Liveness Session Result

Sessieresultaat ophalen van detectLiveness/singleModal-aanroep.

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

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

sessionId
path True

string

De unieke id die naar deze sessie verwijst.

Antwoorden

Name Type Description
200 OK

LivenessSession

De aanvraag is geslaagd.

Other Status Codes

FaceErrorResponse

Een onverwacht foutbericht.

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 OAuth2-stroom van Azure Active Directory

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 LivenessSession Result

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AuditLivenessResponseInfo

Controlevermelding voor een antwoord in de sessie.

AuditRequestInfo

Controlevermelding voor een aanvraag in de sessie.

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.

FaceRectangle

Een rechthoek waarbinnen een gezicht te vinden is.

FaceSessionStatus

De huidige status van de sessie.

ImageType

Het type afbeelding.

LivenessDecision

Het resultaat van de levendigheidsclassificatie.

LivenessModel

De modelversie die wordt gebruikt voor de classificatie van de activiteit.

LivenessOutputsTarget

De classificatie van de activiteit voor het doelgezicht.

LivenessResponseBody

De antwoordtekst van de DETECTIE-API-aanroep.

LivenessSession

Sessieresultaat van detectie van liveness.

LivenessSessionAuditEntry

Controlevermelding voor een aanvraag in sessie.

LivenessWithVerifyImage

De details van het gezicht voor verificatie.

LivenessWithVerifyOutputs

De uitvoer van gezichtsverificatie.

QualityForRecognition

Geeft de kwaliteit van de afbeelding aan voor herkenning.

AuditLivenessResponseInfo

Controlevermelding voor een antwoord in de sessie.

Name Type Description
body

LivenessResponseBody

De hoofdtekst van het antwoord. Het schema van dit veld is afhankelijk van de request.url en request.method die door de client worden gebruikt.

latencyInMilliseconds

integer

De server heeft de latentie voor deze aanvraag in milliseconden gemeten.

statusCode

integer

De HTTP-statuscode die naar de client is geretourneerd.

AuditRequestInfo

Controlevermelding voor een aanvraag in de sessie.

Name Type Description
contentLength

integer

De lengte van de aanvraagbody in bytes.

contentType

string

Het inhoudstype van de aanvraag.

method

string

De HTTP-methode van de aanvraag (bijvoorbeeld GET, POST, DELETE).

url

string

De relatieve URL en query van de liveness-aanvraag.

userAgent

string

De gebruikersagent die is gebruikt om de aanvraag in te dienen.

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 door mensen leesbare weergave van de fout.

FaceErrorResponse

Een antwoord met foutdetails.

Name Type Description
error

FaceError

Het foutobject.

FaceRectangle

Een rechthoek waarbinnen een gezicht te vinden is.

Name Type Description
height

integer

De hoogte van de rechthoek, in pixels.

left

integer

De afstand van de linkerrand als de afbeelding tot de linkerrand van de rechthoek, in pixels.

top

integer

De afstand van de bovenrand als de afbeelding tot de bovenrand van de rechthoek, in pixels.

width

integer

De breedte van de rechthoek, in pixels.

FaceSessionStatus

De huidige status van de sessie.

Name Type Description
NotStarted

string

De sessie is niet gestart.

ResultAvailable

string

Sessie heeft beschikbaar resultaat.

Started

string

De sessie is gestart.

ImageType

Het type afbeelding.

Name Type Description
Color

string

Afbeelding in kleur.

Depth

string

Diepteafbeelding.

Infrared

string

Infraroodbeeld.

LivenessDecision

Het resultaat van de levendigheidsclassificatie.

Name Type Description
realface

string

Het algoritme heeft het doelgezicht geclassificeerd als echt.

spoofface

string

Het algoritme heeft het doelgezicht geclassificeerd als een adresvervalsing.

uncertain

string

Het algoritme kan het doelgezicht niet classificeren als echt of spoof.

LivenessModel

De modelversie die wordt gebruikt voor de classificatie van de activiteit.

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

De classificatie van de activiteit voor het doelgezicht.

Name Type Description
faceRectangle

FaceRectangle

Het gezichtsgebied waarop de levendigheidsclassificatie is gemaakt.

fileName

string

De bestandsnaam die de rechthoek voor het gezicht bevat waarop de classificatie van de activiteit is gemaakt.

imageType

ImageType

Het afbeeldingstype dat de rechthoek bevat waarop de levendigheidsclassificatie is gemaakt.

timeOffsetWithinFile

integer

De tijdsverschil in het bestand van het frame dat de rechthoek bevat waarop de classificatie van de levendigheid is gemaakt.

LivenessResponseBody

De antwoordtekst van de DETECTIE-API-aanroep.

Name Type Description
livenessDecision

LivenessDecision

De classificatie van de activiteit voor het doelgezicht.

modelVersionUsed

LivenessModel

De modelversie die wordt gebruikt voor de classificatie van de activiteit.

target

LivenessOutputsTarget

Specifieke doelen die worden gebruikt voor de classificatie van de activiteit.

verifyResult

LivenessWithVerifyOutputs

De uitvoer van gezichtsverificatie. Alleen beschikbaar wanneer de aanvraag liveness met verify is.

LivenessSession

Sessieresultaat van detectie van liveness.

Name Type Default value Description
authTokenTimeToLiveInSeconds

integer

600

Seconden dat 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 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 die naar deze sessie verwijst.

result

LivenessSessionAuditEntry

Het meest recente controleresultaat van de sessie wordt alleen ingevuld als status == 'ResultAvailable'.

sessionExpired

boolean

Of de sessie is verlopen.

sessionStartDateTime

string

Datum/tijd waarop deze sessie is gestart door de client.

status

FaceSessionStatus

De huidige status van de sessie.

LivenessSessionAuditEntry

Controlevermelding voor een aanvraag in sessie.

Name Type Description
clientRequestId

string

De unieke clientRequestId die door de client wordt verzonden in de header 'client-request-id'.

digest

string

De server berekende samenvatting voor deze aanvraag. Als de gerapporteerde digest van de client afwijkt van de berekende digest van de server, is de berichtintegriteit tussen de client en de service aangetast en mag het resultaat niet worden vertrouwd. Zie handleidingen voor het gebruik van deze waarde om uw end-to-end-oplossing te beveiligen voor meer informatie.

id

integer

De unieke id die naar deze controleaanvraag verwijst. Gebruik deze id met de queryparameter 'start' om door te gaan naar de volgende pagina met controleresultaten.

receivedDateTime

string

De UTC-datum/tijd waarop de aanvraag is ontvangen.

request

AuditRequestInfo

De aanvraag van deze vermelding.

requestId

string

De unieke requestId die door de service naar de client wordt geretourneerd in de header 'apim-request-id'.

response

AuditLivenessResponseInfo

Het antwoord van deze vermelding.

sessionId

string

De unieke sessionId van de gemaakte sessie. Het verloopt 48 uur nadat het is gemaakt of kan eerder worden verwijderd met behulp van de bijbehorende sessie DELETE-bewerking.

LivenessWithVerifyImage

De details van het gezicht voor verificatie.

Name Type Description
faceRectangle

FaceRectangle

Het gezichtsgebied waar de classificatie van de vergelijkingsafbeelding is gemaakt.

qualityForRecognition

QualityForRecognition

Kwaliteit van gezichtsafbeelding voor herkenning.

LivenessWithVerifyOutputs

De uitvoer van gezichtsverificatie.

Name Type Description
isIdentical

boolean

Of de doelweergave en het vergelijkingsafbeeldingsgezicht overeenkomen.

matchConfidence

number

De betrouwbaarheid van de gezichtsherkenning van het doelgezicht en de vergelijkingsafbeelding voor gezichtsverificatie.

verifyImage

LivenessWithVerifyImage

De details van het gezicht voor verificatie.

QualityForRecognition

Geeft de kwaliteit van de afbeelding aan voor herkenning.

Name Type Description
high

string

Hoge kwaliteit.

low

string

Lage kwaliteit.

medium

string

Gemiddelde kwaliteit.