Fingerprint mode

Fingerprints test for matching text in a document to determine:

  1. the document's subtype for standalone files
  2. the document's page range in multi-document, or "portfolio", files.

The Fingerprint Mode configuration option applies to scenario 1, not scenario 2. You can configure this option in the Sensible app in the document type settings tab.

Standalone files

Fingerprints improve performance by testing for matching text in a single-document document before running or skipping a config in a specified document type.

The Fingerprint Mode configuration option determines the strictness of the tests as follows:

Strictness levelDescriptionIf more than one config's tests pass over 50%If no configs' tests pass over 50%
or if no configs contain a fingerprint
standardIf any of the configs in the document type contain a fingerprint, then Sensible runs extractions using any configs that pass over 50% of the fingerprint tests.Sensible chooses the output from the passing config with the highest scoreSensible falls back to the default behavior of running extractions for the document using all configurations, and returns the one with the highest score.
strictThe doc type must have at least one config containing a fingerprint.Sensible chooses the output from the passing config that has the highest score.Sensible returns a 400 error.

In the preceding table, Sensible calculates a score as follows:

score = num of non-null fields - penalties for validation errors or warnings, where penalties are as follows:

  • validation error penalty = 1 * num fields with validation errors
  • validation warning penalty = 0.5 * num of fields with validation warnings

Portfolio files

Sensible ignores the document type's Fingerprint Mode setting for portfolio files.