regula.facesdk.webclient 8.5.898rc0__tar.gz → 9.1.3.dev0__tar.gz

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.5.898rc0
+Version: 9.1.3.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.
@@ -11,13 +11,13 @@ Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.07.04
 Requires-Dist: six>=1.10
 Requires-Dist: python-dateutil>=2.8.2
-Requires-Dist: urllib3<3.0.0,>=2.8.0
+Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: vistir<=0.6.1,>=0.4.0
-Requires-Dist: idna>=3.18
-Requires-Dist: requests>=2.33.0
+Requires-Dist: idna==3.7
+Requires-Dist: requests>=2.32.3
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
-Requires-Dist: lazy-imports>=1.0.1
+Requires-Dist: lazy-imports==1.0.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: description

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/__init__.py

@@ -47,8 +47,6 @@ __all__ = [
     "DetectionFace",
     "DetectionQuality",
     "DeviceInfo",
-    "EnrollResult",
-    "EnrollSearchResult",
     "FaceAttribute",
     "FaceImageQualityAlignType",
     "FaceImageQualityGroups",
@@ -118,8 +116,6 @@ __all__ = [
     "TransactionInfo",
     "TransactionLabels",
     "UpdateGroup",
-    "VerifyResult",
-    "VerifyResultMatch",
 ]
 
 if __import__("typing").TYPE_CHECKING:
@@ -165,8 +161,6 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.detection_face import DetectionFace as DetectionFace
     from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality as DetectionQuality
     from regula.facesdk.webclient.gen.models.device_info import DeviceInfo as DeviceInfo
-    from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult as EnrollResult
-    from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult as EnrollSearchResult
     from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute as FaceAttribute
     from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType as FaceImageQualityAlignType
     from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups as FaceImageQualityGroups
@@ -236,8 +230,6 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo as TransactionInfo
     from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels as TransactionLabels
     from regula.facesdk.webclient.gen.models.update_group import UpdateGroup as UpdateGroup
-    from regula.facesdk.webclient.gen.models.verify_result import VerifyResult as VerifyResult
-    from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch as VerifyResultMatch
     
 else:
     from lazy_imports import LazyModule, as_package, load
@@ -289,8 +281,6 @@ from regula.facesdk.webclient.gen.models.detection_attributes_details_inner impo
 from regula.facesdk.webclient.gen.models.detection_face import DetectionFace as DetectionFace
 from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality as DetectionQuality
 from regula.facesdk.webclient.gen.models.device_info import DeviceInfo as DeviceInfo
-from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult as EnrollResult
-from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult as EnrollSearchResult
 from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute as FaceAttribute
 from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType as FaceImageQualityAlignType
 from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups as FaceImageQualityGroups
@@ -360,8 +350,6 @@ from regula.facesdk.webclient.gen.models.search_result import SearchResult as Se
 from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo as TransactionInfo
 from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels as TransactionLabels
 from regula.facesdk.webclient.gen.models.update_group import UpdateGroup as UpdateGroup
-from regula.facesdk.webclient.gen.models.verify_result import VerifyResult as VerifyResult
-from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch as VerifyResultMatch
 
 """,
             name=__name__,

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/api/liveness20_api.py

@@ -322,7 +322,7 @@ class Liveness20Api:
     ) -> TransactionInfo:
         """liveness check
 
-        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.   When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.   The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`   By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.   To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.  You can also use liveness as part of the <a href=\"https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/\" target=\"_blank\">Enroll and Verify</a> flow. 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`. 
 
         :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str
@@ -389,7 +389,7 @@ class Liveness20Api:
     ) -> ApiResponse[TransactionInfo]:
         """liveness check
 
-        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.   When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.   The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`   By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.   To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.  You can also use liveness as part of the <a href=\"https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/\" target=\"_blank\">Enroll and Verify</a> flow. 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`. 
 
         :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str
@@ -456,7 +456,7 @@ class Liveness20Api:
     ) -> RESTResponseType:
         """liveness check
 
-        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.   When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.   The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`   By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.   To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`.  You can also use liveness as part of the <a href=\"https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/enroll-verify/\" target=\"_blank\">Enroll and Verify</a> flow. 
+        To verify the presence of a real person in front of a camera, use the GET `/api/v2/liveness` endpoint. When starting, you can specify `tag` which all attempts to read liveness will be bound to. If left unspecified, the application automatically generates one. The calling application returns `tag` and `transactionId`. One session may include many transactions, and from a transaction ID it is clear which session it belongs to.  When specifying `tag`, note that only Latin uppercase and lowercase letters, digits, and symbols `-` and `_` are allowed. The maximum supported number of characters is 127.  The metadata (device model, screen data, frame size, app ID and version, OS version, platform, SDK version, etc.), a person's selfie and video of the liveness detection session are stored on the backend at: `faceapi-session/year={year}/month={month}/day={day}/hour={hour}/minute={minute}/{tag}/transactionId`  By default, liveness checks operate with eventual consistency. This means that when you submit a request and receive a response, the associated data (like the selfie and session video) may be saved after the response is sent. If this doesn't meet your requirements, you can switch to strong consistency; refer to the [Architecture page](https://docs.regulaforensics.com/develop/face-sdk/overview/architecture/#consistency-models) for details.  To access the liveness transaction data, use GET `/api/v2/liveness?transactionId={transactionId}`. 
 
         :param transaction_id: ID of the current liveness transaction. (required)
         :type transaction_id: str

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/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> 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`
+        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> 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> 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`
+        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> 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> 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`
+        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> 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-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/configuration.py

@@ -492,7 +492,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 8.3.0\n"\
+               "Version of the API: 7.2.0\n"\
                "SDK Package Version: 1.0.0".\
                format(env=sys.platform, pyversion=sys.version)
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/__init__.py

@@ -29,8 +29,6 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.detection_face import DetectionFace
     from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality
     from regula.facesdk.webclient.gen.models.device_info import DeviceInfo
-    from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult
-    from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult
     from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute
     from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType
     from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups
@@ -100,8 +98,6 @@ if __import__("typing").TYPE_CHECKING:
     from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo
     from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels
     from regula.facesdk.webclient.gen.models.update_group import UpdateGroup
-    from regula.facesdk.webclient.gen.models.verify_result import VerifyResult
-    from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch
     
 else:
     from lazy_imports import LazyModule, as_package, load
@@ -132,8 +128,6 @@ from regula.facesdk.webclient.gen.models.detection_attributes_details_inner impo
 from regula.facesdk.webclient.gen.models.detection_face import DetectionFace
 from regula.facesdk.webclient.gen.models.detection_quality import DetectionQuality
 from regula.facesdk.webclient.gen.models.device_info import DeviceInfo
-from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult
-from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult
 from regula.facesdk.webclient.gen.models.face_attribute import FaceAttribute
 from regula.facesdk.webclient.gen.models.face_image_quality_align_type import FaceImageQualityAlignType
 from regula.facesdk.webclient.gen.models.face_image_quality_groups import FaceImageQualityGroups
@@ -203,8 +197,6 @@ from regula.facesdk.webclient.gen.models.search_result import SearchResult
 from regula.facesdk.webclient.gen.models.transaction_info import TransactionInfo
 from regula.facesdk.webclient.gen.models.transaction_labels import TransactionLabels
 from regula.facesdk.webclient.gen.models.update_group import UpdateGroup
-from regula.facesdk.webclient.gen.models.verify_result import VerifyResult
-from regula.facesdk.webclient.gen.models.verify_result_match import VerifyResultMatch
 
 """,
             name=__name__,

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/add_image_to_person_request.py

@@ -24,7 +24,7 @@ class AddImageToPersonRequest(BaseModel):
     env: SkipValidation[Optional[str]] = Field(alias="env", default=None, description="A label used to differentiate transactions by development stages.")
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator.")
     image: SkipValidation[AddImageToPersonRequestImage] = Field(alias="image")
-    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="Maximum distance allowed for a match (lower value = stricter match).")
+    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
     limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
     __properties: ClassVar[List[str]] = ["tenant", "env", "tag", "image", "threshold", "limit"]
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/add_image_to_person_request_data.py

@@ -22,7 +22,7 @@ class AddImageToPersonRequestData(BaseModel):
     """ # noqa: E501
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator.")
     image: SkipValidation[AddImageToPersonRequestImage] = Field(alias="image")
-    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="Maximum distance allowed for a match (lower value = stricter match).")
+    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
     limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
     __properties: ClassVar[List[str]] = ["tag", "image", "threshold", "limit"]
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/filter_search_request.py

@@ -18,11 +18,11 @@ from pydantic import SkipValidation, Field
 
 class FilterSearchRequest(BaseModel):
     """
-    Allows you to filter search results by Person fields. Currently, filtering is supported only by the `name` field.
+    Allows to filter the search results based on the Person's `name`. If enabled, only the search results that meet the filter condition will be returned.
     """ # noqa: E501
     op: SkipValidation[Optional[FilterOp]] = Field(alias="op", default=None)
-    var_field: SkipValidation[Optional[str]] = Field(alias="field", default=None, description="The Person field to which the filter is applied. Currently, only `name` is supported. If another field is specified, the filter is ignored.")
-    value: SkipValidation[Optional[List[str]]] = Field(alias="value", default=None, description="The list of values against which the specified `field` is compared.")
+    var_field: SkipValidation[Optional[str]] = Field(alias="field", default=None, description="`name` of the Person.")
+    value: SkipValidation[Optional[List[str]]] = Field(alias="value", default=None, description="The list of `name` values against which the `field` is compared.")
     __properties: ClassVar[List[str]] = ["op", "field", "value"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/group_to_create.py

@@ -21,7 +21,7 @@ class GroupToCreate(BaseModel):
     """ # noqa: E501
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator.")
     name: SkipValidation[str] = Field(alias="name", description="Group to create name.")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing group's extended attributes.")
+    metadata: SkipValidation[Dict[str, object]] = Field(alias="metadata", description="A free-form object containing group's extended attributes.")
     __properties: ClassVar[List[str]] = ["tag", "name", "metadata"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/image_fields.py

@@ -25,8 +25,8 @@ class ImageFields(BaseModel):
     image: SkipValidation[Optional[ImageFieldsImage]] = Field(alias="image", default=None)
     output_image_params: SkipValidation[Optional[OutputImageParams]] = Field(alias="outputImageParams", default=None)
     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.")
-    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="Maximum distance allowed for a match (lower value = stricter match).")
-    limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned. If not specified, the default value is 100.")
+    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
+    limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
     __properties: ClassVar[List[str]] = ["tag", "image", "outputImageParams", "detectAll", "threshold", "limit"]
 
     model_config = ConfigDict(
@@ -93,7 +93,7 @@ class ImageFields(BaseModel):
             "outputImageParams": OutputImageParams.from_dict(obj["outputImageParams"]) if obj.get("outputImageParams") is not None else None,
             "detectAll": obj.get("detectAll") if obj.get("detectAll") is not None else False,
             "threshold": obj.get("threshold"),
-            "limit": obj.get("limit") if obj.get("limit") is not None else 100
+            "limit": obj.get("limit")
         })
         return _obj
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/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 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)
+    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)
     """
 
     """
@@ -20,7 +20,6 @@ class LivenessType(int, Enum):
     """
     ACTIVE = 0
     PASSIVE = 1
-    PASSIVE_WITH_BLINK = 2
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/match_and_search_request.py

@@ -24,7 +24,7 @@ class MatchAndSearchRequest(BaseModel):
     tag: SkipValidation[Optional[str]] = Field(alias="tag", default=None, description="Session identificator, should be unique for each session.")
     images: SkipValidation[Optional[List[MatchAndSearchRequestImagesItem]]] = Field(alias="images", default=None, description="An array of images to be processed. At least two images must be provided.")
     group_ids: SkipValidation[Optional[List[str]]] = Field(alias="groupIds", default=None, description="IDs of the groups in which the search is performed.")
-    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="Maximum distance allowed for a match (lower value = stricter match).")
+    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
     limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
     tenant: SkipValidation[Optional[str]] = Field(alias="tenant", default=None, description="A label used to group transactions by customers, applications, or other criteria.")
     env: SkipValidation[Optional[str]] = Field(alias="env", default=None, description="A label used to differentiate transactions by development stages.")

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/match_and_search_request_images_item.py

@@ -23,8 +23,7 @@ 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)
-    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"]
+    __properties: ClassVar[List[str]] = ["content", "imageUrl", "type"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,8 +80,7 @@ class MatchAndSearchRequestImagesItem(BaseModel):
         _obj = cls.model_validate({
             "content": obj.get("content"),
             "imageUrl": obj.get("imageUrl"),
-            "type": obj.get("type"),
-            "livenessTransactionId": obj.get("livenessTransactionId")
+            "type": obj.get("type")
         })
         return _obj
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/match_image.py

@@ -24,8 +24,7 @@ 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.")
-    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"]
+    __properties: ClassVar[List[str]] = ["index", "type", "data", "detectAll"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -83,8 +82,7 @@ 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,
-            "livenessTransactionId": obj.get("livenessTransactionId")
+            "detectAll": obj.get("detectAll") if obj.get("detectAll") is not None else False
         })
         return _obj
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/search_request.py

@@ -33,8 +33,8 @@ class SearchRequest(BaseModel):
     image: SkipValidation[Optional[ImageFieldsImage]] = Field(alias="image", default=None)
     output_image_params: SkipValidation[Optional[OutputImageParams]] = Field(alias="outputImageParams", default=None)
     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.")
-    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="Maximum distance allowed for a match (lower value = stricter match).")
-    limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned. If not specified, the default value is 100.")
+    threshold: SkipValidation[Optional[float]] = Field(alias="threshold", default=None, description="The similarity threshold.")
+    limit: SkipValidation[Optional[int]] = Field(alias="limit", default=None, description="The maximum number of results to be returned.")
     __properties: ClassVar[List[str]] = ["tenant", "env", "createPerson", "groupIds", "filter", "tag", "image", "outputImageParams", "detectAll", "threshold", "limit"]
 
     model_config = ConfigDict(
@@ -112,7 +112,7 @@ class SearchRequest(BaseModel):
             "outputImageParams": OutputImageParams.from_dict(obj["outputImageParams"]) if obj.get("outputImageParams") is not None else None,
             "detectAll": obj.get("detectAll") if obj.get("detectAll") is not None else False,
             "threshold": obj.get("threshold"),
-            "limit": obj.get("limit") if obj.get("limit") is not None else 100
+            "limit": obj.get("limit")
         })
         return _obj
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula/facesdk/webclient/gen/models/transaction_info.py

@@ -11,9 +11,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from regula.facesdk.webclient.gen.models.enroll_result import EnrollResult
 from regula.facesdk.webclient.gen.models.liveness_type import LivenessType
-from regula.facesdk.webclient.gen.models.verify_result import VerifyResult
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic import SkipValidation, Field
@@ -29,11 +27,9 @@ class TransactionInfo(BaseModel):
     video: SkipValidation[Optional[str]] = Field(alias="video", default=None, description="Link to the session video, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)")
     age: SkipValidation[Optional[List[Dict[str, object]]]] = Field(alias="age", default=None, description="Approximate age with an accuracy of +/-3 years.")
     portrait: SkipValidation[Optional[str]] = Field(alias="portrait", default=None, description="Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)")
-    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing the Person's extended attributes.")
+    metadata: SkipValidation[Optional[Dict[str, object]]] = Field(alias="metadata", default=None, description="A free-form object containing person's extended attributes.")
     type: SkipValidation[Optional[LivenessType]] = Field(alias="type", default=None)
-    enroll_result: SkipValidation[Optional[EnrollResult]] = Field(alias="enrollResult", default=None)
-    verify_result: SkipValidation[Optional[VerifyResult]] = Field(alias="verifyResult", default=None)
-    __properties: ClassVar[List[str]] = ["code", "status", "tag", "transactionId", "video", "age", "portrait", "metadata", "type", "enrollResult", "verifyResult"]
+    __properties: ClassVar[List[str]] = ["code", "status", "tag", "transactionId", "video", "age", "portrait", "metadata", "type"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -76,12 +72,6 @@ class TransactionInfo(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of enroll_result
-        if self.enroll_result:
-            _dict['enrollResult'] = self.enroll_result.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of verify_result
-        if self.verify_result:
-            _dict['verifyResult'] = self.verify_result.to_dict()
         return _dict
 
     @classmethod
@@ -102,9 +92,7 @@ class TransactionInfo(BaseModel):
             "age": obj.get("age"),
             "portrait": obj.get("portrait"),
             "metadata": obj.get("metadata"),
-            "type": obj.get("type"),
-            "enrollResult": EnrollResult.from_dict(obj["enrollResult"]) if obj.get("enrollResult") is not None else None,
-            "verifyResult": VerifyResult.from_dict(obj["verifyResult"]) if obj.get("verifyResult") is not None else None
+            "type": obj.get("type")
         })
         return _obj
 

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula_facesdk_webclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.5.898rc0
+Version: 9.1.3.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.
@@ -11,13 +11,13 @@ Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.07.04
 Requires-Dist: six>=1.10
 Requires-Dist: python-dateutil>=2.8.2
-Requires-Dist: urllib3<3.0.0,>=2.8.0
+Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: vistir<=0.6.1,>=0.4.0
-Requires-Dist: idna>=3.18
-Requires-Dist: requests>=2.33.0
+Requires-Dist: idna==3.7
+Requires-Dist: requests>=2.32.3
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
-Requires-Dist: lazy-imports>=1.0.1
+Requires-Dist: lazy-imports==1.0.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: description

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula_facesdk_webclient.egg-info/SOURCES.txt

@@ -52,8 +52,6 @@ regula/facesdk/webclient/gen/models/detection_attributes_details_inner.py
 regula/facesdk/webclient/gen/models/detection_face.py
 regula/facesdk/webclient/gen/models/detection_quality.py
 regula/facesdk/webclient/gen/models/device_info.py
-regula/facesdk/webclient/gen/models/enroll_result.py
-regula/facesdk/webclient/gen/models/enroll_search_result.py
 regula/facesdk/webclient/gen/models/face_attribute.py
 regula/facesdk/webclient/gen/models/face_image_quality_align_type.py
 regula/facesdk/webclient/gen/models/face_image_quality_groups.py
@@ -123,8 +121,6 @@ regula/facesdk/webclient/gen/models/search_result.py
 regula/facesdk/webclient/gen/models/transaction_info.py
 regula/facesdk/webclient/gen/models/transaction_labels.py
 regula/facesdk/webclient/gen/models/update_group.py
-regula/facesdk/webclient/gen/models/verify_result.py
-regula/facesdk/webclient/gen/models/verify_result_match.py
 regula_facesdk_webclient.egg-info/PKG-INFO
 regula_facesdk_webclient.egg-info/SOURCES.txt
 regula_facesdk_webclient.egg-info/dependency_links.txt

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/regula_facesdk_webclient.egg-info/requires.txt

@@ -1,10 +1,10 @@
 certifi>=2024.07.04
 six>=1.10
 python-dateutil>=2.8.2
-urllib3<3.0.0,>=2.8.0
+urllib3<3.0.0,>=1.25.3
 vistir<=0.6.1,>=0.4.0
-idna>=3.18
-requests>=2.33.0
+idna==3.7
+requests>=2.32.3
 pydantic>=2
 typing-extensions>=4.7.1
-lazy-imports>=1.0.1
+lazy-imports==1.0.1

{regula_facesdk_webclient-8.5.898rc0 → regula_facesdk_webclient-9.1.3.dev0}/setup.py

@@ -21,13 +21,13 @@ setup(
         "certifi>=2024.07.04",
         "six>=1.10",
         "python-dateutil>=2.8.2",
-        "urllib3>=2.8.0, <3.0.0",
+        "urllib3>=1.25.3, <3.0.0",
         "vistir>=0.4.0, <=0.6.1",
-        "idna>=3.18",
-        "requests>=2.33.0",
+        "idna==3.7",
+        "requests>=2.32.3",
         "pydantic>=2",
         "typing-extensions>=4.7.1",
-        "lazy-imports>=1.0.1",
+        "lazy-imports==1.0.1",
     ],
     packages=find_packages(exclude=["test", "tests", "example"]),
     include_package_data=True,

regula_facesdk_webclient-8.5.898rc0/regula/facesdk/webclient/gen/models/enroll_result.py

@@ -1,94 +0,0 @@
-# coding: utf-8
-
-"""
-    Generated by: https://openapi-generator.tech
-"""
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, Field, StrictBool
-from typing import Any, ClassVar, Dict, List, Optional
-from regula.facesdk.webclient.gen.models.enroll_search_result import EnrollSearchResult
-from regula.facesdk.webclient.gen.models.person import Person
-from typing import Optional, Set
-from typing_extensions import Self
-from pydantic import SkipValidation, Field
-
-class EnrollResult(BaseModel):
-    """
-    Result of the enrollment requested at session start via the `enroll` parameter. Returned only when enrollment was requested and the Enroll and Verify feature is enabled. Populated after the liveness check completes successfully.
-    """ # noqa: E501
-    enrolled: SkipValidation[Optional[bool]] = Field(alias="enrolled", default=None, description="Whether a new Person was created during enrollment. `true` when a new Person was created; `false` when a matching Person was found during the pre-enrollment search and no new Person was created.")
-    person: SkipValidation[Optional[Person]] = Field(alias="person", default=None, description="The Person created during enrollment. Present only when `enrolled` is `true`. If enrollment was started with an empty person object (`{}`), the Person is created with a randomly generated UUID as its `name`.")
-    search: SkipValidation[Optional[EnrollSearchResult]] = Field(alias="search", default=None)
-    __properties: ClassVar[List[str]] = ["enrolled", "person", "search"]
-
-    model_config = ConfigDict(
-        populate_by_name=True,
-        validate_assignment=True,
-        protected_namespaces=(),
-        arbitrary_types_allowed=True,
-        use_enum_values=True
-    )
-
-
-    def to_str(self) -> str:
-        """Returns the string representation of the model using alias"""
-        return pprint.pformat(self.model_dump(by_alias=True))
-
-    def to_json(self) -> str:
-        """Returns the JSON representation of the model using alias"""
-        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
-        return json.dumps(self.to_dict())
-
-    @classmethod
-    def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of EnrollResult from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of person
-        if self.person:
-            _dict['person'] = self.person.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of search
-        if self.search:
-            _dict['search'] = self.search.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of EnrollResult from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "enrolled": obj.get("enrolled"),
-            "person": Person.from_dict(obj["person"]) if obj.get("person") is not None else None,
-            "search": EnrollSearchResult.from_dict(obj["search"]) if obj.get("search") is not None else None
-        })
-        return _obj
-
-