regula.facesdk.webclient 5.2.4__tar.gz → 6.3.7.dev0__tar.gz

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: regula.facesdk.webclient
-Version: 5.2.4
+Version: 6.3.7.dev0
 Summary: Regula's FaceSDK web python client
 Home-page: https://mobile.regulaforensics.com
 Author: Regula Forensics, Inc.

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/ext/api/group_api.py

@@ -20,11 +20,11 @@ class GroupApi(GenGroupApi):
     def delete_group(self, group_id: str, **kwargs) -> None:
         return super().delete_group(group_id, **kwargs)
 
-    def get_all_groups(self, page: int, size: int, **kwargs) -> GroupPage:
-        return super().get_all_groups(page, size, **kwargs)
+    def get_all_groups(self, **kwargs) -> GroupPage:
+        return super().get_all_groups(**kwargs)
 
-    def get_all_persons_by_group_id(self, page: int, size: int, group_id: str, **kwargs) -> PersonsPage:
-        return super().get_all_persons_by_group_id(page, size, group_id, **kwargs)
+    def get_all_persons_by_group_id(self, group_id: str, **kwargs) -> PersonsPage:
+        return super().get_all_persons_by_group_id(group_id, **kwargs)
 
     def get_group(self, group_id: str, **kwargs) -> Group:
         return super().get_group(group_id, **kwargs)

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/ext/api/person_api.py

@@ -16,10 +16,12 @@ class PersonApi(GenPersonApi):
 
     def add_image_to_person(self, person_id: str, content: bytes, content_type: str = None, **kwargs) -> Image:
         base_image = base64.b64encode(content).decode("UTF-8")
-        image = ImageFields(ImageFieldsImage(content_type, base_image))
+        image = ImageFields(image=ImageFieldsImage(content_type, base_image))
         return super().add_image_to_person(person_id, image, **kwargs)
 
     def create_person(self, person_fields: PersonFields, **kwargs) -> Person:
+        if person_fields.metadata is None:
+            person_fields.metadata = {}
         return super().create_person(person_fields, **kwargs)
 
     def delete_image_of_person(self, image_id: str, person_id: str, **kwargs) -> None:
@@ -28,11 +30,11 @@ class PersonApi(GenPersonApi):
     def delete_person(self, person_id: str, **kwargs) -> None:
         return super().delete_person(person_id, **kwargs)
 
-    def get_all_groups_by_person_id(self, page: int, size: int, person_id: str, **kwargs):
-        return super().get_all_groups_by_person_id(page, size, person_id)
+    def get_all_groups_by_person_id(self, person_id: str, **kwargs):
+        return super().get_all_groups_by_person_id(person_id)
 
-    def get_all_images_by_person_id(self, page: int, size: int, person_id: str, **kwargs) -> ImagePage:
-        return super().get_all_images_by_person_id(page, size, person_id, **kwargs)
+    def get_all_images_by_person_id(self, person_id: str, **kwargs) -> ImagePage:
+        return super().get_all_images_by_person_id(person_id, **kwargs)
 
     def get_image_of_person(self, image_id: str, person_id: str, **kwargs):
         return super().get_image_of_person(image_id, person_id, **kwargs)

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/ext/api/search_api.py

@@ -11,5 +11,7 @@ class SearchApi(GenSearchApi):
         super().__init__(api_client)
 
     def search(self, search_request: SearchRequest, **kwargs) -> SearchResult:
-        search_request.image.content = base64.b64encode(search_request.image.content).decode("utf-8")
+        image = search_request.image
+        if image is not None:
+            search_request.image.content = base64.b64encode(image.content).decode("utf-8") if image.content else None
         return super().search(search_request, **kwargs)

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/ext/models/detect_request.py

@@ -2,14 +2,20 @@ from typing import Union
 
 from regula.facesdk.webclient.ext.common import Base64String, bytes_to_base64
 from regula.facesdk.webclient.gen import ApiValueError
+from regula.facesdk.webclient.gen.model.process_param import ProcessParam
 from regula.facesdk.webclient.gen.models import DetectRequest as GetDetectRequest
 
 
 class DetectRequest(GetDetectRequest):
     def __init__(
-            self, image: Union[Base64String, bytes],
-            only_central_face=False, attributes=False, thumbnails=False,
-            local_vars_configuration=None, tag=None
+            self,
+            image: Union[Base64String, bytes],
+            process_param: ProcessParam = None,
+            only_central_face=False,
+            thumbnails=False,
+            local_vars_configuration=None,
+            tag=None,
+
     ):
         if not image:
             raise ApiValueError(f"image: expected <not empty> - obtained <{image}>", "image")
@@ -18,6 +24,9 @@ class DetectRequest(GetDetectRequest):
             image = bytes_to_base64(image)
 
         super().__init__(
-            image=image, attributes=attributes, thumbnails=thumbnails,
-            local_vars_configuration=local_vars_configuration, tag=tag
+            image=image,
+            thumbnails=thumbnails,
+            local_vars_configuration=local_vars_configuration,
+            tag=tag,
+            process_param=process_param
         )

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/ext/models/match_request.py

@@ -28,7 +28,7 @@ class MatchRequest(GenMatchRequest):
         super().__init__(
             images=input_images,
             local_vars_configuration=local_vars_configuration,
-            # output_image_params=output_image_params,
+            output_image_params=output_image_params,
             thumbnails=thumbnails,
             tag=tag
         )

regula_facesdk_webclient-6.3.7.dev0/regula/facesdk/webclient/gen/__init__.py

@@ -0,0 +1,27 @@
+# flake8: noqa
+
+"""
+    Regula Face SDK Web API
+
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+
+    The version of the OpenAPI document: 6.2.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+__version__ = "1.0.0"
+
+# import ApiClient
+from regula.facesdk.webclient.gen.api_client import ApiClient
+
+# import Configuration
+from regula.facesdk.webclient.gen.configuration import Configuration
+
+# import exceptions
+from regula.facesdk.webclient.gen.exceptions import OpenApiException
+from regula.facesdk.webclient.gen.exceptions import ApiAttributeError
+from regula.facesdk.webclient.gen.exceptions import ApiTypeError
+from regula.facesdk.webclient.gen.exceptions import ApiValueError
+from regula.facesdk.webclient.gen.exceptions import ApiKeyError
+from regula.facesdk.webclient.gen.exceptions import ApiException

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/gen/api/diagnostics_api.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-    Regula FaceSDK Web API
+    Regula Face SDK Web API
 
-    Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
 
-    The version of the OpenAPI document: 5.2.0
+    The version of the OpenAPI document: 6.2.0
     Generated by: https://openapi-generator.tech
 """
 
@@ -102,7 +102,7 @@ class DiagnosticsApi(object):
         local_var_params = locals()
 
         all_params = [
-            'x_request_id'
+            'x_request_id',
         ]
         all_params.extend(
             [

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/gen/api/group_api.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-    Regula FaceSDK Web API
+    Regula Face SDK Web API
 
-    Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
 
-    The version of the OpenAPI document: 5.2.0
+    The version of the OpenAPI document: 6.2.0
     Generated by: https://openapi-generator.tech
 """
 
@@ -106,8 +106,8 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_to_create'
-            'x_request_id'
+            'group_to_create',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -246,8 +246,8 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'x_request_id'
+            'group_id',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -312,18 +312,18 @@ class GroupApi(object):
             collection_formats=collection_formats,
             _request_auth=local_var_params.get('_request_auth'))
 
-    def get_all_groups(self, page, size, **kwargs):  # noqa: E501
+    def get_all_groups(self, **kwargs):  # noqa: E501
         """Get groups  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_all_groups(page, size, async_req=True)
+        >>> thread = api.get_all_groups(async_req=True)
         >>> result = thread.get()
 
-        :param page: The page number to get a list of persons or groups. (required)
+        :param page: The page number to get a list of persons or groups.
         :type page: int
-        :param size: The page size with a list of persons or groups, items. (required)
+        :param size: The page size with a list of persons or groups, items.
         :type size: int
         :param x_request_id: Request header label.
         :type x_request_id: str
@@ -343,20 +343,20 @@ class GroupApi(object):
         :rtype: GroupPage
         """
         kwargs['_return_http_data_only'] = True
-        return self.get_all_groups_with_http_info(page, size, **kwargs)  # noqa: E501
+        return self.get_all_groups_with_http_info(**kwargs)  # noqa: E501
 
-    def get_all_groups_with_http_info(self, page, size, **kwargs):  # noqa: E501
+    def get_all_groups_with_http_info(self, **kwargs):  # noqa: E501
         """Get groups  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_all_groups_with_http_info(page, size, async_req=True)
+        >>> thread = api.get_all_groups_with_http_info(async_req=True)
         >>> result = thread.get()
 
-        :param page: The page number to get a list of persons or groups. (required)
+        :param page: The page number to get a list of persons or groups.
         :type page: int
-        :param size: The page size with a list of persons or groups, items. (required)
+        :param size: The page size with a list of persons or groups, items.
         :type size: int
         :param x_request_id: Request header label.
         :type x_request_id: str
@@ -386,9 +386,9 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'page'
-            'size'
-            'x_request_id'
+            'page',
+            'size',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -408,14 +408,6 @@ class GroupApi(object):
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
-        # verify the required parameter 'page' is set
-        if self.api_client.client_side_validation and ('page' not in local_var_params or  # noqa: E501
-                                                        local_var_params['page'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `page` when calling `get_all_groups`")  # noqa: E501
-        # verify the required parameter 'size' is set
-        if self.api_client.client_side_validation and ('size' not in local_var_params or  # noqa: E501
-                                                        local_var_params['size'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `size` when calling `get_all_groups`")  # noqa: E501
 
         collection_formats = {}
 
@@ -459,21 +451,21 @@ class GroupApi(object):
             collection_formats=collection_formats,
             _request_auth=local_var_params.get('_request_auth'))
 
-    def get_all_persons_by_group_id(self, page, size, group_id, **kwargs):  # noqa: E501
+    def get_all_persons_by_group_id(self, group_id, **kwargs):  # noqa: E501
         """Get group persons  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_all_persons_by_group_id(page, size, group_id, async_req=True)
+        >>> thread = api.get_all_persons_by_group_id(group_id, async_req=True)
         >>> result = thread.get()
 
-        :param page: The page number to get a list of persons or groups. (required)
-        :type page: int
-        :param size: The page size with a list of persons or groups, items. (required)
-        :type size: int
         :param group_id: Group ID. (required)
         :type group_id: str
+        :param page: The page number to get a list of persons or groups.
+        :type page: int
+        :param size: The page size with a list of persons or groups, items.
+        :type size: int
         :param x_request_id: Request header label.
         :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
@@ -492,23 +484,23 @@ class GroupApi(object):
         :rtype: PersonsPage
         """
         kwargs['_return_http_data_only'] = True
-        return self.get_all_persons_by_group_id_with_http_info(page, size, group_id, **kwargs)  # noqa: E501
+        return self.get_all_persons_by_group_id_with_http_info(group_id, **kwargs)  # noqa: E501
 
-    def get_all_persons_by_group_id_with_http_info(self, page, size, group_id, **kwargs):  # noqa: E501
+    def get_all_persons_by_group_id_with_http_info(self, group_id, **kwargs):  # noqa: E501
         """Get group persons  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_all_persons_by_group_id_with_http_info(page, size, group_id, async_req=True)
+        >>> thread = api.get_all_persons_by_group_id_with_http_info(group_id, async_req=True)
         >>> result = thread.get()
 
-        :param page: The page number to get a list of persons or groups. (required)
-        :type page: int
-        :param size: The page size with a list of persons or groups, items. (required)
-        :type size: int
         :param group_id: Group ID. (required)
         :type group_id: str
+        :param page: The page number to get a list of persons or groups.
+        :type page: int
+        :param size: The page size with a list of persons or groups, items.
+        :type size: int
         :param x_request_id: Request header label.
         :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
@@ -537,10 +529,10 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'page'
-            'size'
-            'group_id'
-            'x_request_id'
+            'group_id',
+            'page',
+            'size',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -560,14 +552,6 @@ class GroupApi(object):
                 )
             local_var_params[key] = val
         del local_var_params['kwargs']
-        # verify the required parameter 'page' is set
-        if self.api_client.client_side_validation and ('page' not in local_var_params or  # noqa: E501
-                                                        local_var_params['page'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `page` when calling `get_all_persons_by_group_id`")  # noqa: E501
-        # verify the required parameter 'size' is set
-        if self.api_client.client_side_validation and ('size' not in local_var_params or  # noqa: E501
-                                                        local_var_params['size'] is None):  # noqa: E501
-            raise ApiValueError("Missing the required parameter `size` when calling `get_all_persons_by_group_id`")  # noqa: E501
         # verify the required parameter 'group_id' is set
         if self.api_client.client_side_validation and ('group_id' not in local_var_params or  # noqa: E501
                                                         local_var_params['group_id'] is None):  # noqa: E501
@@ -687,8 +671,8 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'x_request_id'
+            'group_id',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -827,9 +811,9 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'group_to_create'
-            'x_request_id'
+            'group_id',
+            'group_to_create',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -978,9 +962,9 @@ class GroupApi(object):
         local_var_params = locals()
 
         all_params = [
-            'group_id'
-            'update_group'
-            'x_request_id'
+            'group_id',
+            'update_group',
+            'x_request_id',
         ]
         all_params.extend(
             [

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/gen/api/liveness_2_0_api.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-    Regula FaceSDK Web API
+    Regula Face SDK Web API
 
-    Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
 
-    The version of the OpenAPI document: 5.2.0
+    The version of the OpenAPI document: 6.2.0
     Generated by: https://openapi-generator.tech
 """
 
@@ -37,8 +37,9 @@ class Liveness20Api(object):
         self.api_client = api_client
 
     def get_liveness_transaction_info(self, transaction_id, **kwargs):  # noqa: E501
-        """Liveness assessment  # noqa: E501
+        """liveness check  # noqa: E501
 
+        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}`.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -66,8 +67,9 @@ class Liveness20Api(object):
         return self.get_liveness_transaction_info_with_http_info(transaction_id, **kwargs)  # noqa: E501
 
     def get_liveness_transaction_info_with_http_info(self, transaction_id, **kwargs):  # noqa: E501
-        """Liveness assessment  # noqa: E501
+        """liveness check  # noqa: E501
 
+        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}`.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -102,7 +104,7 @@ class Liveness20Api(object):
         local_var_params = locals()
 
         all_params = [
-            'transaction_id'
+            'transaction_id',
         ]
         all_params.extend(
             [

{regula.facesdk.webclient-5.2.4 → regula_facesdk_webclient-6.3.7.dev0}/regula/facesdk/webclient/gen/api/matching_api.py

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 """
-    Regula FaceSDK Web API
+    Regula Face SDK Web API
 
-    Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
+    <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core   # noqa: E501
 
-    The version of the OpenAPI document: 5.2.0
+    The version of the OpenAPI document: 6.2.0
     Generated by: https://openapi-generator.tech
 """
 
@@ -37,8 +37,9 @@ class MatchingApi(object):
         self.api_client = api_client
 
     def detect(self, detect_request, **kwargs):  # noqa: E501
-        """Detect face, evaluate attributes, assess the portrait quality  # noqa: E501
+        """detect and check quality  # noqa: E501
 
+        Use the POST `api/detect` endpoint to analyze images, recognize faces in them, and return cropped and aligned portraits of the detected people.  The Face Detection feature lets you: - **Check face image quality**: Assess whether a portrait meets certain standards, for example, ICAO, Schengen visa, USA visa. To perform image quality check, use the `processParam.quality` field. - **Evaluate face attributes**: Estimate the age range of a person; check whether the eyes are occluded, closed, or open; detect a facial expression or smile; see if there are glasses, sunglasses, head coverage, medical mask, etc. To evaluate attributes, add the `processParam.attributes` field.  You can perform Face Detection in two ways: - By adding parameters manually. In this case, the configuration is not saved and can not be automatically repeated. - By a processing `scenario` that includes certain parameters. You can use predefined scenarios or add custom ones.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -68,8 +69,9 @@ class MatchingApi(object):
         return self.detect_with_http_info(detect_request, **kwargs)  # noqa: E501
 
     def detect_with_http_info(self, detect_request, **kwargs):  # noqa: E501
-        """Detect face, evaluate attributes, assess the portrait quality  # noqa: E501
+        """detect and check quality  # noqa: E501
 
+        Use the POST `api/detect` endpoint to analyze images, recognize faces in them, and return cropped and aligned portraits of the detected people.  The Face Detection feature lets you: - **Check face image quality**: Assess whether a portrait meets certain standards, for example, ICAO, Schengen visa, USA visa. To perform image quality check, use the `processParam.quality` field. - **Evaluate face attributes**: Estimate the age range of a person; check whether the eyes are occluded, closed, or open; detect a facial expression or smile; see if there are glasses, sunglasses, head coverage, medical mask, etc. To evaluate attributes, add the `processParam.attributes` field.  You can perform Face Detection in two ways: - By adding parameters manually. In this case, the configuration is not saved and can not be automatically repeated. - By a processing `scenario` that includes certain parameters. You can use predefined scenarios or add custom ones.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -106,8 +108,8 @@ class MatchingApi(object):
         local_var_params = locals()
 
         all_params = [
-            'detect_request'
-            'x_request_id'
+            'detect_request',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -177,8 +179,9 @@ class MatchingApi(object):
             _request_auth=local_var_params.get('_request_auth'))
 
     def match(self, match_request, **kwargs):  # noqa: E501
-        """Compare faces in all combinations  # noqa: E501
+        """compare faces (1:1)  # noqa: E501
 
+        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`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -208,8 +211,9 @@ class MatchingApi(object):
         return self.match_with_http_info(match_request, **kwargs)  # noqa: E501
 
     def match_with_http_info(self, match_request, **kwargs):  # noqa: E501
-        """Compare faces in all combinations  # noqa: E501
+        """compare faces (1:1)  # noqa: E501
 
+        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`  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -246,8 +250,8 @@ class MatchingApi(object):
         local_var_params = locals()
 
         all_params = [
-            'match_request'
-            'x_request_id'
+            'match_request',
+            'x_request_id',
         ]
         all_params.extend(
             [
@@ -317,8 +321,9 @@ class MatchingApi(object):
             _request_auth=local_var_params.get('_request_auth'))
 
     def match_and_search(self, match_and_search_request, **kwargs):  # noqa: E501
-        """Match and Search in one request  # noqa: E501
+        """match and search (1:1 + 1:N)  # noqa: E501
 
+        To compare several images from a document and look up a person in the database in one request, use POST `/api/match_and_search`. In this case, the calculation of the descriptor will be performed only once, as opposed to using two requests for the same operation. If only one person is identified, matching is not performed and only search is carried out.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -348,8 +353,9 @@ class MatchingApi(object):
         return self.match_and_search_with_http_info(match_and_search_request, **kwargs)  # noqa: E501
 
     def match_and_search_with_http_info(self, match_and_search_request, **kwargs):  # noqa: E501
-        """Match and Search in one request  # noqa: E501
+        """match and search (1:1 + 1:N)  # noqa: E501
 
+        To compare several images from a document and look up a person in the database in one request, use POST `/api/match_and_search`. In this case, the calculation of the descriptor will be performed only once, as opposed to using two requests for the same operation. If only one person is identified, matching is not performed and only search is carried out.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -386,8 +392,8 @@ class MatchingApi(object):
         local_var_params = locals()
 
         all_params = [
-            'match_and_search_request'
-            'x_request_id'
+            'match_and_search_request',
+            'x_request_id',
         ]
         all_params.extend(
             [