Document database

Document templates are files containing information about a specific document type, and needed to detect and read it. Our documents reference file database can evolve on demand, independently from SDK versions.

Important

Document templates can be downloaded from the following address:
https://cloud.id3.eu/index.php/s/isRrzniF7WZ97bb

Document template files

Document template files have the .id3dr extension. For modularity reasons, template files are separated by module and models. It increases the number of files, but you can load only those you need. You must copy those files into your application package, and specify their location in your application’s source code. If you wish to reduce the size of your application, we recommend copying only the necessary files.

Reference files are named the following way : <package_name>_<model>_X.X.X.V.id3dr, with :

  • The <package_name> is a unique string used to identify this document, or the group of documents in the SDK.

  • <model> : SDK AI Model which needs this document template.

  • X.X.X is the corresponding SDK version used to generate them

  • V is an independent document template file version. Please always use the latest for each template.

Warning

Document references does not exist for each version, please use the latest ones inferior or equal to your SDK version. Other versions will not be supported.
Example : your SDK version is 2.0.3, and the latest document templates inferior might by 2.0.1.

Note

In each package, one can usually find both front and back pages of a document.
In this case the package contains 2 document names completed by the suffix _front and _back. The 2 sides are treated like 2 different documents in the SDK, and you should use the full name to identify them in the SDK (for example: in DocumentDetector.detectDocumentByName Method)

Example

../_images/document_template_package.png

Loading/unloading the document database

It is recommended to load the document templates on application startup. The DocumentLibrary Class provides methods for loading and unloading document templates in memory.

  • When loading the template, one must give the full path of the .id3dr file, with the extension.

  • When unloading, one can give either the package name (unloading every documents inside this package), or unload separately the documents templates with their full name.

# Load the package corresponding to French ID Card
DocumentLibrary.load_document_template("FRA_BO_03001_detector_2A_2.2.0.0.id3dr")

# Print loaded documents : `FRA_BO_03001_front` and `FRA_BO_03001_back`
for document_name in DocumentLibrary.get_loaded_document_template():
    print(document_name)

# Unload either package or individual
DocumentLibrary.unload_document_template("FRA_BO_03001")
# ----- OR ----
DocumentLibrary.unload_document_template("FRA_BO_03001_back")
DocumentLibrary.unload_document_template("FRA_BO_03001_front")

See also