Skip to content

Commit 002b98d

Browse files
author
Jinyu Li
committed
add liveness GA document
1 parent b571f79 commit 002b98d

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Understand Liveness Client-side SDK versions
3+
titleSuffix: Azure AI services
4+
description: Explains the importance of updating the Liveness SDK for security and reliability, detailing versioning and update policies
5+
author: JinyuID
6+
ms.author: lijiny
7+
manager: qingflin
8+
ms.service: azure-ai-vision
9+
ms.date: 01/15/2025
10+
---
11+
12+
# Understand the Liveness Client-side SDK versions
13+
14+
Microsoft will regularly upgrade the liveness detection client SDK and service to improve security, reliability, and user convenience. Staying current with these updates is crucial because the liveness detection field faces active and sophisticated attacks.
15+
16+
## Client-side SDK Versions
17+
18+
Liveness detection client-side SDK uses major.minor.patch format to indicate software version.
19+
- A patch version update is optional reliability fix on client SDK, it won’t impact the compatibility with service.
20+
- A minor version update is important security and reliability improvement. We will try to extend support for a minor update as long as possible, Azure service might announce retirement of minor update after 6 months
21+
- A major version update is critical security or breaking API updates. Customers should make client update as soon as possible. Azure service will block the previous major version after 6 months.
22+
23+
## Azure Face API Service Version
24+
25+
Face liveness detection feature is generally available from version 1.2. Face API will follow the Azure developing cycle, newer API version will add new features in preview release, then general available. A newer service version may require a newer minimal client SDK version. The requirement will be announced when new service version is available.
26+
27+
## Service Model Version
28+
29+
In the Create Liveness Session operation, customers can specify a liveness model version to classify the session. Azure service is also progressively updating new models. We strongly recommend customers always use the latest model version, which means simply leaving the model version parameter empty.
30+
- The latest model version (default version) will be compatible with all supported client versions.
31+
- When a service model is to be retired, Azure service will announce this 6 months ahead, providing customers with buffer time to update their backend service.

articles/ai-services/computer-vision/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -355,6 +355,8 @@ items:
355355
href: /legal/cognitive-services/face/data-privacy-security?context=/azure/ai-services/computer-vision/context/context
356356
- name: Limited Access features
357357
href: /legal/cognitive-services/computer-vision/limited-access-identity?context=/azure/ai-services/computer-vision/context/context
358+
- name: Shared Responsibility for Face Liveness Detection
359+
href: /legal/cognitive-services/face/shared-responsibility-for-liveness-detection?context=/azure/ai-services/computer-vision/context/context
358360

359361
- name: Reference
360362
items:
@@ -380,6 +382,8 @@ items:
380382
href: https://aka.ms/azure-ai-vision-face-liveness-client-sdk-ios-api-reference
381383
- name: JavaScript (Web)
382384
href: https://aka.ms/azure-ai-vision-face-liveness-client-sdk-web-api-reference
385+
- name: the Liveness SDK versions
386+
href: sdk/understand-the-liveness-sdk-versions.md
383387
- name: Video Analysis
384388
items:
385389
- name: Video Analysis overview

0 commit comments

Comments
 (0)