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

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Utwórz nową sesję liveness z weryfikacją. Podaj obraz weryfikacji podczas tworzenia sesji.
Sesja jest najlepsza w scenariuszach urządzeń klienckich, w których deweloperzy chcą autoryzować urządzenie klienckie tylko do wykrywania aktualności bez udzielania pełnego dostępu do swojego zasobu. Utworzone sesje mają ograniczony zakres życia i autoryzuje tylko klientów do wykonania żądanej akcji przed wygaśnięciem dostępu.

Uprawnienia obejmują...

• • Możliwość wywołania /detectLivenessWithVerify/singleModal dla maksymalnie 3 ponownych prób.
  • Okres istnienia tokenu to 10 minut.

Nuta

• • Dostęp klienta można odwołać, usuwając sesję przy użyciu operacji Usuń żywotność za pomocą weryfikacji sesji.
  • Aby pobrać wynik, użyj sesji Uzyskiwanie aktualności za pomocą weryfikacji.
  • Aby przeprowadzić inspekcję poszczególnych żądań wysyłanych przez klienta do zasobu, użyj pozycji Lista aktywności z weryfikacją wpisów inspekcji sesji.

Zalecana opcja: Funkcja VerifyImage jest udostępniana podczas tworzenia sesji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Parameters	formData	True	string	Parametry tworzenia sesji.
VerifyImage	formData	True	file	Strumień obrazu do zweryfikowania. Pole nagłówka Content-Disposition dla tej części musi mieć nazwę pliku.
apiVersion	path	True	string	Wersja interfejsu API
endpoint	path	True	string uri	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://{nazwa-zasobu}.cognitiveservices.azure.com).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CreateLivenessWithVerifySessionResult	Pomyślne wywołanie tworzy sesję dla urządzenia klienckiego i udostępnia token autoryzacji do użycia przez aplikację kliencką w ograniczonym celu i czasie.
Other Status Codes	FaceErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji rozpoznawania twarzy w usłudze Azure AI.

Typ: apiKey
W: header

AADToken

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://api.example.com/oauth2/authorize
Adres URL tokenu: https://api.example.com/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Create LivenessWithVerify Session with VerifyImage

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
CreateLivenessWithVerifySessionResult	Odpowiedź na sesję liveness z weryfikacją utworzenia z podanym obrazem.
FaceError	Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.
FaceRectangle	Prostokąt, w którym można znaleźć twarz.
LivenessWithVerifyImage	Szczegóły twarzy na potrzeby weryfikacji.
QualityForRecognition	Wskazuje jakość obrazu do rozpoznawania.

CreateLivenessWithVerifySessionResult

Odpowiedź na sesję liveness z weryfikacją utworzenia z podanym obrazem.

Nazwa	Typ	Opis
authToken	string	Token elementu nośnego w celu zapewnienia uwierzytelniania zestawu SDK przetwarzania obrazów działającego w aplikacji klienckiej. Ten token elementu nośnego ma ograniczone uprawnienia do wykonywania tylko wymaganej akcji i wygasa po upływie czasu wygaśnięcia. Można go również przeprowadzić inspekcję.
sessionId	string	Unikatowy identyfikator sesji utworzonej sesji. Wygaśnie on 48 godzin po jego utworzeniu lub może zostać usunięty wcześniej przy użyciu odpowiedniej operacji DELETE sesji.
verifyImage	LivenessWithVerifyImage	Szczegóły twarzy na potrzeby weryfikacji.

FaceError

Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
message	string	Czytelna dla człowieka reprezentacja błędu.

FaceErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.

FaceRectangle

Prostokąt, w którym można znaleźć twarz.

Nazwa	Typ	Opis
height	integer	Wysokość prostokąta w pikselach.
left	integer	Odległość od lewej krawędzi, jeśli obraz do lewej krawędzi prostokąta w pikselach.
top	integer	Odległość od górnej krawędzi, jeśli obraz do górnej krawędzi prostokąta w pikselach.
width	integer	Szerokość prostokąta w pikselach.

LivenessWithVerifyImage

Szczegóły twarzy na potrzeby weryfikacji.

Nazwa	Typ	Opis
faceRectangle	FaceRectangle	Region twarzy, w którym utworzono klasyfikację obrazu porównania.
qualityForRecognition	QualityForRecognition	Jakość obrazu twarzy do rozpoznawania.

QualityForRecognition

Wskazuje jakość obrazu do rozpoznawania.

Nazwa	Typ	Opis
high	string	Wysoka jakość.
low	string	Niska jakość.
medium	string	Średnia jakość.