Liveness Session Operations - Create Liveness Session

Service:

Azure AI Services

API-versie:

v1.2-preview.1

Maak een nieuwe detectiesessie.
Een sessie is het meest geschikt voor clientapparaatscenario's waarbij ontwikkelaars een clientapparaat willen autoriseren om alleen een detectie van liveness uit te voeren zonder volledige toegang te verlenen tot hun resource. Gemaakte sessies hebben een beperkte levensduur en autoriseren clients alleen om de gewenste actie uit te voeren voordat de toegang is verlopen.

Machtigingen omvatten...

• • Mogelijkheid om /detectLiveness/singleModal aan te roepen voor maximaal 3 nieuwe pogingen.
  • Een tokenlevensduur van 10 minuten.

Notitie

Clienttoegang kan worden ingetrokken door de sessie te verwijderen met behulp van de bewerking Liveness Session verwijderen. Gebruik de sessie Liveness ophalen om een resultaat op te halen. Als u de afzonderlijke aanvragen wilt controleren die een client heeft ingediend bij uw resource, gebruikt u de vermeldingen lijst livenesssessiecontrole.

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

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

Aanvraagbody

Name	Vereist	Type	Description
livenessOperationMode	True	LivenessOperationMode	Het type livenessmodus dat de client moet volgen.
authTokenTimeToLiveInSeconds		integer (int32) minimum: 60 maximum: 86400	Seconden waarop de sessie moet duren. Het bereik is 60 tot 86400 seconden. De standaardwaarde is 600.
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.
deviceCorrelationIdSetInClient		boolean	Of client nu wel of niet zijn eigen deviceCorrelationId mag instellen via de Vision-SDK. De standaardwaarde is onwaar en 'deviceCorrelationId' moet worden ingesteld in deze aanvraagbody.
enableSessionImage		boolean	Of de sessie-installatiekopieën al dan niet worden opgeslagen.
livenessSingleModalModel		LivenessModel	De modelversie die wordt gebruikt voor de classificatie van liveness. Dit is een optionele parameter en als dit niet is opgegeven, wordt de meest recente ondersteunde modelversie gekozen
sendResultsToClient		boolean	Of een antwoordtekst '200 - Geslaagd' naar de client moet worden verzonden, wat om veiligheidsredenen ongewenst kan zijn. De standaardwaarde is onwaar, clients ontvangen een '204 - NoContent' lege hoofdtekstreactie. Ongeacht de selectie bevat het aanroepen van Sessie GetResult altijd een antwoordtekst waarmee bedrijfslogica kan worden geïmplementeerd.

Antwoorden

Name	Type	Description
200 OK	CreateLivenessSessionResult	Een geslaagde aanroep maakt een sessie voor een clientapparaat en geeft een autorisatietoken op voor gebruik door de clienttoepassing voor een beperkt doel en tijd.
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

Create Liveness Session

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
CreateLivenessSessionContent	Aanvraagmodel voor het maken van een livenesssessie.
CreateLivenessSessionResult	Reactie van het maken van een livenesssessie.
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.
LivenessModel	De modelversie die wordt gebruikt voor de classificatie van liveness.
LivenessOperationMode	De liveness-bewerkingsmodus om de eindgebruikerservaring van de client te stimuleren.

CreateLivenessSessionContent

Object

Aanvraagmodel voor het maken van een livenesssessie.

Name	Type	Default value	Description
authTokenTimeToLiveInSeconds	integer (int32) minimum: 60 maximum: 86400	600	Seconden waarop de sessie moet duren. Het bereik is 60 tot 86400 seconden. De standaardwaarde is 600.
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.
deviceCorrelationIdSetInClient	boolean		Of client nu wel of niet zijn eigen deviceCorrelationId mag instellen via de Vision-SDK. De standaardwaarde is onwaar en 'deviceCorrelationId' moet worden ingesteld in deze aanvraagbody.
enableSessionImage	boolean		Of de sessie-installatiekopieën al dan niet worden opgeslagen.
livenessOperationMode	LivenessOperationMode		Het type livenessmodus dat de client moet volgen.
livenessSingleModalModel	LivenessModel		De modelversie die wordt gebruikt voor de classificatie van liveness. Dit is een optionele parameter en als dit niet is opgegeven, wordt de meest recente ondersteunde modelversie gekozen
sendResultsToClient	boolean		Of een antwoordtekst '200 - Geslaagd' naar de client moet worden verzonden, wat om veiligheidsredenen ongewenst kan zijn. De standaardwaarde is onwaar, clients ontvangen een '204 - NoContent' lege hoofdtekstreactie. Ongeacht de selectie bevat het aanroepen van Sessie GetResult altijd een antwoordtekst waarmee bedrijfslogica kan worden geïmplementeerd.

CreateLivenessSessionResult

Object

Reactie van het maken van een livenesssessie.

Name	Type	Description
authToken	string	Bearer-token voor verificatie voor de Vision-SDK die wordt uitgevoerd op een clienttoepassing. Dit Bearer-token heeft beperkte machtigingen om alleen de vereiste actie uit te voeren en verloopt na de TTL-tijd. Het is ook controleerbaar.
sessionId	string	De unieke sessie-id 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.

FaceError

Object

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

Object

Een antwoord met foutdetails.

Name	Type	Description
error	FaceError	Het foutobject.

LivenessModel

Inventarisatie

De modelversie die wordt gebruikt voor de classificatie van liveness.

Waarde	Description
2022-10-15-preview.04
2023-12-20-preview.06

LivenessOperationMode

Inventarisatie

De liveness-bewerkingsmodus om de eindgebruikerservaring van de client te stimuleren.

Waarde	Description
Passive	Maakt gebruik van een passieve livenesstechniek waarvoor geen extra acties van de gebruiker nodig zijn. Vereist normale binnenverlichting en hoge schermhelderheid voor optimale prestaties. Deze modus heeft dus een smalle operationele envelop en is niet geschikt voor scenario's waarvoor de eindgebruiker in heldere lichtomstandigheden moet zijn. Opmerking: dit is de enige ondersteunde modus voor de oplossing Mobile (iOS en Android).
PassiveActive	Deze modus maakt gebruik van een hybride passieve of actieve livenesstechniek die gebruikerssamenwerking vereist. Het is geoptimaliseerd om actieve beweging alleen onder suboptimale verlichtingsomstandigheden te vereisen. In tegenstelling tot de passieve modus heeft deze modus geen verlichtingsbeperkingen en biedt deze dus een bredere operationele envelop. Deze modus verdient de voorkeur aan weboplossingen vanwege het ontbreken van automatische schermhelderheidscontrole die beschikbaar is in browsers die de operationele envelop van de passieve modus op weboplossingen belemmeren.