Update Face SDK (#35687)

* Detection03 supports Blur face attribute

* Regenerate SDK with the latest TypeSpec

* Rename sample files

* Add one sample for verify_face_to_face

Author: zihyunting

sdk/face/azure-ai-vision-face/azure/ai/vision/face/_operations/_operations.py

@@ -18860,7 +18860,7 @@ def create_liveness_session(
                 # JSON input template you can fill out and use as your body input.
                 body = {
                     "livenessOperationMode": "str",  # Type of liveness mode the client should
-                      follow. Required. "Passive"
+                      follow. Required. Known values are: "Passive" and "PassiveActive".
                     "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session should
                       last for. Range is 60 to 86400 seconds. Default value is 600.
                     "deviceCorrelationId": "str",  # Optional. Unique Guid per each end-user
@@ -19034,7 +19034,7 @@ def create_liveness_session(
                 # JSON input template you can fill out and use as your body input.
                 body = {
                     "livenessOperationMode": "str",  # Type of liveness mode the client should
-                      follow. Required. "Passive"
+                      follow. Required. Known values are: "Passive" and "PassiveActive".
                     "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session should
                       last for. Range is 60 to 86400 seconds. Default value is 600.
                     "deviceCorrelationId": "str",  # Optional. Unique Guid per each end-user
@@ -19687,7 +19687,7 @@ def _create_liveness_with_verify_session(
                 # JSON input template you can fill out and use as your body input.
                 body = {
                     "livenessOperationMode": "str",  # Type of liveness mode the client should
-                      follow. Required. "Passive"
+                      follow. Required. Known values are: "Passive" and "PassiveActive".
                     "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session should
                       last for. Range is 60 to 86400 seconds. Default value is 600.
                     "deviceCorrelationId": "str",  # Optional. Unique Guid per each end-user
@@ -19845,7 +19845,7 @@ def _create_liveness_with_verify_session_with_verify_image(  # pylint: disable=n
                 body = {
                     "Parameters": {
                         "livenessOperationMode": "str",  # Type of liveness mode the client
-                          should follow. Required. "Passive"
+                          should follow. Required. Known values are: "Passive" and "PassiveActive".
                         "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session
                           should last for. Range is 60 to 86400 seconds. Default value is 600.
                         "deviceCorrelationId": "str",  # Optional. Unique Guid per each

sdk/face/azure-ai-vision-face/azure/ai/vision/face/aio/_operations/_operations.py

@@ -16493,7 +16493,7 @@ async def create_liveness_session(
                 # JSON input template you can fill out and use as your body input.
                 body = {
                     "livenessOperationMode": "str",  # Type of liveness mode the client should
-                      follow. Required. "Passive"
+                      follow. Required. Known values are: "Passive" and "PassiveActive".
                     "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session should
                       last for. Range is 60 to 86400 seconds. Default value is 600.
                     "deviceCorrelationId": "str",  # Optional. Unique Guid per each end-user
@@ -16667,7 +16667,7 @@ async def create_liveness_session(
                 # JSON input template you can fill out and use as your body input.
                 body = {
                     "livenessOperationMode": "str",  # Type of liveness mode the client should
-                      follow. Required. "Passive"
+                      follow. Required. Known values are: "Passive" and "PassiveActive".
                     "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session should
                       last for. Range is 60 to 86400 seconds. Default value is 600.
                     "deviceCorrelationId": "str",  # Optional. Unique Guid per each end-user
@@ -17320,7 +17320,7 @@ async def _create_liveness_with_verify_session(
                 # JSON input template you can fill out and use as your body input.
                 body = {
                     "livenessOperationMode": "str",  # Type of liveness mode the client should
-                      follow. Required. "Passive"
+                      follow. Required. Known values are: "Passive" and "PassiveActive".
                     "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session should
                       last for. Range is 60 to 86400 seconds. Default value is 600.
                     "deviceCorrelationId": "str",  # Optional. Unique Guid per each end-user
@@ -17478,7 +17478,7 @@ async def _create_liveness_with_verify_session_with_verify_image(  # pylint: dis
                 body = {
                     "Parameters": {
                         "livenessOperationMode": "str",  # Type of liveness mode the client
-                          should follow. Required. "Passive"
+                          should follow. Required. Known values are: "Passive" and "PassiveActive".
                         "authTokenTimeToLiveInSeconds": 0,  # Optional. Seconds the session
                           should last for. Range is 60 to 86400 seconds. Default value is 600.
                         "deviceCorrelationId": "str",  # Optional. Unique Guid per each

sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/_enums.py

@@ -213,10 +213,21 @@ class LivenessModel(str, Enum, metaclass=CaseInsensitiveEnumMeta):
 
 
 class LivenessOperationMode(str, Enum, metaclass=CaseInsensitiveEnumMeta):
-    """The operation mode for the liveness modal."""
+    """The liveness operation mode to drive the client’s end-user experience."""
 
     PASSIVE = "Passive"
-    """The operation mode for the liveness modal."""
+    """Utilizes a passive liveness technique that requires no additional actions from the user.
+    Requires normal indoor lighting and high screen brightness for optimal performance. And thus,
+    this mode has a narrow operational envelope and will not be suitable for scenarios that
+    requires the end-user’s to be in bright lighting conditions. Note: this is the only supported
+    mode for the Mobile (iOS and Android) solution."""
+    PASSIVE_ACTIVE = "PassiveActive"
+    """This mode utilizes a hybrid passive or active liveness technique that necessitates user
+    cooperation. It is optimized to require active motion only under suboptimal lighting
+    conditions. Unlike the passive mode, this mode has no lighting restrictions, and thus offering
+    a broader operational envelope. This mode is preferable on Web based solutions due to the lack
+    of automatic screen brightness control available on browsers which hinders the Passive mode’s
+    operational envelope on Web based solutions."""
 
 
 class MaskType(str, Enum, metaclass=CaseInsensitiveEnumMeta):

sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/_models.py

@@ -231,8 +231,8 @@ class CreateLivenessSessionContent(_model_base.Model):
 
     All required parameters must be populated in order to send to server.
 
-    :ivar liveness_operation_mode: Type of liveness mode the client should follow. Required.
-     "Passive"
+    :ivar liveness_operation_mode: Type of liveness mode the client should follow. Required. Known
+     values are: "Passive" and "PassiveActive".
     :vartype liveness_operation_mode: str or ~azure.ai.vision.face.models.LivenessOperationMode
     :ivar send_results_to_client: Whether or not to allow a '200 - Success' response body to be
      sent to the client, which may be undesirable for security reasons. Default is false, clients
@@ -253,7 +253,8 @@ class CreateLivenessSessionContent(_model_base.Model):
     """
 
     liveness_operation_mode: Union[str, "_models.LivenessOperationMode"] = rest_field(name="livenessOperationMode")
-    """Type of liveness mode the client should follow. Required. \"Passive\""""
+    """Type of liveness mode the client should follow. Required. Known values are: \"Passive\" and
+     \"PassiveActive\"."""
     send_results_to_client: Optional[bool] = rest_field(name="sendResultsToClient")
     """Whether or not to allow a '200 - Success' response body to be sent to the client, which may be
      undesirable for security reasons. Default is false, clients will receive a '204 - NoContent'

sdk/face/azure-ai-vision-face/azure/ai/vision/face/models/_patch.py

@@ -31,6 +31,7 @@ class FaceAttributeTypeDetection01(str, Enum, metaclass=CaseInsensitiveEnumMeta)
 class FaceAttributeTypeDetection03(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     """Available attribute options for detection_03 model."""
 
+    BLUR = FaceAttributeType.BLUR.value
     HEAD_POSE = FaceAttributeType.HEAD_POSE.value
     MASK = FaceAttributeType.MASK.value
 

sdk/face/azure-ai-vision-face/samples/README.md

@@ -14,21 +14,23 @@ The async versions of the samples (the python sample files appended with `_async
 
 Several Azure Face Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Face:
 
-* [samples_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_authentication_async.py)) - Examples for authenticating and creating the client:
+* [sample_authentication.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_authentication.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_authentication_async.py)) - Examples for authenticating and creating the client:
     * From a key
     * From Microsoft Entra ID
 
-* [samples_face_liveness_detection.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_liveness_detection.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_liveness_detection_async.py)) - Examples for performing liveness detection
+* [sample_face_liveness_detection.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_async.py)) - Examples for performing liveness detection
 
-* [samples_face_liveness_detection_with_verification.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_liveness_detection_with_verification.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_liveness_detection_with_verification_async.py)) - Examples for performing liveness detection with face verification
+* [sample_face_liveness_detection_with_verification.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_liveness_detection_with_verification_async.py)) - Examples for performing liveness detection with face verification
 
-* [samples_face_detection.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_detection.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_detection_async.py)) - Examples for detecting human faces in an image:
+* [sample_face_detection.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_detection.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_detection_async.py)) - Examples for detecting human faces in an image:
     * From a binary data
     * From a URL
 
-* [samples_face_grouping.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_grouping.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_face_grouping_async.py)) - Examples for dividing candidate faces into groups based on face similarity.
+* [sample_stateless_face_verification.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_stateless_face_verification_async.py)) - Examples for verifying whether two faces belong to the same person.
 
-* [samples_find_similar_faces.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_find_similar_faces.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/samples_find_similar_faces_async.py)) - Examples for searching the similar-looking faces from a set of candidate faces:
+* [sample_face_grouping.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_grouping.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_face_grouping_async.py)) - Examples for dividing candidate faces into groups based on face similarity.
+
+* [sample_find_similar_faces.py](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces.py) ([async version](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/face/azure-ai-vision-face/samples/sample_find_similar_faces_async.py)) - Examples for searching the similar-looking faces from a set of candidate faces:
     * From a faceId array
     * From a large face list
 
@@ -52,7 +54,7 @@ pip install azure-ai-vision-face
 
 1. Open a terminal window and `cd` to the directory that the samples are saved in.
 2. Set the environment variables specified in the sample file you wish to run.
-3. Follow the usage described in the file, e.g. `python samples_face_detection.py`
+3. Follow the usage described in the file, e.g. `python sample_face_detection.py`
 
 ## Next steps
 

sdk/face/azure-ai-vision-face/samples/samples_authentication.py renamed to sdk/face/azure-ai-vision-face/samples/sample_authentication.py

@@ -64,6 +64,7 @@ def detect(self):
                 recognition_model=FaceRecognitionModel.RECOGNITION_04,
                 return_face_id=True,
                 return_face_attributes=[
+                    FaceAttributeTypeDetection03.BLUR,
                     FaceAttributeTypeDetection03.HEAD_POSE,
                     FaceAttributeTypeDetection03.MASK,
                     FaceAttributeTypeRecognition04.QUALITY_FOR_RECOGNITION,

sdk/face/azure-ai-vision-face/samples/samples_authentication_async.py renamed to sdk/face/azure-ai-vision-face/samples/sample_authentication_async.py

@@ -65,6 +65,7 @@ async def detect(self):
                 recognition_model=FaceRecognitionModel.RECOGNITION_04,
                 return_face_id=True,
                 return_face_attributes=[
+                    FaceAttributeTypeDetection03.BLUR,
                     FaceAttributeTypeDetection03.HEAD_POSE,
                     FaceAttributeTypeDetection03.MASK,
                     FaceAttributeTypeRecognition04.QUALITY_FOR_RECOGNITION,