Cropper OCR Node.js
The Node.js OCR SDK supports the Cropper API.
Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
Quick-Start
const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";
// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
// Load a file from disk
const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.CropperV1,
inputSource
);
// Handle the response Promise
apiResponse.then((resp) => {
// print a string summary
console.log(resp.document.toString());
});
Output (RST):
########
Document
########
:Mindee ID: 149ce775-8302-4798-8649-7eda9fb84a1a
:Filename: default_sample.jpg
Inference
#########
:Product: mindee/cropper v1.0
:Rotation applied: No
Prediction
==========
Page Predictions
================
Page 0
------
:Document Cropper: Polygon with 26 points.
Polygon with 25 points.
Field Types
Standard Fields
These fields are generic and used in several products.
Basic Field
Each prediction object contains a set of fields that inherit from the generic Field
class.
A typical Field
object will have the following attributes:
- value (
number | string
): corresponds to the field value. Can beundefined
if no value was extracted. - confidence (
number
): the confidence score of the field prediction. - boundingBox (
[Point, Point, Point, Point]
): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document. - polygon (
Point[]
): contains the relative vertices coordinates (Point
) of a polygon containing the field in the image. - pageId (
number
): the ID of the page, alwaysundefined
when at document-level. - reconstructed (
boolean
): indicates whether an object was reconstructed (not extracted as the API gave it).
Note: A
Point
simply refers to an array of two numbers ([number, number]
).
Aside from the previous attributes, all basic fields have access to a toString()
method that can be used to print their value as a string.
Position Field
The position field PositionField
does not implement all the basic Field
attributes, only boundingBox, polygon and pageId. On top of these, it has access to:
- rectangle (
[Point, Point, Point, Point]
): a Polygon with four points that may be oriented (even beyond canvas). - quadrangle (
[Point, Point, Point, Point]
): a free polygon made up of four points.
Page-Level Fields
Some fields are constrained to the page level, and so will not be retrievable at document level.
Attributes
The following fields are extracted for Cropper V1:
Document Cropper
📄cropping (PositionField[]): List of documents found in the image.
for (const page of result.document.inference.pages) {
for (const croppingElem of page.prediction.cropping) {
console.log(croppingElem.polygon);
console.log(croppingElem.quadrangle);
console.log(croppingElem.rectangle);
console.log(croppingElem.boundingBox);
}
}
Questions?
Updated 2 months ago