This release is a pre-release and may not be stable for production use.
Regula Document Reader web API Python 3.9+ client
⚠️ 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. You are invited to contribute new features, fixes, or updates, 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
Install package
regula_documentreader_webclient is on the Python Package Index (PyPI):
pip install regula_documentreader_webclient
Or using pipenv
pipenv install regula_documentreader_webclient
Example
Performing request:
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:
# 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 folder.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file regula_documentreader_webclient-9.8.997.dev0.tar.gz.
File metadata
- Download URL: regula_documentreader_webclient-9.8.997.dev0.tar.gz
- Upload date:
- Size: 146.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cff4cd6e5ecc9f3e8c862ecd7ba95ab428b6637e4e5dcac00c152696611bd93b
|
|
| MD5 |
2e84d857694fdfe94167d36656786d98
|
|
| BLAKE2b-256 |
0021648ac9fbf9158cad69ec67724b17033d587bd0fdbeb08dc6b63a994fcd99
|
File details
Details for the file regula_documentreader_webclient-9.8.997.dev0-py3-none-any.whl.
File metadata
- Download URL: regula_documentreader_webclient-9.8.997.dev0-py3-none-any.whl
- Upload date:
- Size: 423.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6bcb401dc78406fb540015ea40317557283a7bfc1a9478d058efd24fbd9d7475
|
|
| MD5 |
7186ecdf8762e47a8a62f32c481dcbd8
|
|
| BLAKE2b-256 |
66f5db1326b574483aa3732010bf1220a8bc61bd007535cd324b5c4260d6f154
|
