Learn how to use Verifiers
How to use verifiers to filter out false positive results
Verifiers are one of the rule-based validation approaches, which filter out the false-positives. These let the user narrow down extraction results by applying some additional logic and checks to the extraction results.The verifiers will be processed after the transformers.
|
Verifier
|
Description
|
|
coords: Position Range
|
Rejects candidates which are not with the rectangle made of `left`, `right`, `top`, `bottom` coordinates, e.g. at the top half page.
|
|
coords: Position Range Center
|
Rejects candidates whose centers are not with the rectangle made of `left`, `right`, `top`, `bottom` coordinates, e.g. at the top half page.
|
|
image: aspect ratio
|
Restricts the results to a range of aspect ratio.
|
|
key-value: Pair Orientation
|
Defintion of keywords, which should be found in the near (horizontaly or verticaly) of the candidate.
|
|
number: Page Number
|
Checks whether a candidate is on the specified page. Candidates found on other pages are ignored.
|
|
number: Value Range
|
Can only be used if the `output_data_type` is numeric (integer or float). Candidates with a value that is smaller than `minimum value` or larger than `maximum_value` are rejected.
|
|
page: Has Not Pattern
|
Page containing the specified `pattern` are rejected.
|
|
page: Has Pattern
|
Pages containing the specified 'pattern' are allowed.
|
|
pick_nth
|
This verifier picks the n-th element of the sorted candidate list.
|
|
string: Ends With
|
Candidates that do not end with the specific string are rejected.
|
|
string: Has Not Pattern
|
Candidates containing the specified `pattern` are rejected.
|
|
string: Has Pattern
|
Candidates that do not contain the specified `pattern` are rejected.
|
|
string: Starts Not With
|
Skips candidates whose prediction value start with a specific string.
|
|
string: Starts With
|
Candidates that do not start with the specific string are rejected.
|
|
string: String Length
|
Rejects candidates that do not have the right number of "characters".
|
Verifier "coords: Position Range"
Definition of coordinates, where the candidate have to be found. The verifier can restrict the result horizontally (left coordinate [0..1] (float) - right coordinate [0..1] (float)) and vertically (top coordinate [0..1] (float) - bottom coordinate [0..1] (float)). All values are defined in percent between 0 and 1, using a point as decimal.

|
Parameter
|
Description
|
|
Left coordinate
|
Left coordinate of the rectangle (related to page width)
0 <= value <= 1
|
|
Right coordinate
|
Right coordinate of the rectangle
(related to page width)
0 <= value <= 1
|
|
Top coordinate
|
Top coordinate of the rectangle
(related to page height)
0 <= value <= 1
|
|
Bottom coordinate
|
Bottom coordinate of the rectangle
(related to page height)
0 <= value <= 1
|
Verifier "coords: Position Range Center"
Definition of coordinates, where the center of the candidate have to be found. The verifier can restrict the result horizontally (left coordinate [0..1] (float) - right coordinate [0..1] (float)) and vertically (top coordinate [0..1] (float) - bottom coordinate [0..1] (float)). All values are defined in percent between 0 and 1, using a point as decimal.

|
Parameter
|
Description
|
|
Left coordinate
|
Left coordinate of the rectangle (related to page width)
0 <= value <= 1
|
|
Right coordinate
|
Right coordinate of the rectangle
(related to page width)
0 <= value <= 1
|
|
Top coordinate
|
Top coordinate of the rectangle
(related to page height)
0 <= value <= 1
|
|
Bottom coordinate
|
Bottom coordinate of the rectangle
(related to page height)
0 <= value <= 1
|
Verifier "key-value: Pair Orientation"
Definition of keywords, which should be found in the near (horizontaly or verticaly) of the candidate.
Verifier "image: Aspect ratio"
Check the aspect ratio of the result tokens (length / height).


Verifier "number: Page Number"
Checks whether a candidate is on the specified page. Candidates found on other pages are ignored.
Verifier "number: Value Range"
Can only be used if the output_data_type is numeric (integer or float). Candidates with a value that is smaller than minimum value or larger than maximum_value are rejected.
Verifier "pick_nth"
This verifier picks the n-th element of the sorted candidate list, in this example the second element (zero-based index).
Verifier "string: Ends With"
Candidates that do not end with the specific string are rejected.
Verifier "string: Has Not Pattern"
Candidates containing the specified pattern are rejected.
Verifier "string: Has Pattern"
Candidates that do not contain the specified pattern are rejected.

Verifier "string: Starts Not With"
Skips candidates whose prediction value start with a specific string.
Verifier "String: Starts With"
Skips candidates whose prediction value not start with a specific string.
Verifier "string: String Length"
Rejects candidates that do not have the right number of "characters".