Liveness Session Operations - Create Liveness With Verify Session
Skapa en ny liveness-session med verifiera. 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 livenessidentifiering utan att ge fullständig åtkomst till sin resurs. Skapade sessioner har en begränsad livslängd och tillåter endast klienter att utföra önskad åtgärd innan åtkomsten upphör 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.
Not
-
- Klientåtkomst kan återkallas genom att ta bort sessionen med åtgärden Ta bort liveness med verifierad session.
- Om du vill hämta ett resultat använder du get liveness with verify session (Hämta liveness med verifierad session).
- Om du vill granska de enskilda begäranden som en klient har gjort till resursen använder du List Liveness With Verify Session Audit Entries (Lista liveness med verifiera sessionsgranskningsposter).
Alternativt alternativ: Klientenheten skickar VerifyImage under /detectLivenessWithVerify/singleModal-anropet.
Not
Extra åtgärder bör vidtas för att verifiera att klienten skickar den förväntade VerifyImage.
POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessionsURI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
api
|
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 |
Typ av liveness-läge som klienten ska följa. |
|
| authTokenTimeToLiveInSeconds |
integer |
Sekunder som sessionen ska pågå i. Intervallet är 60 till 8 6400 sekunder. Standardvärdet är 600. |
|
| deviceCorrelationId |
string |
Unikt Guid per varje slutanvändarenhet. Detta är för att ge hastighetsbegränsning och anti-hamring. Om "deviceCorrelationIdSetInClient" är sant i den här begäran måste detta "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. |
|
| enableSessionImage |
boolean |
Om sessionsbilden ska lagras eller inte. |
|
| livenessSingleModalModel |
Modellversionen som används för liveness-klassificering. Det här är en valfri parameter, och om detta inte anges väljs den senaste modellversionen som stöds |
||
| returnVerifyImageHash |
boolean |
Oavsett om du returnerar verifieringsbildens hash eller inte. |
|
| sendResultsToClient |
boolean |
Om svarstexten "200 – Lyckad" ska kunna skickas till klienten eller inte, vilket kan vara oönskat av säkerhetsskäl. Standardvärdet är falskt, klienterna får ett tomt brödtextsvar "204 – NoContent". Oavsett val innehåller anropet Session GetResult alltid en svarstext som gör att affärslogik kan implementeras. |
|
| verifyConfidenceThreshold |
number |
Tröskelvärde för konfidens för ansiktsverifieringen. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
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 |
Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string |
Säkerhet
Ocp-Apim-Subscription-Key
Den hemliga nyckeln för din Azure AI Face-prenumeration.
Typ:
apiKey
I:
header
AADToken
The Azure Active Directory OAuth2 Flow
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
Create LivenessWithVerify Session
Exempelbegäran
POST {endpoint}/face/v1.2-preview.1/detectLivenessWithVerify/singleModal/sessions
{
"livenessOperationMode": "Passive",
"sendResultsToClient": true,
"deviceCorrelationIdSetInClient": true,
"deviceCorrelationId": "your_device_correlation_id",
"authTokenTimeToLiveInSeconds": 60
}
Exempelsvar
{
"sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
"authToken": "eyJhbGciOiJFUzI1NiIsIm"
}Definitioner
| Name | Description |
|---|---|
|
Create |
Begäran om att skapa liveness med verifiera session. |
|
Create |
Svar på liveness-session med verifiera skapandet med verifierad avbildning. |
|
Face |
Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages. |
|
Face |
Ett svar som innehåller felinformation. |
|
Face |
En rektangel där ett ansikte kan hittas. |
|
Liveness |
Modellversionen som används för liveness-klassificering. |
|
Liveness |
Liveness-åtgärdsläget för att driva klientens slutanvändarupplevelse. |
|
Liveness |
Detaljerna i ansiktet för verifiering. |
|
Quality |
Anger bildkvalitet för igenkänning. |
CreateLivenessWithVerifySessionJsonContent
Begäran om att skapa liveness med verifiera session.
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| authTokenTimeToLiveInSeconds |
integer |
600 |
Sekunder som sessionen ska pågå i. Intervallet är 60 till 8 6400 sekunder. Standardvärdet är 600. |
| deviceCorrelationId |
string |
Unikt Guid per varje slutanvändarenhet. Detta är för att ge hastighetsbegränsning och anti-hamring. Om "deviceCorrelationIdSetInClient" är sant i den här begäran måste detta "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. |
|
| enableSessionImage |
boolean |
Om sessionsbilden ska lagras eller inte. |
|
| livenessOperationMode |
Typ av liveness-läge som klienten ska följa. |
||
| livenessSingleModalModel |
Modellversionen som används för liveness-klassificering. Det här är en valfri parameter, och om detta inte anges väljs den senaste modellversionen som stöds |
||
| returnVerifyImageHash |
boolean |
Oavsett om du returnerar verifieringsbildens hash eller inte. |
|
| sendResultsToClient |
boolean |
Om svarstexten "200 – Lyckad" ska kunna skickas till klienten eller inte, vilket kan vara oönskat av säkerhetsskäl. Standardvärdet är falskt, klienterna får ett tomt brödtextsvar "204 – NoContent". Oavsett val innehåller anropet Session GetResult alltid en svarstext som gör att affärslogik kan implementeras. |
|
| verifyConfidenceThreshold |
number |
Tröskelvärde för konfidens för ansiktsverifieringen. |
CreateLivenessWithVerifySessionResult
Svar på liveness-session med verifiera skapandet 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änsade behörigheter för att endast utföra den nödvändiga åtgärden och upphör att gälla efter TTL-tiden. Det kan också granskas. |
| 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 hjälp av motsvarande session DELETE-åtgärd. |
| verifyImage |
Detaljerna i ansiktet för verifiering. |
FaceError
Felobjektet. Mer 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 mänsklig läsbar representation av felet. |
FaceErrorResponse
Ett svar som innehåller felinformation.
| Name | Typ | Description |
|---|---|---|
| error |
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 rektangelns övre kant, i bildpunkter. |
| width |
integer |
Rektangelns bredd i bildpunkter. |
LivenessModel
Modellversionen som används för liveness-klassificering.
| Name | Typ | Description |
|---|---|---|
| 2022-10-15-preview.04 |
string |
|
| 2023-12-20-preview.06 |
string |
LivenessOperationMode
Liveness-åtgärdslä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 optimal prestanda. Och därmed har det här läget ett smalt driftkuvert och lämpar sig inte 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 suboptimala 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 driftkuvert. 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 det passiva lägets driftkuvert på webbaserade lösningar. |
LivenessWithVerifyImage
Detaljerna i ansiktet för verifiering.
| Name | Typ | Description |
|---|---|---|
| faceRectangle |
Ansiktsregionen där jämförelsebildens klassificering gjordes. |
|
| qualityForRecognition |
Kvaliteten på ansiktsbilden 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. |