regula-documentreader-webclient 9.9.1072rc0__tar.gz → 9.9.1073.dev0__tar.gz

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 9.9.1072rc0
+Version: 9.9.1073.dev0
 Summary: Regula's Document Reader python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/chosen_document_type.py

@@ -26,7 +26,7 @@ class ChosenDocumentType(BaseModel):
     id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)")
     p: SkipValidation[float] = Field(alias="P", description="A measure of the likelihood of correct recognition in the analysis of this type of document")
     rotated180: SkipValidation[int] = Field(alias="Rotated180", description="Indicates if the document of the given type is rotated by 180 degrees")
-    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence")
+    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence", description="Indication of the presence of an RFID chip in the document (electronic document indicator)")
     fdsid_list: SkipValidation[Optional[FDSIDList]] = Field(alias="FDSIDList", default=None)
     necessary_lights: SkipValidation[int] = Field(alias="NecessaryLights", description="Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document")
     check_authenticity: SkipValidation[int] = Field(alias="CheckAuthenticity", description="Set of authentication options provided for this type of document (combination of Authenticity enum)")

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/details_optical.py

@@ -20,14 +20,14 @@ class DetailsOptical(BaseModel):
     """
     Details on performed optical checks
     """ # noqa: E501
-    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus")
-    doc_type: SkipValidation[CheckResult] = Field(alias="docType")
-    expiry: SkipValidation[CheckResult] = Field(alias="expiry")
-    image_qa: SkipValidation[CheckResult] = Field(alias="imageQA")
-    mrz: SkipValidation[CheckResult] = Field(alias="mrz")
+    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus", description="Overall optical checks combined status")
+    doc_type: SkipValidation[CheckResult] = Field(alias="docType", description="Status of document type recognition")
+    expiry: SkipValidation[CheckResult] = Field(alias="expiry", description="Status of document expiration")
+    image_qa: SkipValidation[CheckResult] = Field(alias="imageQA", description="Status of document image quality check")
+    mrz: SkipValidation[CheckResult] = Field(alias="mrz", description="Status of document MRZ")
     pages_count: SkipValidation[int] = Field(alias="pagesCount", description="Number of processed pages in the document")
-    security: SkipValidation[CheckResult] = Field(alias="security")
-    text: SkipValidation[CheckResult] = Field(alias="text")
+    security: SkipValidation[CheckResult] = Field(alias="security", description="Authenticity verification status")
+    text: SkipValidation[CheckResult] = Field(alias="text", description="Status of text fields analysis")
     vds: SkipValidation[Optional[int]] = Field(alias="vds", default=None)
     __properties: ClassVar[List[str]] = ["overallStatus", "docType", "expiry", "imageQA", "mrz", "pagesCount", "security", "text", "vds"]
 

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/details_rfid.py

@@ -20,13 +20,13 @@ class DetailsRFID(BaseModel):
     """
     Details on performed RFID checks
     """ # noqa: E501
-    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus")
-    aa: SkipValidation[CheckResult] = Field(alias="AA")
-    bac: SkipValidation[CheckResult] = Field(alias="BAC")
-    ca: SkipValidation[CheckResult] = Field(alias="CA")
-    pa: SkipValidation[CheckResult] = Field(alias="PA")
-    pace: SkipValidation[CheckResult] = Field(alias="PACE")
-    ta: SkipValidation[CheckResult] = Field(alias="TA")
+    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus", description="Overall RFID checks combined status")
+    aa: SkipValidation[CheckResult] = Field(alias="AA", description="Active Authentication status")
+    bac: SkipValidation[CheckResult] = Field(alias="BAC", description="Basic Access Control (BAC) status")
+    ca: SkipValidation[CheckResult] = Field(alias="CA", description="Chip Authentication status")
+    pa: SkipValidation[CheckResult] = Field(alias="PA", description="Passive Authentication status")
+    pace: SkipValidation[CheckResult] = Field(alias="PACE", description="Password Authenticated Connection Establishment (PACE) status")
+    ta: SkipValidation[CheckResult] = Field(alias="TA", description="Terminal Authentication status")
     __properties: ClassVar[List[str]] = ["overallStatus", "AA", "BAC", "CA", "PA", "PACE", "TA"]
 
     model_config = ConfigDict(

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/doc_visual_extended_field.py

@@ -35,7 +35,7 @@ class DocVisualExtendedField(BaseModel):
     w_lcid: SkipValidation[Optional[LCID]] = Field(alias="wLCID", default=None)
     reserved2: SkipValidation[Optional[int]] = Field(alias="Reserved2", default=None)
     reserved3: SkipValidation[Optional[int]] = Field(alias="Reserved3", default=None)
-    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect")
+    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect", description="Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.")
     __properties: ClassVar[List[str]] = ["wFieldType", "FieldName", "StringsCount", "StringsResult", "Buf_Length", "Buf_Text", "FieldMask", "Validity", "InComparison", "wLCID", "Reserved2", "Reserved3", "FieldRect"]
 
     model_config = ConfigDict(

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/doc_visual_extended_field_item.py

@@ -20,7 +20,7 @@ class DocVisualExtendedFieldItem(BaseModel):
     """
     DocVisualExtendedFieldItem
     """ # noqa: E501
-    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect")
+    field_rect: SkipValidation[RectangleCoordinates] = Field(alias="FieldRect", description="Coordinates of the text field in the normalized image of the document. Only for Result.VISUAL_TEXT and Result.MRZ_TEXT results.")
     __properties: ClassVar[List[str]] = ["FieldRect"]
 
     model_config = ConfigDict(

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/document_format.py

@@ -25,6 +25,7 @@ class DocumentFormat(int, Enum):
     NON = 3
     A4 = 4
     ID3_X2 = 5
+    ID2_TURKEY = 6
     ID1_90 = 10
     ID1_180 = 11
     ID1_270 = 12

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/document_types_candidates.py

@@ -21,7 +21,7 @@ class DocumentTypesCandidates(BaseModel):
     """
     DocumentTypesCandidates
     """ # noqa: E501
-    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None)
+    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None, description="Overall recognition result")
     candidates: SkipValidation[Optional[List[OneCandidate]]] = Field(alias="Candidates", default=None)
     __properties: ClassVar[List[str]] = ["RecResult", "Candidates"]
 

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/document_types_candidates_list.py

@@ -21,7 +21,7 @@ class DocumentTypesCandidatesList(BaseModel):
     """
     DocumentTypesCandidatesList
     """ # noqa: E501
-    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None)
+    rec_result: SkipValidation[Optional[DocumentTypeRecognitionResult]] = Field(alias="RecResult", default=None, description="Overall recognition result")
     candidates: SkipValidation[Optional[List[OneCandidate]]] = Field(alias="Candidates", default=None)
     __properties: ClassVar[List[str]] = ["RecResult", "Candidates"]
 

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/fiber_item.py

@@ -23,13 +23,13 @@ class FiberItem(BaseModel):
     """ # noqa: E501
     rect_count: SkipValidation[int] = Field(alias="RectCount", description="For UV_Fibers authenticity result type")
     expected_count: SkipValidation[int] = Field(alias="ExpectedCount", description="Expected fibers number. For UV_Fibers authentication result type")
-    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None)
+    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None, description="For UV_Background authentication result type")
     light_disp: SkipValidation[Optional[int]] = Field(alias="LightDisp", default=None, description="For UV_Background authentication result type")
     rect_array: SkipValidation[List[RectangleCoordinates]] = Field(alias="RectArray", description="Coordinates of located areas for defined fibers type")
     width: SkipValidation[List[int]] = Field(alias="Width", description="Fibers width value for located areas (in pixels)")
     length: SkipValidation[List[int]] = Field(alias="Length", description="Fibers length value for located areas (in pixels)")
     area: SkipValidation[List[int]] = Field(alias="Area", description="Fibers value for areas (in pixels)")
-    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value")
+    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value. Example: [BLUE, GREEN, RED]")
     __properties: ClassVar[List[str]] = ["RectCount", "ExpectedCount", "LightValue", "LightDisp", "RectArray", "Width", "Length", "Area", "ColorValues"]
 
     model_config = ConfigDict(

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/fiber_result.py

@@ -27,13 +27,13 @@ class FiberResult(AuthenticityCheckResultItem):
     """ # noqa: E501
     rect_count: SkipValidation[int] = Field(alias="RectCount", description="For UV_Fibers authenticity result type")
     expected_count: SkipValidation[int] = Field(alias="ExpectedCount", description="Expected fibers number. For UV_Fibers authentication result type")
-    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None)
+    light_value: SkipValidation[Optional[Light]] = Field(alias="LightValue", default=None, description="For UV_Background authentication result type")
     light_disp: SkipValidation[Optional[int]] = Field(alias="LightDisp", default=None, description="For UV_Background authentication result type")
     rect_array: SkipValidation[List[RectangleCoordinates]] = Field(alias="RectArray", description="Coordinates of located areas for defined fibers type")
     width: SkipValidation[List[int]] = Field(alias="Width", description="Fibers width value for located areas (in pixels)")
     length: SkipValidation[List[int]] = Field(alias="Length", description="Fibers length value for located areas (in pixels)")
     area: SkipValidation[List[int]] = Field(alias="Area", description="Fibers value for areas (in pixels)")
-    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value")
+    color_values: SkipValidation[List[int]] = Field(alias="ColorValues", description="Fibers color value. Example: [BLUE, GREEN, RED]")
     __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue", "RectCount", "ExpectedCount", "LightValue", "LightDisp", "RectArray", "Width", "Length", "Area", "ColorValues"]
 
     model_config = ConfigDict(

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/ident_item.py

@@ -27,8 +27,8 @@ class IdentItem(BaseModel):
     element_type: SkipValidation[SecurityFeatureType] = Field(alias="ElementType")
     light_index: SkipValidation[Light] = Field(alias="LightIndex")
     area: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="Area", default=None)
-    image: SkipValidation[ImageData] = Field(alias="Image")
-    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage")
+    image: SkipValidation[ImageData] = Field(alias="Image", description="Original image")
+    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage", description="Reference image")
     area_list: SkipValidation[Optional[AreaContainer]] = Field(alias="AreaList", default=None)
     element_id: SkipValidation[Optional[int]] = Field(alias="ElementID", default=None)
     __properties: ClassVar[List[str]] = ["ElementType", "LightIndex", "Area", "Image", "EtalonImage", "AreaList", "ElementID"]

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/ident_result.py

@@ -31,8 +31,8 @@ class IdentResult(AuthenticityCheckResultItem):
     element_type: SkipValidation[SecurityFeatureType] = Field(alias="ElementType")
     light_index: SkipValidation[Light] = Field(alias="LightIndex")
     area: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="Area", default=None)
-    image: SkipValidation[ImageData] = Field(alias="Image")
-    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage")
+    image: SkipValidation[ImageData] = Field(alias="Image", description="Original image")
+    etalon_image: SkipValidation[ImageData] = Field(alias="EtalonImage", description="Reference image")
     area_list: SkipValidation[Optional[AreaContainer]] = Field(alias="AreaList", default=None)
     element_id: SkipValidation[Optional[int]] = Field(alias="ElementID", default=None)
     __properties: ClassVar[List[str]] = ["Type", "ElementResult", "ElementDiagnose", "PercentValue", "ElementType", "LightIndex", "Area", "Image", "EtalonImage", "AreaList", "ElementID"]

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/image_quality_check_list.py

@@ -21,7 +21,7 @@ class ImageQualityCheckList(BaseModel):
     """
     ImageQualityCheckList
     """ # noqa: E501
-    result: SkipValidation[CheckResult] = Field(alias="result")
+    result: SkipValidation[CheckResult] = Field(alias="result", description="Overall image quality status, combined from check statuses in the list.")
     list: SkipValidation[List[ImageQualityCheck]] = Field(alias="List")
     count: SkipValidation[float] = Field(alias="Count", description="Number of List array elements")
     __properties: ClassVar[List[str]] = ["result", "List", "Count"]

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/images_field_value.py

@@ -25,13 +25,13 @@ class ImagesFieldValue(BaseModel):
     """ # noqa: E501
     source: SkipValidation[Source] = Field(alias="source")
     value: SkipValidation[Optional[str]] = Field(alias="value", default=None, description="Base64 encoded image")
-    original_value: SkipValidation[Optional[str]] = Field(alias="originalValue", default=None, description="Base64 encoded image")
+    original_value: SkipValidation[Optional[str]] = Field(alias="originalValue", default=None, description="Only for images from RFID. Image as was originally stored in the RFID chip.")
     original_page_index: SkipValidation[Optional[int]] = Field(alias="originalPageIndex", default=None, description="Original page index")
     page_index: SkipValidation[int] = Field(alias="pageIndex", description="Page index of the image from input list")
     light_index: SkipValidation[Light] = Field(alias="lightIndex")
     container_type: SkipValidation[int] = Field(alias="containerType", description="Same as Result type, but used for safe parsing of not-described values. See Result type.")
-    field_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="fieldRect", default=None)
-    rfid_origin: SkipValidation[Optional[RfidOrigin]] = Field(alias="rfidOrigin", default=None)
+    field_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="fieldRect", default=None, description="Only for images from VISUAL. Coordinates of the image in the normalized image of the document.")
+    rfid_origin: SkipValidation[Optional[RfidOrigin]] = Field(alias="rfidOrigin", default=None, description="Only for images from RFID. Image location in RFID chip.")
     __properties: ClassVar[List[str]] = ["source", "value", "originalValue", "originalPageIndex", "pageIndex", "lightIndex", "containerType", "fieldRect", "rfidOrigin"]
 
     model_config = ConfigDict(

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/light.py

@@ -23,8 +23,24 @@ class Light(int, Enum):
     WHITE_SIDE = 4
     WHITE = 6
     IR = 24
+    TRANSMITTED = 32
+    TRANSMITTED_IR = 64
     UV = 128
+    WHITE_UV = 134
+    IR_LUMINESCENCE = 256
     AXIAL_WHITE = 3072
+    IR_720 = 4096
+    IR_940 = 8192
+    ANTI_STOKES = 65536
+    UVC = 524288
+    UVB = 1048576
+    WHITE_OBL = 2097152
+    WHITE_SPECIAL = 4194304
+    OVD = 67108864
+    IR_870_OBL = 268435456
+    HR_WHITE = 1073741830
+    HR_IR = 1073741848
+    HR_UV = 1073741952
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/one_candidate.py

@@ -26,7 +26,7 @@ class OneCandidate(BaseModel):
     id: SkipValidation[int] = Field(alias="ID", description="Unique document type template identifier (Regula's internal numeric code)")
     p: SkipValidation[float] = Field(alias="P", description="A measure of the likelihood of correct recognition in the analysis of this type of document")
     rotated180: SkipValidation[int] = Field(alias="Rotated180", description="Indicates if the document of the given type is rotated by 180 degrees")
-    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence")
+    rfid_presence: SkipValidation[RfidLocation] = Field(alias="RFID_Presence", description="Indication of the presence of an RFID chip in the document (electronic document indicator)")
     fdsid_list: SkipValidation[Optional[FDSIDList]] = Field(alias="FDSIDList", default=None)
     necessary_lights: SkipValidation[int] = Field(alias="NecessaryLights", description="Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document")
     check_authenticity: SkipValidation[int] = Field(alias="CheckAuthenticity", description="Set of authentication options provided for this type of document (combination of Authenticity enum)")

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/process_params.py

@@ -53,13 +53,13 @@ class ProcessParams(BaseModel):
     field_types_filter: SkipValidation[Optional[List[TextFieldType]]] = Field(alias="fieldTypesFilter", default=None, description="If a document contains Visual zone, you can set the list of field types to extract. In this case, other fields are skipped during the processing, i.e. document recognition becomes faster. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.")
     field_types_ignore_filter: SkipValidation[Optional[List[TextFieldType]]] = Field(alias="fieldTypesIgnoreFilter", default=None, description="If a document contains a Visual zone, you can specify a list of field types that should be excluded from extraction. All field types listed in this array are skipped during processing, while the remaining fields are recognized. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesIgnoreFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.")
     date_format: SkipValidation[Optional[str]] = Field(alias="dateFormat", default=None, description="This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running).")
-    measure_system: SkipValidation[Optional[MeasureSystem]] = Field(alias="measureSystem", default=None)
+    measure_system: SkipValidation[Optional[MeasureSystem]] = Field(alias="measureSystem", default=None, description="This option allows you to set the system of measurement used for converting original values in document to output result values. Metric by default.")
     image_dpi_out_max: SkipValidation[Optional[int]] = Field(alias="imageDpiOutMax", default=None, description="This parameter controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi for all scenarios except FullAuth. In FullAuth scenario this limit is 1000 dpi by default.")
     already_cropped: SkipValidation[Optional[bool]] = Field(alias="alreadyCropped", default=None, description="This option can be enabled if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile. Disabled by default.")
     custom_params: SkipValidation[Optional[Dict[str, object]]] = Field(alias="customParams", default=None, description="This option allows passing custom processing parameters that can be implemented in future without changing API.")
     config: SkipValidation[Optional[List[PerDocumentConfig]]] = Field(alias="config", default=None, description="This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration.")
     log: SkipValidation[Optional[bool]] = Field(alias="log", default=None, description="When enabled, results will contain transaction processing log. Disabled by default")
-    log_level: SkipValidation[Optional[LogLevel]] = Field(alias="logLevel", default=None)
+    log_level: SkipValidation[Optional[LogLevel]] = Field(alias="logLevel", default=None, description="When used together with 'log' parameter enabled, sets the level of logs detalization. 'INFO' by default.")
     force_doc_id: SkipValidation[Optional[int]] = Field(alias="forceDocID", default=None, description="Force use of specific template ID and skip document type identification step.")
     match_text_field_mask: SkipValidation[Optional[bool]] = Field(alias="matchTextFieldMask", default=None, description="When disabled, text field OCR will be done as is and then the recognized value will be matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask in the template. Enabled by default.")
     fast_doc_detect: SkipValidation[Optional[bool]] = Field(alias="fastDocDetect", default=None, description="When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds. Enabled by default.")
@@ -69,7 +69,7 @@ class ProcessParams(BaseModel):
     image_qa: SkipValidation[Optional[ImageQA]] = Field(alias="imageQa", default=None)
     strict_image_quality: SkipValidation[Optional[bool]] = Field(alias="strictImageQuality", default=None, description="When enabled, the image quality check status affects the document optical and overall status. Disabled by default.")
     respect_image_quality: SkipValidation[Optional[bool]] = Field(alias="respectImageQuality", default=None, description="Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.")
-    force_doc_format: SkipValidation[Optional[DocumentFormat]] = Field(alias="forceDocFormat", default=None)
+    force_doc_format: SkipValidation[Optional[DocumentFormat]] = Field(alias="forceDocFormat", default=None, description="Force use of specified document format when locating and recognizing document to reduce the number of candidates.")
     no_graphics: SkipValidation[Optional[bool]] = Field(alias="noGraphics", default=None, description="When enabled, no graphic fields will be cropped from document image. Disabled by default.")
     depersonalize_log: SkipValidation[Optional[bool]] = Field(alias="depersonalizeLog", default=None, description="When enabled, all personal data will be forcibly removed from the logs. Disabled by default.")
     multi_doc_on_image: SkipValidation[Optional[bool]] = Field(alias="multiDocOnImage", default=None, description="This option allows locating and cropping multiple documents from one image if enabled. Disabled by default.")
@@ -78,7 +78,7 @@ class ProcessParams(BaseModel):
     return_uncropped_image: SkipValidation[Optional[bool]] = Field(alias="returnUncroppedImage", default=None, description="When enabled, returns input images in output. Disabled by default.")
     mrz_formats_filter: SkipValidation[Optional[List[MRZFormat]]] = Field(alias="mrzFormatsFilter", default=None, description="This option allows limiting MRZ formats to be recognized by specifying them in array.")
     parse_barcodes: SkipValidation[Optional[bool]] = Field(alias="parseBarcodes", default=None, description="This option can be disabled to stop parsing after barcode is read. Enabled by default.")
-    convert_case: SkipValidation[Optional[TextPostProcessing]] = Field(alias="convertCase", default=None)
+    convert_case: SkipValidation[Optional[TextPostProcessing]] = Field(alias="convertCase", default=None, description="This option allows output text case transformation. No changes applied by default to original values.")
     split_names: SkipValidation[Optional[bool]] = Field(alias="splitNames", default=None, description="When enabled, the Surname and GivenNames fields from MRZ will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default.")
     disable_perforation_ocr: SkipValidation[Optional[bool]] = Field(alias="disablePerforationOCR", default=None, description="When enabled, OCR of perforated fields in the document template will not be performed. Enabled by default.")
     document_group_filter: SkipValidation[Optional[List[DocumentType]]] = Field(alias="documentGroupFilter", default=None, description="List of specific eligible document types from DocumentType enum to recognize from. You may, for example, specify only passports to be recognized by setting this property. Empty by default.")

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/status.py

@@ -23,11 +23,11 @@ class Status(BaseModel):
     """
     Status
     """ # noqa: E501
-    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus")
-    optical: SkipValidation[CheckResult] = Field(alias="optical")
-    portrait: SkipValidation[CheckResult] = Field(alias="portrait")
-    rfid: SkipValidation[CheckResult] = Field(alias="rfid")
-    stop_list: SkipValidation[CheckResult] = Field(alias="stopList")
+    overall_status: SkipValidation[CheckResult] = Field(alias="overallStatus", description="Overall checks status. Rootx status")
+    optical: SkipValidation[CheckResult] = Field(alias="optical", description="Overall optical checks combined status")
+    portrait: SkipValidation[CheckResult] = Field(alias="portrait", description="Portrait comparison status")
+    rfid: SkipValidation[CheckResult] = Field(alias="rfid", description="Overall RFID checks combined status")
+    stop_list: SkipValidation[CheckResult] = Field(alias="stopList", description="Stop list check status")
     details_rfid: SkipValidation[Optional[DetailsRFID]] = Field(alias="detailsRFID", default=None)
     details_optical: SkipValidation[DetailsOptical] = Field(alias="detailsOptical")
     age: SkipValidation[CheckResult] = Field(alias="age")

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/symbol_recognition_result.py

@@ -21,7 +21,7 @@ class SymbolRecognitionResult(BaseModel):
     """
     Describes a single character recognition results in the text field line
     """ # noqa: E501
-    symbol_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="SymbolRect", default=None)
+    symbol_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="SymbolRect", default=None, description="Coordinates of the symbol in the normalized image of the document")
     candidates_count: SkipValidation[float] = Field(alias="CandidatesCount", description="Number of significant elements of ListOfCandidates array")
     list_of_candidates: SkipValidation[List[SymbolCandidate]] = Field(alias="ListOfCandidates", description="Array of candidate characters. Sorted in descending order of recognition probabilities (the first element has highest probability)")
     base_line_bottom: SkipValidation[Optional[int]] = Field(alias="BaseLineBottom", default=None)

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/text.py

@@ -22,9 +22,9 @@ class Text(BaseModel):
     """
     Contains all document text fields data with validity and cross-source compare checks
     """ # noqa: E501
-    status: SkipValidation[CheckResult] = Field(alias="status")
-    validity_status: SkipValidation[CheckResult] = Field(alias="validityStatus")
-    comparison_status: SkipValidation[CheckResult] = Field(alias="comparisonStatus")
+    status: SkipValidation[CheckResult] = Field(alias="status", description="Overall status of all checks from all text fields")
+    validity_status: SkipValidation[CheckResult] = Field(alias="validityStatus", description="Overall status of validity from all text fields from all sources")
+    comparison_status: SkipValidation[CheckResult] = Field(alias="comparisonStatus", description="Overall status of data comparison from different sources for each text field")
     date_format: SkipValidation[str] = Field(alias="dateFormat", description="Date format")
     field_list: SkipValidation[List[TextField]] = Field(alias="fieldList")
     available_source_list: SkipValidation[List[TextAvailableSource]] = Field(alias="availableSourceList")

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/text_available_source.py

@@ -22,7 +22,7 @@ class TextAvailableSource(BaseModel):
     TextAvailableSource
     """ # noqa: E501
     source: SkipValidation[Source] = Field(alias="source")
-    validity_status: SkipValidation[CheckResult] = Field(alias="validityStatus")
+    validity_status: SkipValidation[CheckResult] = Field(alias="validityStatus", description="Overall status of validity from all fields for given source")
     container_type: SkipValidation[Optional[int]] = Field(alias="containerType", default=None, description="Same as Result type, but used for safe parsing of not-described values. See Result type.")
     __properties: ClassVar[List[str]] = ["source", "validityStatus", "containerType"]
 

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/text_field.py

@@ -29,9 +29,9 @@ class TextField(BaseModel):
     field_name: SkipValidation[str] = Field(alias="fieldName", description="Field name. Only use to search values for fields with fieldType=50(other). In general, use fieldType for lookup.")
     lcid: SkipValidation[LCID] = Field(alias="lcid")
     lcid_name: SkipValidation[Optional[str]] = Field(alias="lcidName", default=None, description="LCID name")
-    status: SkipValidation[CheckResult] = Field(alias="status")
-    validity_status: SkipValidation[CheckResult] = Field(alias="validityStatus")
-    comparison_status: SkipValidation[CheckResult] = Field(alias="comparisonStatus")
+    status: SkipValidation[CheckResult] = Field(alias="status", description="Overall status of all checks from all values")
+    validity_status: SkipValidation[CheckResult] = Field(alias="validityStatus", description="Overall status of validity from all values")
+    comparison_status: SkipValidation[CheckResult] = Field(alias="comparisonStatus", description="Overall status of data comparison from different sources")
     value: SkipValidation[str] = Field(alias="value", description="The most confidence value, selected from valueList")
     value_list: SkipValidation[List[TextFieldValue]] = Field(alias="valueList")
     validity_list: SkipValidation[List[SourceValidity]] = Field(alias="validityList", description="Validity of all field values for given source. If there are two values on different pages for one field-source pair, then validity also will include logical match checking. If such values do not match, validity will return error.")

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula/documentreader/webclient/gen/models/text_field_value.py

@@ -32,8 +32,8 @@ class TextFieldValue(BaseModel):
     original_symbols: SkipValidation[Optional[List[OriginalSymbol]]] = Field(alias="originalSymbols", default=None)
     page_index: SkipValidation[int] = Field(alias="pageIndex", description="Page index of the image from input list")
     probability: SkipValidation[int] = Field(alias="probability", description="Min recognition probability. Combined minimum probability from single characters probabilities")
-    field_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="fieldRect", default=None)
-    rfid_origin: SkipValidation[Optional[RfidOrigin]] = Field(alias="rfidOrigin", default=None)
+    field_rect: SkipValidation[Optional[RectangleCoordinates]] = Field(alias="fieldRect", default=None, description="Only for visual and mrz results. Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)")
+    rfid_origin: SkipValidation[Optional[RfidOrigin]] = Field(alias="rfidOrigin", default=None, description="Only for RFID images. Text location in RFID chip.")
     container_type: SkipValidation[Optional[int]] = Field(alias="containerType", default=None, description="Same as Result type, but used for safe parsing of not-described values. See Result type.")
     __properties: ClassVar[List[str]] = ["source", "value", "originalValue", "originalValidity", "originalSymbols", "pageIndex", "probability", "fieldRect", "rfidOrigin", "containerType"]
 

{regula_documentreader_webclient-9.9.1072rc0 → regula_documentreader_webclient-9.9.1073.dev0}/regula_documentreader_webclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 9.9.1072rc0
+Version: 9.9.1073.dev0
 Summary: Regula's Document Reader python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.