regula-facesdk-webclient 8.4.866.dev0__tar.gz → 8.4.868.dev0__tar.gz

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.4.866.dev0
+Version: 8.4.868.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.
@@ -11,10 +11,10 @@ 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,>=1.25.3
+Requires-Dist: urllib3<3.0.0,>=2.8.0
 Requires-Dist: vistir<=0.6.1,>=0.4.0
 Requires-Dist: idna>=3.18
-Requires-Dist: requests>=2.32.3
+Requires-Dist: requests>=2.33.0
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
 Requires-Dist: lazy-imports>=1.0.1

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.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="The similarity threshold.")
+    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.")
     __properties: ClassVar[List[str]] = ["tenant", "env", "tag", "image", "threshold", "limit"]
 

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.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="The similarity threshold.")
+    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.")
     __properties: ClassVar[List[str]] = ["tag", "image", "threshold", "limit"]
 

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/regula/facesdk/webclient/gen/models/enroll_result.py

@@ -22,7 +22,7 @@ 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`.")
+    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"]
 

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/regula/facesdk/webclient/gen/models/filter_search_request.py

@@ -18,11 +18,11 @@ from pydantic import SkipValidation, Field
 
 class FilterSearchRequest(BaseModel):
     """
-    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.
+    Allows you to filter search results by Person fields. Currently, filtering is supported only by the `name` field.
     """ # noqa: E501
     op: SkipValidation[Optional[FilterOp]] = Field(alias="op", default=None)
-    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.")
+    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.")
     __properties: ClassVar[List[str]] = ["op", "field", "value"]
 
     model_config = ConfigDict(

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/regula/facesdk/webclient/gen/models/image_fields.py

@@ -25,7 +25,7 @@ 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="The similarity threshold.")
+    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.")
     __properties: ClassVar[List[str]] = ["tag", "image", "outputImageParams", "detectAll", "threshold", "limit"]
 

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.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="The similarity threshold.")
+    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.")
     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.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/regula/facesdk/webclient/gen/models/search_request.py

@@ -33,7 +33,7 @@ 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="The similarity threshold.")
+    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.")
     __properties: ClassVar[List[str]] = ["tenant", "env", "createPerson", "groupIds", "filter", "tag", "image", "outputImageParams", "detectAll", "threshold", "limit"]
 

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/regula/facesdk/webclient/gen/models/verify_result.py

@@ -22,7 +22,7 @@ class VerifyResult(BaseModel):
     Result of the verification requested at session start via the `verify` parameter. Returned only when verification was requested and the Enroll and Verify feature is enabled.
     """ # noqa: E501
     verified: SkipValidation[Optional[bool]] = Field(alias="verified", default=None, description="Whether the Person was successfully verified. `true` when the liveness check succeeds and the liveness portrait matches the enrolled Person according to the specified threshold; `false` when the liveness check fails or the faces do not match.")
-    person: SkipValidation[Optional[Person]] = Field(alias="person", default=None, description="The Person the liveness portrait was verified against.")
+    person: SkipValidation[Optional[Person]] = Field(alias="person", default=None, description="The Person the liveness portrait was verified against. Absent when the liveness check fails.")
     match: SkipValidation[Optional[VerifyResultMatch]] = Field(alias="match", default=None)
     __properties: ClassVar[List[str]] = ["verified", "person", "match"]
 

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/regula/facesdk/webclient/gen/models/verify_result_match.py

@@ -19,7 +19,7 @@ class VerifyResultMatch(BaseModel):
     """
     Face comparison details. Present when the liveness check succeeds.
     """ # noqa: E501
-    verified: SkipValidation[Optional[bool]] = Field(alias="verified", default=None, description="Whether the faces matched according to the specified similarity threshold. `true` when the face similarity meets the threshold; `false` when it does not.")
+    verified: SkipValidation[Optional[bool]] = Field(alias="verified", default=None, description="Whether the faces matched according to the specified threshold. `true` when the distance between the captured and enrolled portraits does not exceed the threshold; `false` when it exceeds the threshold.")
     similarity: SkipValidation[Optional[float]] = Field(alias="similarity", default=None, description="Face similarity score in the range from `0` to `1`.")
     __properties: ClassVar[List[str]] = ["verified", "similarity"]
 

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/regula_facesdk_webclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_facesdk_webclient
-Version: 8.4.866.dev0
+Version: 8.4.868.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.
@@ -11,10 +11,10 @@ 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,>=1.25.3
+Requires-Dist: urllib3<3.0.0,>=2.8.0
 Requires-Dist: vistir<=0.6.1,>=0.4.0
 Requires-Dist: idna>=3.18
-Requires-Dist: requests>=2.32.3
+Requires-Dist: requests>=2.33.0
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
 Requires-Dist: lazy-imports>=1.0.1

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.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,>=1.25.3
+urllib3<3.0.0,>=2.8.0
 vistir<=0.6.1,>=0.4.0
 idna>=3.18
-requests>=2.32.3
+requests>=2.33.0
 pydantic>=2
 typing-extensions>=4.7.1
 lazy-imports>=1.0.1

{regula_facesdk_webclient-8.4.866.dev0 → regula_facesdk_webclient-8.4.868.dev0}/setup.py

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