|
1 | 1 | ---
|
2 |
| -title: Understand Liveness Client-side SDK versions |
| 2 | +title: Understand liveness client-side SDK versions |
3 | 3 | titleSuffix: Azure AI services
|
4 | 4 | description: Explains the importance of updating the Liveness SDK for security and reliability, detailing versioning and update policies
|
5 | 5 | author: JinyuID
|
6 | 6 | ms.author: lijiny
|
7 | 7 | manager: qingflin
|
8 | 8 | ms.service: azure-ai-vision
|
9 | 9 | ms.date: 01/15/2025
|
10 |
| -ms.topic: reference |
| 10 | +ms.topic: conceptual |
11 | 11 | ---
|
12 | 12 |
|
13 |
| -# Understand the Liveness Client-side SDK versions |
| 13 | +# Understand the liveness client-side SDK versions |
14 | 14 |
|
15 |
| -Microsoft regularly upgrades 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 | +Microsoft regularly updates the liveness detection client SDK and service to improve security, reliability, and user convenience. It's important to stay current with these updates because the liveness detection field faces active and sophisticated attacks. |
16 | 16 |
|
17 |
| -## Client-side SDK Versions |
| 17 | +## Client-side SDK version numbers |
18 | 18 |
|
19 |
| -Liveness detection client-side SDK uses major.minor.patch format to indicate software version. |
20 |
| -- A patch version update is an optional reliability fix on the client SDK that doesn't affect compatibility with the service. |
21 |
| -- A minor version update is important security and reliability improvement. We'll try to extend support for a minor update as long as possible, Azure service might announce retirement of minor update after six months |
22 |
| -- 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 six months. |
| 19 | +Liveness detection client-side SDKs use `major.minor.patch` format to indicate the software version. |
| 20 | +- A patch version update is an optional reliability fix to the client SDK that doesn't affect compatibility with the service. |
| 21 | +- A minor version update is an important security and reliability improvement. We try to extend support for a minor update as long as possible, and Azure will announce the retirement of a minor update six months in advance. |
| 22 | +- A major version update is a critical security or breaking API update. Customers should update their application as soon as possible. Azure service will block the previous major version after six months. |
23 | 23 |
|
24 |
| -## Azure Face API Service Version |
| 24 | +## Azure Face API version development pattern |
25 | 25 |
|
26 |
| -Face liveness detection feature is generally available from version 1.2. Face API follows the Azure development cycle where newer API versions add new features during the preview release before becoming generally available. A newer service version might require a newer minimal client SDK version. The requirement is announced when new service version is available. |
| 26 | +The Face liveness detection feature is generally available from version `1.2`. Face API follows the Azure development cycle in which newer API versions add new features during the preview release before becoming generally available. A newer service version might require a newer minimal client SDK version. The requirement is announced when a new service version is available. |
27 | 27 |
|
28 |
| -## Service Model Version |
| 28 | +## Service model version |
29 | 29 |
|
30 |
| -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. |
31 |
| -- The latest model version (default version) remains compatible with all supported client versions. |
32 |
| -- Azure announces the retirement of a service model six months in advance, giving customers buffer time to update their backend service. |
| 30 | +In the **Create Liveness Session** operation, customers can specify a liveness model version to use within the session. Azure Face service continually adds or updates models. We strongly recommend customers always use the latest model version, which entails leaving the `model-version` parameter empty in API calls. |
| 31 | +- The latest model version (default) remains compatible with all supported client versions. |
| 32 | +- Azure announces the retirement of a service model six months in advance, giving customers time to update their backend service. |
0 commit comments