Liveness Session Operations - Create Liveness Session

Tjänst:

Azure AI Services

API-version:

v1.1-preview.1

Skapa en ny session för identifiering av liveness.
En session passar 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 sina resurser. 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 /detectLiveness/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-session. Om du vill hämta ett resultat använder du Get Liveness-sessionen. Om du vill granska enskilda begäranden som en klient har gjort till din resurs använder du granskningsposterna för listsessioner i realtid.

POST {endpoint}/face/{apiVersion}/detectLiveness/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 sessionen ska pågå i. Intervallet är 60 till 86 400 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 en svarstext som gör det möjligt att implementera affärslogik.

Svar

Name	Typ	Description
200 OK	CreateLivenessSessionResult	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 en begränsad tid.
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

Create Liveness Session

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
CreateLivenessSessionContent	Begäran om att skapa liveness-session.
CreateLivenessSessionResult	Svar på skapande av liveness-session.
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.
LivenessOperationMode	Liveness-läget för att driva klientens slutanvändarupplevelse.

CreateLivenessSessionContent

Begäran om att skapa liveness-session.

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.
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 en svarstext som gör det möjligt att implementera affärslogik.

CreateLivenessSessionResult

Svar på skapande av liveness-session.

Name	Typ	Description
authToken	string	Ägartoken för att tillhandahålla autentisering för Vision SDK som körs i ett klientprogram. Denna ä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 har skapats eller kan tas bort tidigare med hjälp av motsvarande session DELETE-åtgärd.

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.

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ärmintensitet för optimal prestanda. Och därför har det här läget ett smalt driftkuvert och passar 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 endast kräva aktiv rörelse 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ärmed ett bredare driftkuvert. Det här läget är att föredra på webbaserade lösningar på grund av bristen på automatisk skärm ljusstyrka som är tillgänglig i webbläsare som hindrar det passiva lägets driftkuvert på webbaserade lösningar.