Liveness Session Operations - Create Liveness Session

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Vytvořte novou relaci detekce aktivity.
Relace je nejvhodnější pro scénáře klientských zařízení, ve kterých chtějí vývojáři autorizovat klientské zařízení, aby provádělo detekci živé aktivity, aniž by udělili úplný přístup ke svému prostředku. Vytvořené relace mají omezenou životnost a autorizuje klienty pouze k provedení požadované akce před vypršením platnosti přístupu.

Oprávnění zahrnují...

• • Schopnost volat /detectLiveness/singleModal až pro 3 opakování.
  • Životnost tokenu je 10 minut.

Poznámka

Klientský přístup lze odvolat odstraněním relace pomocí operace Odstranit relaci liveness. K načtení výsledku použijte relaci Získat liveness. Pokud chcete auditovat jednotlivé požadavky, které klient provedl pro váš prostředek, použijte položky auditu relace Seznam živých událostí.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
endpoint	path	True	string uri	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).

Text požadavku

Name	Vyžadováno	Typ	Description
livenessOperationMode	True	LivenessOperationMode	Typ režimu aktivity by měl klient postupovat.
authTokenTimeToLiveInSeconds		integer	Sekundy, na které by měla relace trvat. Rozsah je 60 až 86400 sekund. Výchozí hodnota je 600.
deviceCorrelationId		string	Jedinečný identifikátor GUID pro každé zařízení koncového uživatele. Jedná se o zajištění omezování rychlosti a proti kladivu. Pokud je v tomto požadavku hodnota deviceCorrelationIdSetInClient true, musí být hodnota deviceCorrelationId null.
deviceCorrelationIdSetInClient		boolean	Bez ohledu na to, jestli chcete klientovi povolit, aby prostřednictvím sady Vision SDK nastavil vlastní 'deviceCorrelationId'. Výchozí hodnota je false a v tomto textu požadavku musí být nastavená hodnota deviceCorrelationId.
enableSessionImage		boolean	Určuje, jestli image relace neukládáte nebo ne.
livenessSingleModalModel		LivenessModel	Verze modelu používaná pro klasifikaci aktivity. Jedná se o volitelný parametr a pokud není zadaný, zvolí se nejnovější podporovaná verze modelu.
sendResultsToClient		boolean	Určuje, jestli se má do klienta odeslat text odpovědi 200 - Success, což může být z bezpečnostních důvodů nežádoucí. Výchozí hodnota je false, klienti obdrží prázdnou odpověď textu 204 – NoContent. Bez ohledu na výběr bude volání Session GetResult vždy obsahovat tělo odpovědi umožňující implementaci obchodní logiky.

Odpovědi

Name	Typ	Description
200 OK	CreateLivenessSessionResult	Úspěšné volání vytvoří relaci pro klientské zařízení a poskytne autorizační token pro použití klientskou aplikací pro omezený účel a čas.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

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

Příklady

Create Liveness Session

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
CreateLivenessSessionContent	Model žádosti o vytvoření relace živé aktivity
CreateLivenessSessionResult	Odpověď na vytvoření relace živé aktivity
FaceError	Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpověď obsahující podrobnosti o chybě.
LivenessModel	Verze modelu používaná pro klasifikaci aktivity.
LivenessOperationMode	Režim operace liveness pro řízení prostředí koncového uživatele klienta.

CreateLivenessSessionContent

Model žádosti o vytvoření relace živé aktivity

Name	Typ	Default value	Description
authTokenTimeToLiveInSeconds	integer	600	Sekundy, na které by měla relace trvat. Rozsah je 60 až 86400 sekund. Výchozí hodnota je 600.
deviceCorrelationId	string		Jedinečný identifikátor GUID pro každé zařízení koncového uživatele. Jedná se o zajištění omezování rychlosti a proti kladivu. Pokud je v tomto požadavku hodnota deviceCorrelationIdSetInClient true, musí být hodnota deviceCorrelationId null.
deviceCorrelationIdSetInClient	boolean		Bez ohledu na to, jestli chcete klientovi povolit, aby prostřednictvím sady Vision SDK nastavil vlastní 'deviceCorrelationId'. Výchozí hodnota je false a v tomto textu požadavku musí být nastavená hodnota deviceCorrelationId.
enableSessionImage	boolean		Určuje, jestli image relace neukládáte nebo ne.
livenessOperationMode	LivenessOperationMode		Typ režimu aktivity by měl klient postupovat.
livenessSingleModalModel	LivenessModel		Verze modelu používaná pro klasifikaci aktivity. Jedná se o volitelný parametr a pokud není zadaný, zvolí se nejnovější podporovaná verze modelu.
sendResultsToClient	boolean		Určuje, jestli se má do klienta odeslat text odpovědi 200 - Success, což může být z bezpečnostních důvodů nežádoucí. Výchozí hodnota je false, klienti obdrží prázdnou odpověď textu 204 – NoContent. Bez ohledu na výběr bude volání Session GetResult vždy obsahovat tělo odpovědi umožňující implementaci obchodní logiky.

CreateLivenessSessionResult

Odpověď na vytvoření relace živé aktivity

Name	Typ	Description
authToken	string	Nosný token, který poskytuje ověřování pro sadu Vision SDK spuštěnou v klientské aplikaci. Tento nosný token má omezená oprávnění k provedení pouze požadované akce a vyprší po uplynutí doby TTL. Je také možné ji auditovat.
sessionId	string	Jedinečné ID relace vytvořené relace. Platnost vyprší 48 hodin po jeho vytvoření nebo může být odstraněna dříve pomocí odpovídající operace ODSTRANĚNÍ relace.

FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
message	string	Čitelné znázornění chyby člověkem.

FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	FaceError	Objekt chyby.

LivenessModel

Verze modelu používaná pro klasifikaci aktivity.

Name	Typ	Description
2022-10-15-preview.04	string
2023-12-20-preview.06	string

LivenessOperationMode

Režim operace liveness pro řízení prostředí koncového uživatele klienta.

Name	Typ	Description
Passive	string	Využívá pasivní techniku života, která nevyžaduje žádné další akce od uživatele. Vyžaduje normální vnitřní osvětlení a vysoký jas obrazovky pro optimální výkon. A proto má tento režim úzkou provozní obálku a nebude vhodný pro scénáře, které vyžadují, aby koncový uživatel byl v jasných světelných podmínkách. Poznámka: Toto je jediný podporovaný režim pro řešení Mobile (iOS a Android).
PassiveActive	string	Tento režim využívá hybridní pasivní nebo aktivní techniku života, která vyžaduje spolupráci uživatelů. Je optimalizovaná tak, aby vyžadovala aktivní pohyb pouze za neoptimálních světelných podmínek. Na rozdíl od pasivního režimu nemá tento režim žádná omezení osvětlení, a proto nabízí širší provozní obálku. Tento režim je vhodnější na webových řešeních kvůli nedostatku automatického ovládání jasu obrazovky dostupných v prohlížečích, které brání provozní obálce pasivního režimu na webových řešeních.