Liveness Session Operations - Create Liveness With Verify Session With Verify Image

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Skapa en ny liveness-session med verifiera. Ange verifieringsbilden när sessionen skapas.
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).

Rekommenderat alternativ: VerifyImage tillhandahålls när sessionen skapas.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Parameters	formData	True	string	Parametrarna för att skapa en session.
VerifyImage	formData	True	file	Bildströmmen för verifiering. Innehållsborttagningshuvudfält för den här delen måste ha filnamn.
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).

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. 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 with VerifyImage

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "verifyImage": {
    "faceRectangle": {
      "width": 78,
      "height": 78,
      "left": 394,
      "top": 54
    },
    "qualityForRecognition": "high"
  }
}

Definitioner

Name	Description
CreateLivenessWithVerifySessionResult	Svar på liveness-session med verifiera skapandet med verifierad avbildning.
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.
FaceErrorResponse	Ett svar som innehåller felinformation.
FaceRectangle	En rektangel där ett ansikte kan hittas.
LivenessWithVerifyImage	Detaljerna i ansiktet för verifiering.
QualityForRecognition	Anger bildkvalitet för igenkänning.

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	LivenessWithVerifyImage	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	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 rektangelns övre kant, i bildpunkter.
width	integer	Rektangelns bredd i bildpunkter.

LivenessWithVerifyImage

Detaljerna i ansiktet för verifiering.

Name	Typ	Description
faceRectangle	FaceRectangle	Ansiktsregionen där jämförelsebildens klassificering gjordes.
qualityForRecognition	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.