regula-documentreader-webclient 7.6.281.dev0__tar.gz

regula_documentreader_webclient-7.6.281.dev0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: regula_documentreader_webclient
+Version: 7.6.281.dev0
+Summary: Regula's Document Reader python client
+Home-page: https://regulaforensics.com
+Author: Regula Forensics, Inc.
+Author-email: support@regulaforensics.com
+Keywords: document-reader-client,document reader,document recognition,regulaforensics,regula
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: certifi>=2024.07.04
+Requires-Dist: six>=1.10
+Requires-Dist: python-dateutil>=2.5.3
+Requires-Dist: urllib3>=1.26.19
+Requires-Dist: vistir<=0.6.1,>=0.4.0
+Requires-Dist: idna==3.7
+Requires-Dist: requests>=2.32.3
+
+# Regula Document Reader web API Python 3.8+ client
+
+[![pypi](https://img.shields.io/pypi/v/regula.documentreader.webclient?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)
+[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
+[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)
+
+## ⚠️ Warning: Package Name Changed
+
+Package name has been changed from `regula.documentreader.webclient` to `regula_documentreader_webclient`
+
+Documents recognition as easy as reading two bytes.
+
+If you have any problems with or questions about this client, please contact us
+through a [GitHub issue](https://github.com/regulaforensics/DocumentReader-web-python-client/issues).
+You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/DocumentReader-web-python-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small;
+We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+See [dev guide](./dev.md)
+
+## Install package
+`regula_documentreader_webclient` is on the Python Package Index (PyPI):
+
+```bash
+pip install regula_documentreader_webclient
+```
+
+Or using `pipenv`
+```bash
+pipenv install regula_documentreader_webclient
+```
+
+## Example
+Performing request:
+```python
+from regula_documentreader_webclient import *
+
+with open("australia_passport.jpg", "rb") as f:
+    input_image = f.read()
+
+with DocumentReaderApi(host='http://localhost:8080') as api:
+    params = ProcessParams(
+        scenario=Scenario.FULL_PROCESS,
+        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
+    )
+    request = RecognitionRequest(process_params=params, images=[input_image])
+    response = api.process(request)
+```
+
+Parsing results:
+```python
+# status examples
+response_status = response.status
+doc_overall_status = "valid" if response_status.overall_status == CheckResult.OK else "not valid"
+
+# text fields example
+doc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER)
+doc_number_mrz = doc_number_field.get_value()
+doc_number_visual = doc_number_field.get_value(Source.VISUAL)
+doc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL)
+doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
+doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
+
+# images fields example
+normalized_input_image = response.images.document_image()
+portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)
+portrait_from_visual = portrait_field.get_value(Source.VISUAL)
+portrait_from_rfid = portrait_field.get_value(Source.RFID, original=True)
+```
+You can find more detailed guide and run this sample in [example](./example) folder.

regula_documentreader_webclient-7.6.281.dev0/README.md

@@ -0,0 +1,69 @@
+# Regula Document Reader web API Python 3.8+ client
+
+[![pypi](https://img.shields.io/pypi/v/regula.documentreader.webclient?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
+[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)
+[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
+[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)
+
+## ⚠️ Warning: Package Name Changed
+
+Package name has been changed from `regula.documentreader.webclient` to `regula_documentreader_webclient`
+
+Documents recognition as easy as reading two bytes.
+
+If you have any problems with or questions about this client, please contact us
+through a [GitHub issue](https://github.com/regulaforensics/DocumentReader-web-python-client/issues).
+You are invited to contribute [new features, fixes, or updates](https://github.com/regulaforensics/DocumentReader-web-python-client/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), large or small;
+We are always thrilled to receive pull requests, and do our best to process them as fast as we can.
+See [dev guide](./dev.md)
+
+## Install package
+`regula_documentreader_webclient` is on the Python Package Index (PyPI):
+
+```bash
+pip install regula_documentreader_webclient
+```
+
+Or using `pipenv`
+```bash
+pipenv install regula_documentreader_webclient
+```
+
+## Example
+Performing request:
+```python
+from regula_documentreader_webclient import *
+
+with open("australia_passport.jpg", "rb") as f:
+    input_image = f.read()
+
+with DocumentReaderApi(host='http://localhost:8080') as api:
+    params = ProcessParams(
+        scenario=Scenario.FULL_PROCESS,
+        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
+    )
+    request = RecognitionRequest(process_params=params, images=[input_image])
+    response = api.process(request)
+```
+
+Parsing results:
+```python
+# status examples
+response_status = response.status
+doc_overall_status = "valid" if response_status.overall_status == CheckResult.OK else "not valid"
+
+# text fields example
+doc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER)
+doc_number_mrz = doc_number_field.get_value()
+doc_number_visual = doc_number_field.get_value(Source.VISUAL)
+doc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL)
+doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
+doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
+
+# images fields example
+normalized_input_image = response.images.document_image()
+portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)
+portrait_from_visual = portrait_field.get_value(Source.VISUAL)
+portrait_from_rfid = portrait_field.get_value(Source.RFID, original=True)
+```
+You can find more detailed guide and run this sample in [example](./example) folder.

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/__init__.py

@@ -0,0 +1,2 @@
+from regula.documentreader.webclient.gen import *
+from regula.documentreader.webclient.ext import *

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/__init__.py

@@ -0,0 +1,13 @@
+from regula.documentreader.webclient.ext.api.document_reader_api import DocumentReaderApi
+from regula.documentreader.webclient.ext.models.authenticity.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
+from regula.documentreader.webclient.ext.models.images import Images, ImagesField
+from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
+from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest, RecognitionImage
+from regula.documentreader.webclient.ext.models.recognition_response import RecognitionResponse
+from regula.documentreader.webclient.ext.models.text import Text
+from regula.documentreader.webclient.ext.models.text_field import TextField

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/api/__init__.py

@@ -0,0 +1 @@
+from regula.documentreader.webclient.ext.api.document_reader_api import DocumentReaderApi

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/api/document_reader_api.py

@@ -0,0 +1,45 @@
+import base64
+from typing import Union
+
+from regula.documentreader.webclient import ProcessResponse
+from regula.documentreader.webclient.gen import ApiClient
+from regula.documentreader.webclient.ext.models.recognition_response import RecognitionResponse
+from regula.documentreader.webclient.gen.api import HealthcheckApi, ProcessApi
+from regula.documentreader.webclient.gen.configuration import Configuration
+from regula.documentreader.webclient.gen.models import ProcessRequest
+
+Base64String = str
+
+
+class DocumentReaderApi(HealthcheckApi, ProcessApi):
+
+    def __init__(self, host=None, debug=False, verify_ssl=True, api_client=None):
+        if api_client:
+            self.api_client = api_client
+        else:
+            configuration = Configuration(host=host)
+            configuration.debug = debug
+            configuration.verify_ssl = verify_ssl
+            self.api_client = ApiClient(configuration=configuration)
+        super().__init__(self.api_client)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.api_client.close()
+
+    def set_configuration(self, configuration) -> None:
+        self.api_client.configuration = configuration
+
+    def process(self, process_request: ProcessRequest) -> RecognitionResponse:
+        return RecognitionResponse(self.api_process(process_request))
+
+    def deserialize_to_recognition_response(self, content: Union[bytes, bytearray, str]) -> RecognitionResponse:
+        response = self.__to_response_object(content)
+        response = self.api_client.deserialize(response, ProcessResponse)
+        return RecognitionResponse(response)
+
+    @staticmethod
+    def __to_response_object(content: Union[bytes, bytearray, str]):
+        return type(ProcessResponse.__name__, (object,), {"data": content})()

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/__init__.py

@@ -0,0 +1,14 @@
+from regula.documentreader.webclient.ext.models.authenticity.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
+from regula.documentreader.webclient.ext.models.images import Images, ImagesField
+from regula.documentreader.webclient.ext.models.raw_authenticity_result_item import RawAuthenticityCheckResultItem
+from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
+from regula.documentreader.webclient.ext.models.recognition_request import RecognitionImage
+from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest
+from regula.documentreader.webclient.ext.models.recognition_response import RecognitionResponse
+from regula.documentreader.webclient.ext.models.text import Text
+from regula.documentreader.webclient.ext.models.text_field import TextField

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/authenticity/__init__.py

@@ -0,0 +1,6 @@
+from regula.documentreader.webclient.ext.models.authenticity.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py

@@ -0,0 +1,78 @@
+from typing import Optional
+
+from regula.documentreader.webclient import gen, AuthenticityResultType
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
+
+
+class AuthenticityCheckList(gen.AuthenticityCheckList):
+
+    @property
+    def uv_luminescence_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.UV_LUMINESCENCE, SecurityFeatureChecks)
+
+    @property
+    def ir_b900_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.IR_B900, SecurityFeatureChecks)
+
+    @property
+    def image_pattern_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.IMAGE_PATTERN, IdentChecks)
+
+    @property
+    def axial_protection_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.AXIAL_PROTECTION, SecurityFeatureChecks)
+
+    @property
+    def uv_fiber_checks(self) -> Optional[FiberChecks]:
+        return self.__result_by_type(AuthenticityResultType.UV_FIBERS, FiberChecks)
+
+    @property
+    def ir_visibility_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.IR_VISIBILITY, IdentChecks)
+
+    @property
+    def ocr_security_text_checks(self) -> Optional[OCRSecurityTextChecks]:
+        return self.__result_by_type(AuthenticityResultType.OCR_SECURITY_TEXT, OCRSecurityTextChecks)
+
+    @property
+    def ipi_checks(self) -> Optional[ImageIdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.IPI, ImageIdentChecks)
+
+    @property
+    def embed_image_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.PHOTO_EMBED_TYPE, SecurityFeatureChecks)
+
+    @property
+    def holograms_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.HOLOGRAMS, SecurityFeatureChecks)
+
+    @property
+    def photo_area_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.PHOTO_AREA, SecurityFeatureChecks)
+
+    @property
+    def portrait_comparison_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.PORTRAIT_COMPARISON, IdentChecks)
+
+    @property
+    def barcode_format_checks(self) -> Optional[SecurityFeatureChecks]:
+        return self.__result_by_type(AuthenticityResultType.BARCODE_FORMAT_CHECK, SecurityFeatureChecks)
+
+    @property
+    def kinegram_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.KINEGRAM, IdentChecks)
+
+    @property
+    def letter_screen_checks(self) -> Optional[IdentChecks]:
+        return self.__result_by_type(AuthenticityResultType.LETTER_SCREEN, IdentChecks)
+
+    def __result_by_type(self, authenticity_type: int, parent_class: type) -> Optional[gen.AuthenticityCheckResult]:
+        for result in self.list:
+            if result.type == authenticity_type:
+                result.__class__ = parent_class
+                return result
+        return None

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/authenticity/fiber.py

@@ -0,0 +1,11 @@
+from typing import List
+
+from regula.documentreader.webclient import gen
+
+
+class FiberChecks(gen.AuthenticityCheckResult):
+
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.FiberResult]:
+        # noinspection PyTypeChecker
+        return super().list

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/authenticity/ident.py

@@ -0,0 +1,14 @@
+from typing import List, Optional
+
+from regula.documentreader.webclient import gen
+
+
+class IdentChecks(gen.AuthenticityCheckResult):
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.IdentResult]:
+        # noinspection PyTypeChecker
+        return super().list
+
+    # element_type is SecurityFeatureType
+    def checks_by_element(self, element_type: int) -> List[gen.IdentResult]:
+        return [check for check in self.list if check.element_type == element_type]

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/authenticity/image_ident.py

@@ -0,0 +1,10 @@
+from typing import List
+
+from regula.documentreader.webclient import gen
+
+
+class ImageIdentChecks(gen.AuthenticityCheckResult):
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.PhotoIdentResult]:
+        # noinspection PyTypeChecker
+        return super().list

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py

@@ -0,0 +1,11 @@
+from typing import List
+
+from regula.documentreader.webclient import gen
+
+
+class OCRSecurityTextChecks(gen.AuthenticityCheckResult):
+
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.OCRSecurityTextResult]:
+        # noinspection PyTypeChecker
+        return super().list

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/authenticity/security_feature.py

@@ -0,0 +1,13 @@
+from typing import List, Optional
+
+from regula.documentreader.webclient import gen
+
+
+class SecurityFeatureChecks(gen.AuthenticityCheckResult):
+    @gen.AuthenticityCheckResult.list.getter
+    def list(self) -> List[gen.SecurityFeatureResult]:
+        return super().list
+
+    # element_type is SecurityFeatureType
+    def checks_by_element(self, element_type: int) -> List[gen.SecurityFeatureResult]:
+        return [check for check in self.list if check.element_type == element_type]

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/images.py

@@ -0,0 +1,40 @@
+import base64
+from typing import Optional, List
+
+from regula.documentreader.webclient.gen.models import Images as GenImages, ImagesField as GetImagesField, Source
+
+
+class ImagesField(GetImagesField):
+
+    def get_value(self, source: str = None, original=False) -> Optional[bytes]:
+
+        if not source:
+            value = self.get_value(Source.RFID)
+            if not value: value = self.get_value(Source.VISUAL)
+            if not value: value = self.get_value(Source.BARCODE)
+            if not value: value = self.get_value("UNKNOWN") # temp fix, will be removed
+            return value
+        else:
+            field_value = None
+            for v in self.value_list:
+                if v.source == source:
+                    field_value = v
+
+            if not field_value:
+                return None
+
+            if original:
+                return base64.b64decode(field_value.original_value)
+            return base64.b64decode(field_value.value)
+
+
+class Images(GenImages):
+
+    def get_field(self, field_type: int) -> Optional[ImagesField]:
+        for field in self.field_list:
+            if field.field_type == field_type:
+                return field
+        return None
+
+    def get_fields(self, field_type: int) -> List[ImagesField]:
+        return [field for field in self.field_list if field.field_type == field_type]

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/raw_authenticity_result_item.py

@@ -0,0 +1,27 @@
+from copy import copy
+
+from regula.documentreader.webclient.gen.models.authenticity_check_result_item import AuthenticityCheckResultItem
+
+
+class RawAuthenticityCheckResultItem(AuthenticityCheckResultItem):
+    openapi_types = copy(AuthenticityCheckResultItem.openapi_types)
+    openapi_types["raw"] = "dict"
+
+    attribute_map = copy(AuthenticityCheckResultItem.attribute_map)
+    attribute_map["raw"] = "raw"
+
+    def __init__(self, type=0, element_result=None, element_diagnose=None, raw=None, percent_value=None, local_vars_configuration=None):
+        super().__init__(type, element_result, element_diagnose, percent_value, local_vars_configuration)
+        self.__raw = raw
+
+    @property
+    def raw(self):
+        return self.__raw
+
+    def to_dict(self):
+        result = super(RawAuthenticityCheckResultItem, self).to_dict()
+        result["raw"] = self.__raw
+        return result
+
+    def get_real_child_model(self, data):
+        return None

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/raw_result_item.py

@@ -0,0 +1,26 @@
+from copy import copy
+
+from regula.documentreader.webclient.gen.models.result_item import ResultItem
+
+
+class RawResultItem(ResultItem):
+    openapi_types = copy(ResultItem.openapi_types)
+    openapi_types["raw"] = "dict"
+
+    attribute_map = copy(ResultItem.attribute_map)
+    attribute_map["raw"] = "raw"
+
+    def __init__(self, buf_length=None, light=None, list_idx=None, page_idx=None, result_type=None, raw=None,
+                 local_vars_configuration=None):
+        super().__init__(buf_length, light, list_idx, page_idx, result_type, local_vars_configuration)
+        self.__raw = raw
+
+    @property
+    def raw(self):
+        return self.__raw
+
+    def to_dict(self):
+        return self.__raw
+
+    def get_real_child_model(self, data):
+        return None

regula_documentreader_webclient-7.6.281.dev0/regula/documentreader/webclient/ext/models/recognition_request.py

@@ -0,0 +1,93 @@
+import json
+import base64
+from typing import List, Union
+
+from regula.documentreader.webclient import LicenseResult, EncryptedRCLResult, ContainerList, Result
+from regula.documentreader.webclient.gen.models import ImageData, ProcessParams
+from regula.documentreader.webclient.gen.models.process_request import ProcessRequest
+from regula.documentreader.webclient.gen.models.process_request_image import ProcessRequestImage
+from regula.documentreader.webclient.gen.models.process_system_info import ProcessSystemInfo
+
+Base64String = str
+
+
+class RecognitionImage(ProcessRequestImage):
+    def __init__(self, image: Union[bytes, Base64String], light_index=None, page_index=None):
+        if isinstance(image, bytes):
+            image = base64.b64encode(image).decode("utf-8")
+        super().__init__(ImageData(image), light_index, page_index)
+
+
+class LicenseRequest(LicenseResult):
+    def __init__(self, _license: Union[bytes, Base64String],
+                 _light: int = None, _list_idx: int = None, _page_idx: int = None):
+        if isinstance(_license, bytes):
+            # if we need to encode
+            __license = base64.b64encode(_license).decode("uft-8")
+        else:
+            __license = _license
+        _buf_length = len(_license)
+        _result_type = Result.LICENSE
+        super().__init__(
+            __license,
+            _buf_length,
+            _light,
+            _list_idx,
+            _page_idx,
+            _result_type
+        )
+
+
+class EncryptedRCLRequest(EncryptedRCLResult):
+    def __init__(self, _encrypted_rcl: Union[bytes, Base64String] = None,
+                 _light: int = None, _list_idx: int = None, _page_idx: int = None):
+        if isinstance(_encrypted_rcl, bytes):
+            # if we need to encode
+            __encrypted_rcl = base64.b64encode(_encrypted_rcl).decode("uft-8")
+        else:
+            __encrypted_rcl = _encrypted_rcl
+
+        _buf_length = len(_encrypted_rcl)
+        _result_type = Result.ENCRYPTED_RCL
+        super().__init__(
+            __encrypted_rcl,
+            _buf_length,
+            _light,
+            _list_idx,
+            _page_idx,
+            _result_type
+        )
+
+
+class RecognitionRequest(ProcessRequest):
+    def __init__(
+            self,
+            process_params: ProcessParams,
+            images: List[Union[RecognitionImage, bytes, Base64String]] = None,
+            container_list: ContainerList = None, tag=None,
+            system_info: ProcessSystemInfo = ProcessSystemInfo(),
+    ):
+        input_images = []
+        if images:
+            for image in images:
+                if isinstance(image, (bytes, str)):
+                    input_images.append(RecognitionImage(image))
+                else:
+                    input_images.append(image)
+            super().__init__(
+                process_param=process_params,
+                list=input_images,
+                system_info=system_info,
+                tag=tag
+            )
+        if container_list:
+            super().__init__(
+                process_param=process_params,
+                container_list=container_list,
+                system_info=system_info,
+                tag=tag
+            )
+
+    @property
+    def json(self) -> str:
+        return json.dumps(self.to_dict())