Liveness Session Operations - Get Liveness With Verify Session Result

Service:

Azure AI Services

API-versie:

v1.2-preview.1

Haal het sessieresultaat op van de aanroep detectLivenessWithVerify/singleModal.

GET {endpoint}/face/{apiVersion}/detectLivenessWithVerify/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 om naar deze sessie te verwijzen.

Antwoorden

Name	Type	Description
200 OK	LivenessWithVerifySession	De aanvraag is voltooid.
Other Status Codes	FaceErrorResponse	Een onverwachte foutreactie. 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 Azure Active Directory OAuth2-stroom

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 LivenessWithVerify Session Result

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

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

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 waarin een gezicht kan worden gevonden.
FaceSessionStatus	De huidige status van de sessie.
ImageType	Het type afbeelding.
LivenessDecision	Het resultaat van de classificatie van de liveness.
LivenessModel	De modelversie die wordt gebruikt voor de classificatie van liveness.
LivenessOutputsTarget	De livenessclassificatie voor het doelgezicht.
LivenessResponseBody	De antwoordtekst van het detecteren van liveness-API-aanroep.
LivenessSessionAuditEntry	Controlevermelding voor een aanvraag in sessie.
LivenessWithVerifyImage	Het detail van het gezicht voor verificatie.
LivenessWithVerifyOutputs	De uitvoer van gezichtsverificatie.
LivenessWithVerifySession	Sessieresultaat van detectie van liveness met verificatie.
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 gemeten latentie voor deze aanvraag in milliseconden.
statusCode	integer	De HTTP-statuscode is geretourneerd naar de client.

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

FaceErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	FaceError	Het foutobject.

FaceRectangle

Een rechthoek waarin een gezicht kan worden gevonden.

Name	Type	Description
height	integer	De hoogte van de rechthoek, in pixels.
left	integer	De afstand van de linkerrand als de afbeelding naar de linkerrand van de rechthoek, in pixels.
top	integer	De afstand van de bovenrand als de afbeelding naar 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 het beschikbare resultaat.
Started	string	Sessie is gestart.

ImageType

Het type afbeelding.

Name	Type	Description
Color	string	Kleurafbeelding.
Depth	string	Diepteafbeelding.
Infrared	string	Infrarood beeld.

LivenessDecision

Het resultaat van de classificatie van de liveness.

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 doel gezicht niet classificeren als echt of spoof.

LivenessModel

De modelversie die wordt gebruikt voor de classificatie van liveness.

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

LivenessOutputsTarget

De livenessclassificatie voor het doelgezicht.

Name	Type	Description
faceRectangle	FaceRectangle	De gezichtsregio waar de classificatie van de leeflijkheid is gemaakt.
fileName	string	De bestandsnaam die de gezichtsrechthoek bevat waarop de classificatie van de leeflijkheid is gemaakt.
imageType	ImageType	Het afbeeldingstype dat de gezichtsrechthoek bevat waarop de classificatie van de liveness is gemaakt.
timeOffsetWithinFile	integer	De tijdsverschil in het bestand van het frame dat de gezichtsrechthoek bevat waarop de indeling van de leeflijkheid is gemaakt.

LivenessResponseBody

De antwoordtekst van het detecteren van liveness-API-aanroep.

Name	Type	Description
livenessDecision	LivenessDecision	De livenessclassificatie voor het doelgezicht.
modelVersionUsed	LivenessModel	De modelversie die wordt gebruikt voor de classificatie van liveness.
target	LivenessOutputsTarget	Specifieke doelen die worden gebruikt voor de classificatie van liveness.
verifyResult	LivenessWithVerifyOutputs	De uitvoer van gezichtsverificatie. Alleen beschikbaar wanneer de aanvraag liveness is bij verificatie.

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 berekende samenvatting van de server voor deze aanvraag. Als de door de client gerapporteerde samenvatting verschilt van de berekende samenvatting van de server, is de berichtintegriteit tussen de client en service aangetast en mag het resultaat niet worden vertrouwd. Zie voor meer informatie de handleidingen over het gebruik van deze waarde om uw end-to-end-oplossing te beveiligen.
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 wordt geretourneerd aan de client 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 deze is gemaakt of kan eerder worden verwijderd met behulp van de bijbehorende sessie DELETE-bewerking.
sessionImageId	string	De afbeeldings-id van de sessieaanvraag.
verifyImageHash	string	De sha256-hash van de verify-image in de aanvraag.

LivenessWithVerifyImage

Het detail 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	Hiermee wordt aangegeven of het doellevensgezicht en het vergelijkingsgezicht overeenkomen.
matchConfidence	number	Het gezichtsleven van het doelgezicht en het vertrouwen van de gezichtsverificatie van de vergelijkingsafbeelding.
verifyImage	LivenessWithVerifyImage	Het detail van het gezicht voor verificatie.

LivenessWithVerifySession

Sessieresultaat van detectie van liveness met verificatie.

Name	Type	Default value	Description
authTokenTimeToLiveInSeconds	integer	600	Seconden waarop 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 elk 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 om naar deze sessie te verwijzen.
result	LivenessSessionAuditEntry		Het laatste controleresultaat van de sessie wordt alleen ingevuld als status == 'ResultAvailable'.
sessionExpired	boolean		Of de sessie al dan niet is verlopen.
sessionStartDateTime	string		Datum/tijd waarop deze sessie is gestart door de client.
status	FaceSessionStatus		De huidige status van de sessie.

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.