Liveness Session Operations - Create Liveness With Verify Session

Referens

Service:: Azure AI Services

API Version:: v1.1-preview.1

Skapa en ny liveness-session med verifiering. Klientenheten skickar VerifyImage under /detectLivenessWithVerify/singleModal-anropet.
En session är bäst för klientenhetsscenarier där utvecklare vill auktorisera en klientenhet att endast utföra en liveness-identifiering utan att ge fullständig åtkomst till deras resurs. Skapade sessioner har en begränsad livslängd och tillåter endast klienter att utföra önskad åtgärd innan åtkomsten har upphört att gälla.

Behörigheter omfattar...

- Möjlighet att anropa /detectLivenessWithVerify/singleModal för upp till 3 återförsök.
- En tokenlivslängd på 10 minuter.

Anteckning

- Klientåtkomst kan återkallas genom att ta bort sessionen med hjälp av åtgärden Ta bort liveness med verifierad session.
- Om du vill hämta ett resultat använder du Get Liveness With Verify-sessionen.
- Om du vill granska enskilda begäranden som en klient har gjort till din resurs använder du list liveness with verify session audit entries (Lista liveness with Verify Session Audit Entries).

Alternativt alternativ: Klientenheten skickar VerifyImage under anropet /detectLivenessWithVerify/singleModal.

Anteckning

Extra åtgärder bör vidtas för att verifiera att klienten skickar den förväntade VerifyImage.

POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions

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

Begärandetext

Name	Obligatorisk	Typ	Description
livenessOperationMode	True	LivenessOperationMode	Typ av liveness-läge som klienten ska följa.
authTokenTimeToLiveInSeconds		integer	Sekunder som sessionen ska pågå i. Intervallet är 60 till 86400 sekunder. Standardvärdet är 600.
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.
deviceCorrelationIdSetInClient		boolean	Om klienten ska kunna ange ett eget "deviceCorrelationId" via Vision SDK eller inte. Standardvärdet är falskt och "deviceCorrelationId" måste anges i den här begärandetexten.
sendResultsToClient		boolean	Om svarstexten "200 – Lyckades" ska kunna skickas till klienten eller inte, vilket kan vara oönskat av säkerhetsskäl. Standardvärdet är falskt. Klienterna får svaret "204 – NoContent" tom brödtext. Oavsett val innehåller anropet av Session GetResult alltid ett svarstext som gör att affärslogik kan implementeras.

Svar

Name	Typ	Description
200 OK	CreateLivenessWithVerifySessionResult	Ett lyckat anrop skapar en session för en klientenhet och anger en auktoriseringstoken för användning av klientprogrammet för ett begränsat syfte och tid.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Name

Typ

Description

200 OK

CreateLivenessWithVerifySessionResult

Ett lyckat anrop skapar en session för en klientenhet och anger en auktoriseringstoken för användning av klientprogrammet för ett begränsat syfte och tid.

Other Status Codes

FaceErrorResponse

Ett oväntat felsvar.

Headers

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

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

Exempel

Create LivenessWithVerify Session

Sample Request

HTTP

POST {endpoint}/face/v1.1-preview.1/detectLivenessWithVerify/singleModal/sessions

{
  "livenessOperationMode": "Passive",
  "sendResultsToClient": true,
  "deviceCorrelationIdSetInClient": true,
  "deviceCorrelationId": "your_device_correlation_id",
  "authTokenTimeToLiveInSeconds": 60
}

Sample Response

Status code:: 200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm"
}

Definitioner

Name	Description
CreateLivenessSessionContent	Begäran om att skapa liveness-session.
CreateLivenessWithVerifySessionResult	Svar på liveness-session med verifieringsskapande med verifierad avbildning.
FaceError	Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns i 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.
LivenessOperationMode	Liveness-läget för att driva klientens slutanvändarupplevelse.
LivenessWithVerifyImage	Detaljerna i ansiktet för verifiering.
QualityForRecognition	Anger bildkvalitet för igenkänning.

CreateLivenessSessionContent

Begäran om att skapa liveness-session.

Name	Typ	Standardvärde	Description
authTokenTimeToLiveInSeconds	integer	600	Sekunder som sessionen ska pågå i. Intervallet är 60 till 86400 sekunder. Standardvärdet är 600.
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.
deviceCorrelationIdSetInClient	boolean		Om klienten ska kunna ange ett eget "deviceCorrelationId" via Vision SDK eller inte. Standardvärdet är falskt och "deviceCorrelationId" måste anges i den här begärandetexten.
livenessOperationMode	LivenessOperationMode		Typ av liveness-läge som klienten ska följa.
sendResultsToClient	boolean		Om svarstexten "200 – Lyckades" ska kunna skickas till klienten eller inte, vilket kan vara oönskat av säkerhetsskäl. Standardvärdet är falskt. Klienterna får svaret "204 – NoContent" tom brödtext. Oavsett val innehåller anropet av Session GetResult alltid ett svarstext som gör att affärslogik kan implementeras.

CreateLivenessWithVerifySessionResult

Svar på liveness-session med verifieringsskapande med verifierad avbildning.

Name	Typ	Description
authToken	string	Ägartoken för att tillhandahålla autentisering för Vision SDK som körs i ett klientprogram. Den här ägartoken har begränsad behörighet att endast utföra den nödvändiga åtgärden och upphör att gälla efter TTL-tiden. Det är också granskningsbart.
sessionId	string	Det unika sessions-ID:t för den skapade sessionen. Den upphör att gälla 48 timmar efter att den skapades eller kan tas bort tidigare med motsvarande session DELETE-åtgärd.
verifyImage	LivenessWithVerifyImage	Detaljerna i ansiktet för verifiering.

FaceError

Felobjektet. Omfattande information om felkoder och meddelanden som returneras av ansiktstjänsten finns i 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 läsbar återgivning 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 den vänstra kanten om bilden till den vänstra kanten av rektangeln, i bildpunkter.
top	integer	Avståndet från den övre kanten om bilden till den övre kanten av rektangeln, i bildpunkter.
width	integer	Rektangelns bredd i bildpunkter.

LivenessOperationMode

Liveness-läget för att driva klientens slutanvändarupplevelse.

Name	Typ	Description
Passive	string	Använder en passiv liveness-teknik som inte kräver några ytterligare åtgärder från användaren. Kräver normal inomhusbelysning och hög skärmljusstyrka för optimala prestanda. Och därmed har det här läget ett smalt driftskuvert och är inte lämpligt för scenarier som kräver att slutanvändaren är i ljusa ljusförhållanden. Obs! Det här är det enda läget som stöds för lösningen Mobile (iOS och Android).
PassiveActive	string	Det här läget använder en hybrid passiv eller aktiv liveness-teknik som kräver användarsamarbete. Den är optimerad för att kräva aktiv rörelse endast under icke-optimala ljusförhållanden. Till skillnad från det passiva läget har det här läget inga belysningsbegränsningar och erbjuder därför ett bredare driftskuvert. Det här läget är att föredra på webbaserade lösningar på grund av bristen på automatisk skärmljusstyrka som är tillgänglig i webbläsare, vilket hindrar passivlägets driftkuvert på webbaserade lösningar.

LivenessWithVerifyImage

Detaljerna i ansiktet för verifiering.

Name	Typ	Description
faceRectangle	FaceRectangle	Ansiktsregionen där jämförelsebildens klassificering gjordes.
qualityForRecognition	QualityForRecognition	Kvalitet på ansiktsbild för igenkänning.

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.

Dela via

Liveness Session Operations - Create Liveness With Verify Session

URI-parametrar

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

AADToken

Scopes

Exempel

Create LivenessWithVerify Session

Sample Request

Sample Response

Definitioner

CreateLivenessSessionContent

CreateLivenessWithVerifySessionResult

FaceError

FaceErrorResponse

FaceRectangle

LivenessOperationMode

LivenessWithVerifyImage

QualityForRecognition

Ytterligare resurser