regula.facesdk.webclient 8.3.706.dev0__py3-none-any.whl → 8.3.707.dev0__py3-none-any.whl

regula/facesdk/webclient/gen/api/match_api.py

@@ -347,7 +347,7 @@ class MatchApi:
     ) -> MatchResponse:
         """compare faces (1:1)
 
-        To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter. <br><br> Note that no more than two images of the same `type` are allowed for comparison.<br><br> The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1`
+        To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter. <br><br> Note that no more than two images of the same `type` are allowed for comparison.<br><br> It's also possible to perform matching by using the face captured during the liveness check as one of the comparison inputs. In this case, pass `livenessTransactionId` instead of one of the images.<br><br> The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1`
 
         :param match_request: (required)
         :type match_request: MatchRequest
@@ -419,7 +419,7 @@ class MatchApi:
     ) -> ApiResponse[MatchResponse]:
         """compare faces (1:1)
 
-        To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter. <br><br> Note that no more than two images of the same `type` are allowed for comparison.<br><br> The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1`
+        To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter. <br><br> Note that no more than two images of the same `type` are allowed for comparison.<br><br> It's also possible to perform matching by using the face captured during the liveness check as one of the comparison inputs. In this case, pass `livenessTransactionId` instead of one of the images.<br><br> The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1`
 
         :param match_request: (required)
         :type match_request: MatchRequest
@@ -491,7 +491,7 @@ class MatchApi:
     ) -> RESTResponseType:
         """compare faces (1:1)
 
-        To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter. <br><br> Note that no more than two images of the same `type` are allowed for comparison.<br><br> The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1`
+        To perform a comparison of faces in the same image or in two different images, use POST `/api/match`. It's possible to compare faces in the same image or in two different images, this is defined by the `images.type` parameter. <br><br> Note that no more than two images of the same `type` are allowed for comparison.<br><br> It's also possible to perform matching by using the face captured during the liveness check as one of the comparison inputs. In this case, pass `livenessTransactionId` instead of one of the images.<br><br> The face detection result is displayed in the `detections` field. Each face is identified by two parameters: `faceIndex` (the index number of the face) and `imageIndex` (the index number of the image on which the face is detected). So, if there are two images each of which has two faces in them, the parameters will be the following: - First face in the first image: `faceIndex: 0`, `imageIndex: 0` - Second face in the first image: `faceIndex: 1`, `imageIndex: 0` - First face of the second image: `faceIndex: 0`, `imageIndex: 1` - Second face in the second image: `faceIndex: 1`, `imageIndex: 1`
 
         :param match_request: (required)
         :type match_request: MatchRequest

regula/facesdk/webclient/gen/models/liveness_type.py

@@ -12,7 +12,7 @@ from typing_extensions import Self
 
 class LivenessType(int, Enum):
     """
-    Liveness detection can be performed in two modes: active `0` and passive `1`. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/liveness/#active-and-passive-modes)
+    Liveness detection can be performed in three modes: active `0`,  passive `1`, and passive with blink `2`. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/liveness/#active-and-passive-modes)
     """
 
     """
@@ -20,6 +20,7 @@ class LivenessType(int, Enum):
     """
     ACTIVE = 0
     PASSIVE = 1
+    PASSIVE_WITH_BLINK = 2
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

regula/facesdk/webclient/gen/models/match_and_search_request_images_item.py

@@ -23,7 +23,8 @@ class MatchAndSearchRequestImagesItem(BaseModel):
     content: SkipValidation[Optional[bytearray]] = Field(alias="content", default=None, description="Base64-encoded image.")
     image_url: SkipValidation[Optional[str]] = Field(alias="imageUrl", default=None, description="Image URL.")
     type: SkipValidation[Optional[ImageSource]] = Field(alias="type", default=None)
-    __properties: ClassVar[List[str]] = ["content", "imageUrl", "type"]
+    liveness_transaction_id: SkipValidation[Optional[str]] = Field(alias="livenessTransactionId", default=None, description="Identifier of the completed liveness transaction whose captured face is used as one of the comparison inputs. If this parameter is provided, it replaces one of the images in the matching request.")
+    __properties: ClassVar[List[str]] = ["content", "imageUrl", "type", "livenessTransactionId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -80,7 +81,8 @@ class MatchAndSearchRequestImagesItem(BaseModel):
         _obj = cls.model_validate({
             "content": obj.get("content"),
             "imageUrl": obj.get("imageUrl"),
-            "type": obj.get("type")
+            "type": obj.get("type"),
+            "livenessTransactionId": obj.get("livenessTransactionId")
         })
         return _obj
 

regula/facesdk/webclient/gen/models/match_image.py

@@ -24,7 +24,8 @@ class MatchImage(BaseModel):
     type: SkipValidation[Optional[ImageSource]] = Field(alias="type", default=None)
     data: SkipValidation[bytearray] = Field(alias="data", description="Base64-encoded image.")
     detect_all: SkipValidation[Optional[bool]] = Field(alias="detectAll", default=None, description="Whether to detect all faces in the image. If set to `false`, only the most central face is detected.")
-    __properties: ClassVar[List[str]] = ["index", "type", "data", "detectAll"]
+    liveness_transaction_id: SkipValidation[Optional[str]] = Field(alias="livenessTransactionId", default=None, description="Identifier of the completed liveness transaction whose captured face is used as one of the comparison inputs. If this parameter is provided, it replaces one of the images in the matching request.")
+    __properties: ClassVar[List[str]] = ["index", "type", "data", "detectAll", "livenessTransactionId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -82,7 +83,8 @@ class MatchImage(BaseModel):
             "index": obj.get("index"),
             "type": obj.get("type"),
             "data": obj.get("data"),
-            "detectAll": obj.get("detectAll") if obj.get("detectAll") is not None else False
+            "detectAll": obj.get("detectAll") if obj.get("detectAll") is not None else False,
+            "livenessTransactionId": obj.get("livenessTransactionId")
         })
         return _obj
 

{regula_facesdk_webclient-8.3.706.dev0.dist-info → regula_facesdk_webclient-8.3.707.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.3.706.dev0
+Version: 8.3.707.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_facesdk_webclient-8.3.706.dev0.dist-info → regula_facesdk_webclient-8.3.707.dev0.dist-info}/RECORD

@@ -24,7 +24,7 @@ regula/facesdk/webclient/gen/api/__init__.py,sha256=gnY2i-_BEnVreU1B2Dw4SNqXTN1i
 regula/facesdk/webclient/gen/api/group_api.py,sha256=mb8fm64m7MpB04q4Zzs-pOAw6neafgDyLJ8ORoKXAf4,82470
 regula/facesdk/webclient/gen/api/healthcheck_api.py,sha256=IdiaRFLYVY2qdvCYUx9HIVWJt4BE0EVMcpgXIdxLz18,22270
 regula/facesdk/webclient/gen/api/liveness20_api.py,sha256=NabQq55iKONlEin8_XZA-yT3ofopoo_7zyiPkZxxon0,27238
-regula/facesdk/webclient/gen/api/match_api.py,sha256=BPodqOxk4iwT7OIo-8FYTofz33nooe1Jka62MFrtqEo,43764
+regula/facesdk/webclient/gen/api/match_api.py,sha256=V2U2gpL5vhiveIJV_7dE0Cxn_pJJ0fsrdmvjmgJ_XLI,44382
 regula/facesdk/webclient/gen/api/person_api.py,sha256=xKwjEGZGcIP9yZ5vxh3kbu9k6AzgqLNdpK-uB4E2TXQ,106803
 regula/facesdk/webclient/gen/api/search_api.py,sha256=UKjDm2-RC7lrbkXejrDsHlK0VWJFLDZpVTWJZxnaZfg,14260
 regula/facesdk/webclient/gen/models/__init__.py,sha256=MXSv97KC0kClBlz8hz00zUBkJ_FHh0yrXnbggst9rjE,15993
@@ -75,13 +75,13 @@ regula/facesdk/webclient/gen/models/image_fields_image.py,sha256=91BhuufdjiV39l3
 regula/facesdk/webclient/gen/models/image_page.py,sha256=x-I9BW32rqk0EhzbSg5Y0z0eBxmFgH1FBTld9_z28Ok,3207
 regula/facesdk/webclient/gen/models/image_page_items.py,sha256=ufNKog-a_bl_W9VDWPWUyeySiVOaD-eBZ-c6VWBiNBQ,2862
 regula/facesdk/webclient/gen/models/image_source.py,sha256=Un_vs8avKypBWla5r9KaWc5KYtZA_25YhJD3s47kTiY,706
-regula/facesdk/webclient/gen/models/liveness_type.py,sha256=l2JtUi_9ZF7LEewIXVn7BEb7o1Vmp-f0Mf_M7ui7j-Y,687
+regula/facesdk/webclient/gen/models/liveness_type.py,sha256=J2yr0Mbto42biZXEu0d3GebN70uhmlu7YDw16eq4V2w,742
 regula/facesdk/webclient/gen/models/match_and_search_request.py,sha256=daeR7dXjsB5p3_r--sKYz01qaYDbCgXg-XlwhQsvKYU,4402
-regula/facesdk/webclient/gen/models/match_and_search_request_images_item.py,sha256=N5ym9hBXtm5jwulWBZiDYOSjrrxNz1-Z5arc_7RYNo4,2928
+regula/facesdk/webclient/gen/models/match_and_search_request_images_item.py,sha256=dLqck8u0zfGJUYXhb-3CcQt1HNtrriBaftWV65-HFv0,3347
 regula/facesdk/webclient/gen/models/match_and_search_response.py,sha256=nGLrfADgPflcsZWLfytZBjnXtyvYdfPNLdujwpMDMVg,4636
 regula/facesdk/webclient/gen/models/match_and_search_response_data.py,sha256=21M-w9i1u_AkzC6tb9L5dZXcqMoie1x3exIchtksAcg,4454
 regula/facesdk/webclient/gen/models/match_and_search_response_data_detections_item.py,sha256=5dzFaFUV3QYtBmInQgFNURfedY7BniGvT6Z34Lt9KhE,3625
-regula/facesdk/webclient/gen/models/match_image.py,sha256=mSt2en5txGAj52lP_FN7hK87EjfPL_8wMHft7ARybl4,3282
+regula/facesdk/webclient/gen/models/match_image.py,sha256=kL-elLpGqLjDKvHKXbCl-8vJCI2Lp6mjZVFULnfw8aE,3701
 regula/facesdk/webclient/gen/models/match_image_detection.py,sha256=BJo1FbwfKuVCaLrJUaLWK--ix5anC6rN8lXGlQlqFJg,3493
 regula/facesdk/webclient/gen/models/match_image_result.py,sha256=DmCV8x6PM4pke22MXBT9bQG0ZNBu2mp9hKtxLb0Tnps,4258
 regula/facesdk/webclient/gen/models/match_request.py,sha256=8DRFsmzNPq2l-nsExbV34h81ExNNI0UwgB9udh0lRU8,4167
@@ -119,7 +119,7 @@ regula/facesdk/webclient/gen/models/search_result.py,sha256=lxcCJ8EzUuwfEowZpZU7
 regula/facesdk/webclient/gen/models/transaction_info.py,sha256=XQ7-n8muZ3TxR88MyWr8pK83SG5hqF1YtrIeLxG51tE,4495
 regula/facesdk/webclient/gen/models/transaction_labels.py,sha256=A9ZDFAIjiuMNd4lbmVTtgntr4Kp2f9ntpK82cmzHAbY,2728
 regula/facesdk/webclient/gen/models/update_group.py,sha256=A6qjz_WTmJy_9xsdc4O1-Wj4LA-7EfRTJBqQM8VMV58,2658
-regula_facesdk_webclient-8.3.706.dev0.dist-info/METADATA,sha256=tyeQHMraks-YGDPX_jaYtDjMYnvQj6sYH1z1GNicQsc,3182
-regula_facesdk_webclient-8.3.706.dev0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
-regula_facesdk_webclient-8.3.706.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
-regula_facesdk_webclient-8.3.706.dev0.dist-info/RECORD,,
+regula_facesdk_webclient-8.3.707.dev0.dist-info/METADATA,sha256=as0QN9xLY7Z63rDRynur1726GClgwGbLj7tQoR9LL4o,3182
+regula_facesdk_webclient-8.3.707.dev0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
+regula_facesdk_webclient-8.3.707.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
+regula_facesdk_webclient-8.3.707.dev0.dist-info/RECORD,,