Skip to content

Limitations

Timeouts

Use the parameter to set the time limit (in seconds) for the document recognition, beyond which the recognition does not continue regardless of its result.

You can define the moment for the countdown to start.

  • Start the countdown from the moment the scenario starts:
DocumentReader.setConfig({
    processParams: {
        timeout: 20.0
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });
  • Start the countdown from the moment the document is detected:
DocumentReader.setConfig({
    processParams: {
        timeoutFromFirstDetect: 5.0
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });
  • Start the countdown from the moment the document type is recognized:
DocumentReader.setConfig({
    processParams: {
        timeoutFromFirstDocType: 3.0
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });

Barcode recognition

Set the types of barcodes to process:

DocumentReader.setConfig({
    processParams: {
        barcodeTypes: [BarcodeType.PDF417, BarcodeType.QRCODE]
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });

Document recognition

DocumentReader.setConfig({
    processParams: {
        documentIDList: [-274257313, -2004898043]
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });
  • Set the minimum acceptable DPI value:
DocumentReader.setConfig({
    processParams: {
        minDPI: 100
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });
  • Use a specific template ID and skip the document type identification step:
DocumentReader.setConfig({
    processParams: {
        forceDocID: 123
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });
  • Ignore assumptions based on the field mask in the template:
DocumentReader.setConfig({
    processParams: {
        matchTextFieldMask: true
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });
  • Guarantee that an output image contains the correct MRZ on it in the series process mode:
DocumentReader.setConfig({
    processParams: {
        forceReadMrzBeforeLocate: true
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });
  • Limit MRZ formats to be recognized by specifying them in array:
DocumentReader.setConfig({
    processParams: {
        mrzFormatsFilter: [MRZFormat.ID2, MRZFormat.ID1]
    },
}, (str) => { console.log(str) }, (error) => { console.log(error) });

Next Steps