Invoice Splitter OCR Node.js
The Node.js OCR SDK supports the Invoice Splitter 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.enqueueAndParse(
mindee.product.InvoiceSplitterV1,
inputSource
);
// Handle the response Promise
apiResponse.then((resp) => {
// print a string summary
console.log(resp.document.toString());
});
Output (RST):
########
Document
########
:Mindee ID: 15ad7a19-7b75-43d0-b0c6-9a641a12b49b
:Filename: default_sample.pdf
Inference
#########
:Product: mindee/invoice_splitter v1.2
:Rotation applied: No
Prediction
==========
:Invoice Page Groups:
+--------------------------------------------------------------------------+
| Page Indexes |
+==========================================================================+
| 0 |
+--------------------------------------------------------------------------+
| 1 |
+--------------------------------------------------------------------------+
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.
Specific Fields
Fields which are specific to this product; they are not used in any other product.
Invoice Page Groups Field
List of page groups. Each group represents a single invoice within a multi-invoice document.
A InvoiceSplitterV1InvoicePageGroup
implements the following attributes:
pageIndexes
(Array): List of page indexes that belong to the same invoice (group).
Attributes
The following fields are extracted for Invoice Splitter V1:
Invoice Page Groups
invoicePageGroups (InvoiceSplitterV1InvoicePageGroup[]): List of page groups. Each group represents a single invoice within a multi-invoice document.
for (const invoicePageGroupsElem of result.document.inference.prediction.invoicePageGroups) {
console.log(invoicePageGroupsElem.value);
}
Questions?
Updated 19 days ago