mindee 1.0.9 → 1.2.0

package/mindee/api/object.js

@@ -10,7 +10,7 @@ const request = require("./request");
 class APIObject {
   constructor(apiToken = undefined, apiName = "") {
     this.apiToken = apiToken;
-    this.baseUrl = "https://api.mindee.net/products";
+    this.baseUrl = "https://api.mindee.net/v1/products/mindee";
     this.apiName = apiName;
   }
 
@@ -54,7 +54,7 @@ class APIObject {
     @returns {Response}
   */
   wrapResponse(inputFile, response, documentType) {
-    if (response.statusCode != 200) {
+    if (response.statusCode > 201) {
       const errorMessage = JSON.stringify(response.data, null, 4);
       errorHandler.throw(
         new Error(

package/mindee/api/request.js

@@ -2,20 +2,23 @@ const https = require("https");
 const { version: sdkVersion } = require("../../package.json");
 const { URL } = require("url");
 const FormData = require("form-data");
+const os = require("os");
 
 const request = (url, method, headers, input, includeWords = false) => {
   return new Promise(function (resolve, reject) {
-    const form = new FormData();
+    let form = new FormData();
     let body;
-    headers["User-Agent"] = `mindee-node/${sdkVersion} node/${process.version}`;
 
+    headers["User-Agent"] = `mindee-api-nodejs@v${sdkVersion} nodejs-${
+      process.version
+    } ${os.type().toLowerCase()}`;
     if (["path", "stream"].includes(input.inputType)) {
       const fileParams = { filename: input.filename };
-      form.append("file", input.fileObject, fileParams);
+      form.append("document", input.fileObject, fileParams);
       if (includeWords) form.append("include_mvision", "true");
       headers = { ...headers, ...form.getHeaders() };
     } else if (input.inputType === "base64") {
-      let body_obj = { file: input.fileObject };
+      let body_obj = { document: input.fileObject };
       if (includeWords) body_obj["include_mvision"] = "true";
       body = JSON.stringify(body_obj);
       headers["Content-Type"] = "application/json";
@@ -44,7 +47,7 @@ const request = (url, method, headers, input, includeWords = false) => {
             data: JSON.parse(responseBody),
           });
         } catch (error) {
-          console.log(responseBody);
+          console.log(responseBody, error);
         }
       });
     });

package/mindee/api/response.js

@@ -1,4 +1,3 @@
-const Document = require("../documents").document;
 const Receipt = require("../documents").receipt;
 const Invoice = require("../documents").invoice;
 const FinancialDocument = require("../documents").financialDocument;
@@ -33,29 +32,48 @@ class Response {
   }
 
   formatResponse() {
+    let http_data_document = this.httpResponse.data.document;
     const constructors = {
       receipt: (params) => new Receipt(params),
       invoice: (params) => new Invoice(params),
       financialDocument: (params) => new FinancialDocument(params),
     };
-    const predictions = this.httpResponse.data.predictions.entries();
+
+    const predictions = http_data_document.inference.pages.entries();
     this[`${this.documentType}s`] = [];
+    let document_words_content = [];
 
     // Create a list of Document (Receipt, Invoice...) for each page of the input document
     for (const [pageNumber, prediction] of predictions) {
+      let page_words_content = [];
+      if (
+        "ocr" in http_data_document &&
+        Object.keys(http_data_document.ocr).length > 0
+      ) {
+        page_words_content =
+          http_data_document.ocr["mvision-v1"].pages[pageNumber].all_words;
+        document_words_content.push(
+          ...http_data_document.ocr["mvision-v1"].pages[pageNumber].all_words
+        );
+      }
       this[`${this.documentType}s`].push(
         constructors[this.documentType]({
-          apiPrediction: prediction,
+          apiPrediction: prediction.prediction,
           inputFile: this.input,
           pageNumber: pageNumber,
+          words: page_words_content,
         })
       );
     }
 
     // Merge the list of Document into a unique Document
-    this[this.documentType] = Document.mergePages(
-      this[`${this.documentType}s`]
-    );
+    this[this.documentType] = constructors[this.documentType]({
+      apiPrediction: http_data_document.inference.prediction,
+      inputFile: this.input,
+      pageNumber: http_data_document.n_pages,
+      level: "document",
+      words: document_words_content,
+    });
   }
 }
 

package/mindee/documents/fields/field.js

@@ -16,13 +16,10 @@ class Field {
     this.pageNumber = pageNumber;
     this.reconstructed = reconstructed;
     this.value = undefined;
-    this.probability = 0.0;
-    this.bbox = [];
-    if (valueKey in prediction && prediction[valueKey] !== "N/A") {
+    this.probability = prediction.confidence ? prediction.confidence : 0.0;
+    this.bbox = prediction.polygon ? prediction.polygon : [];
+    if (valueKey in prediction && prediction[valueKey] !== null) {
       this.value = prediction[valueKey];
-      if (prediction.probability) this.probability = prediction.probability;
-      if (prediction.segmentation)
-        this.bbox = prediction.segmentation.bounding_box || [];
       if (extraFields) {
         for (const fieldName of extraFields) {
           this[fieldName] = prediction[fieldName];

package/mindee/documents/financialDocument.js

@@ -19,14 +19,19 @@ class FinancialDocument extends Document {
    *  @param {Object} Date - date value for creating FinancialDocument object from scratch
    *  @param {Object} InvoiceNumber - Invoice number value for creating FinancialDocument object from scratch
    *  @param {Object} taxes - taxes value for creating FinancialDocument object from scratch
-   *  @param {Object} merchantName - merchant name value for creating FinancialDocument object from scratch
+   *  @param {Object} supplier - supplier value for creating FinancialDocument object from scratch
+   *  @param {Object} supplierAddress - supplier address value for creating FinancialDocument object from scratch
    *  @param {Object} paymentDetails - payment details value for creating FinancialDocument object from scratch
    *  @param {Object} companyNumber - company number value for creating FinancialDocument object from scratch
    *  @param {Object} vatNumber - vat number value for creating FinancialDocument object from scratch
    *  @param {Object} orientation - orientation value for creating FinancialDocument object from scratch
    *  @param {Object} totalTax - total tax value for creating FinancialDocument object from scratch
    *  @param {Object} time - time value for creating FinancialDocument object from scratch
+   *  @param {Object} customerName - customer name value for creating FinancialDocument object from scratch
+   *  @param {Object} customerAddress - customer address value for creating FinancialDocument object from scratch
+   *  @param {Object} customerCompanyRegistration - customer company registration value for creating FinancialDocument object from scratch
    *  @param {Object} pageNumber - pageNumber for multi pages pdf input
+   *  @param {String} level - specify whether object is built from "page" level or "document" level prediction
    */
   constructor({
     apiPrediction = undefined,
@@ -38,16 +43,23 @@ class FinancialDocument extends Document {
     invoiceNumber = undefined,
     dueDate = undefined,
     taxes = undefined,
-    merchantName = undefined,
+    supplier = undefined,
+    supplierAddress = undefined,
     paymentDetails = undefined,
     companyNumber = undefined,
     vatNumber = undefined,
     orientation = undefined,
     totalTax = undefined,
     time = undefined,
+    customerName = undefined,
+    customerAddress = undefined,
+    customerCompanyRegistration = undefined,
+    words = undefined,
     pageNumber = 0,
+    level = "page",
   }) {
     super(inputFile);
+    this.level = level;
     if (apiPrediction === undefined) {
       this.#initFromScratch({
         locale,
@@ -57,7 +69,8 @@ class FinancialDocument extends Document {
         invoiceNumber,
         dueDate,
         taxes,
-        merchantName,
+        supplier,
+        supplierAddress,
         paymentDetails,
         companyNumber,
         vatNumber,
@@ -65,9 +78,12 @@ class FinancialDocument extends Document {
         pageNumber,
         totalTax,
         time,
+        customerName,
+        customerAddress,
+        customerCompanyRegistration,
       });
     } else {
-      this.#initFromApiPrediction(apiPrediction, inputFile, pageNumber);
+      this.#initFromApiPrediction(apiPrediction, inputFile, pageNumber, words);
     }
     this.#checklist();
   }
@@ -86,8 +102,12 @@ class FinancialDocument extends Document {
     vatNumber,
     orientation,
     pageNumber,
-    merchantName,
+    supplier,
+    supplierAddress,
     time,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration,
   }) {
     const constructPrediction = function (item) {
       return { prediction: { value: item }, valueKey: "value", pageNumber };
@@ -98,13 +118,19 @@ class FinancialDocument extends Document {
     this.totalTax = new Amount(constructPrediction(totalTax));
     this.date = new Date(constructPrediction(date));
     this.dueDate = new Date(constructPrediction(dueDate));
-    this.merchantName = new Field(constructPrediction(merchantName));
+    this.supplier = new Field(constructPrediction(supplier));
+    this.supplierAddress = new Field(this.constructPrediction(supplierAddress));
     this.time = new Field(constructPrediction(time));
     this.orientation = new Orientation(constructPrediction(orientation));
     this.invoiceNumber = new Field(constructPrediction(invoiceNumber));
     this.paymentDetails = new Field(constructPrediction(paymentDetails));
     this.companyNumber = new Field(constructPrediction(companyNumber));
     this.vatNumber = new Field(constructPrediction(vatNumber));
+    this.customerName = new Field(this.constructPrediction(customerName));
+    this.customerAddress = new Field(this.constructPrediction(customerAddress));
+    this.customerCompanyRegistration = new Field(
+      this.constructPrediction(customerCompanyRegistration)
+    );
     if (taxes !== undefined) {
       this.taxes = [];
       for (const t of taxes) {
@@ -120,34 +146,73 @@ class FinancialDocument extends Document {
     }
   }
 
-  #initFromApiPrediction(apiPrediction, inputFile, pageNumber) {
+  #initFromApiPrediction(apiPrediction, inputFile, pageNumber, words) {
     if (Object.keys(apiPrediction).includes("invoice_number")) {
-      const invoice = new Invoice({ apiPrediction, inputFile, pageNumber });
-      Object.assign(this, invoice);
-      this.time = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+      const invoice = new Invoice({
+        apiPrediction,
+        inputFile,
+        pageNumber,
+        level: this.level,
+        words: words,
       });
-      this.merchantName = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+      this.locale = invoice.locale;
+      this.totalIncl = invoice.totalIncl;
+      this.totalExcl = invoice.totalExcl;
+      this.date = invoice.invoiceDate;
+      this.invoiceNumber = invoice.invoiceNumber;
+      this.dueDate = invoice.dueDate;
+      this.taxes = invoice.taxes;
+      this.supplier = invoice.supplier;
+      this.supplierAddress = invoice.supplierAddress;
+      this.paymentDetails = invoice.paymentDetails;
+      this.companyNumber = invoice.companyNumber;
+      this.orientation = invoice.orientation;
+      this.totalTax = invoice.totalTax;
+      if (invoice.words) this.words = invoice.words;
+      this.time = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
       });
+      this.customerName = invoice.customerName;
+      this.customerAddress = invoice.customerAddress;
+      this.customerCompanyRegistration = invoice.customerCompanyRegistration;
     } else {
-      const receipt = new Receipt({ apiPrediction, inputFile, pageNumber });
-      Object.assign(this, receipt);
-      this.invoiceDate = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+      const receipt = new Receipt({
+        apiPrediction,
+        inputFile,
+        pageNumber,
+        level: this.level,
+        words: words,
       });
-      this.invoiceNumber = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+      this.orientation = receipt.orientation;
+      this.date = receipt.date;
+      this.dueDate = receipt.date;
+      this.taxes = receipt.taxes;
+      this.locale = receipt.locale;
+      this.totalIncl = receipt.totalIncl;
+      this.totalExcl = receipt.totalExcl;
+      this.supplier = receipt.merchantName;
+      this.supplierAddress = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
       });
-      this.dueDate = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+      this.time = receipt.time;
+      this.totalTax = receipt.totalTax;
+      this.invoiceNumber = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
       });
       this.paymentDetails = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        prediction: { value: undefined, confidence: 0.0 },
       });
       this.companyNumber = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        prediction: { value: undefined, confidence: 0.0 },
+      });
+      this.customerName = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
+      });
+      this.customerAddress = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
       });
+      this.customerCompanyRegistration = [];
+      if (receipt.words) this.words = receipt.words;
     }
   }
 
@@ -157,7 +222,7 @@ class FinancialDocument extends Document {
     Filename: ${this.filename}
     Total amount: ${this.totalIncl.value}
     Date: ${this.date.value}
-    Merchant name: ${this.merchantName.value}
+    Supplier: ${this.supplier.value}
     Total taxes: ${this.totalTax.value}
     `;
   }
@@ -192,7 +257,7 @@ class FinancialDocument extends Document {
       this.totalIncl.value * (1 - eps) - 0.02 <= reconstructedTotal &&
       reconstructedTotal <= this.totalIncl.value * (1 + eps) + 0.02
     ) {
-      this.taxes = this.taxes.map((tax) => ({ ...tax, probability: 1.0 }));
+      this.taxes = this.taxes.map((tax) => ({ ...tax, confidence: 1.0 }));
       this.totalTax.probability = 1.0;
       this.totalIncl.probability = 1.0;
       return true;

package/mindee/documents/invoice.js

@@ -11,7 +11,6 @@ class Invoice extends Document {
   /**
    *  @param {Object} apiPrediction - Json parsed prediction from HTTP response
    *  @param {Input} input - Input object
-   *  @param {Integer} pageNumber - Page number for multi pages pdf input
    *  @param {Object} locale - locale value for creating Invoice object from scratch
    *  @param {Object} totalIncl - total tax included value for creating Invoice object from scratch
    *  @param {Object} totalExcl - total tax excluded value for creating Invoice object from scratch
@@ -19,12 +18,17 @@ class Invoice extends Document {
    *  @param {Object} invoiceNumber - invoice number value for creating Invoice object from scratch
    *  @param {Object} taxes - taxes value for creating Invoice object from scratch
    *  @param {Object} supplier - supplier value for creating Invoice object from scratch
+   *  @param {Object} supplierAddress - supplier address value for creating Invoice object from scratch
    *  @param {Object} paymentDetails - payment details value for creating Invoice object from scratch
    *  @param {Object} companyNumber - company number value for creating Invoice object from scratch
    *  @param {Object} vatNumber - vat number value for creating Invoice object from scratch
    *  @param {Object} orientation - orientation value for creating Invoice object from scratch
    *  @param {Object} totalTax - total tax value for creating Invoice object from scratch
-   *  @param {Object} pageNumber - pageNumber for multi pages pdf input
+   *  @param {Object} customerName - customer name value for creating Invoice object from scratch
+   *  @param {Object} customerAddress - customer address value for creating Invoice object from scratch
+   *  @param {Object} customerCompanyRegistration - customer company registration value for creating Invoice object from scratch
+   *  @param {Number} pageNumber - pageNumber for multi pages pdf input
+   *  @param {String} level - specify whether object is built from "page" level or "document" level prediction
    */
   constructor({
     apiPrediction = undefined,
@@ -37,14 +41,24 @@ class Invoice extends Document {
     dueDate = undefined,
     taxes = undefined,
     supplier = undefined,
+    supplierAddress = undefined,
     paymentDetails = undefined,
     companyNumber = undefined,
     vatNumber = undefined,
     orientation = undefined,
     totalTax = undefined,
+    customerName = undefined,
+    customerAddress = undefined,
+    customerCompanyRegistration = undefined,
+    words = undefined,
     pageNumber = 0,
+    level = "page",
   }) {
     super(inputFile);
+    this.level = level;
+    this.constructPrediction = function (item) {
+      return { prediction: { value: item }, valueKey: "value", pageNumber };
+    };
     if (apiPrediction === undefined) {
       this.#initFromScratch({
         locale,
@@ -55,15 +69,19 @@ class Invoice extends Document {
         dueDate,
         taxes,
         supplier,
+        supplierAddress,
         paymentDetails,
         companyNumber,
         vatNumber,
         orientation,
         pageNumber,
         totalTax,
+        customerName,
+        customerAddress,
+        customerCompanyRegistration,
       });
     } else {
-      this.#initFromApiPrediction(apiPrediction, pageNumber);
+      this.#initFromApiPrediction(apiPrediction, pageNumber, words);
     }
     this.#checklist();
     this.#reconstruct();
@@ -79,28 +97,34 @@ class Invoice extends Document {
     dueDate,
     taxes,
     supplier,
+    supplierAddress,
     paymentDetails,
     companyNumber,
     vatNumber,
     orientation,
     pageNumber,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration,
   }) {
-    const constructPrediction = function (item) {
-      return { prediction: { value: item }, valueKey: "value", pageNumber };
-    };
-    this.locale = new Locale(constructPrediction(locale));
-    this.totalIncl = new Amount(constructPrediction(totalIncl));
-    this.totalExcl = new Amount(constructPrediction(totalExcl));
-    this.totalTax = new Amount(constructPrediction(totalTax));
-    this.date = new Date(constructPrediction(invoiceDate));
-    this.invoiceDate = new Date(constructPrediction(invoiceDate));
-    this.dueDate = new Date(constructPrediction(dueDate));
-    this.supplier = new Field(constructPrediction(supplier));
-    this.orientation = new Orientation(constructPrediction(orientation));
-    this.invoiceNumber = new Field(constructPrediction(invoiceNumber));
-    this.paymentDetails = new Field(constructPrediction(paymentDetails));
-    this.companyNumber = new Field(constructPrediction(companyNumber));
-    this.vatNumber = new Field(constructPrediction(vatNumber));
+    this.locale = new Locale(this.constructPrediction(locale));
+    this.totalIncl = new Amount(this.constructPrediction(totalIncl));
+    this.totalExcl = new Amount(this.constructPrediction(totalExcl));
+    this.totalTax = new Amount(this.constructPrediction(totalTax));
+    this.date = new Date(this.constructPrediction(invoiceDate));
+    this.invoiceDate = new Date(this.constructPrediction(invoiceDate));
+    this.dueDate = new Date(this.constructPrediction(dueDate));
+    this.supplier = new Field(this.constructPrediction(supplier));
+    this.supplierAddress = new Field(this.constructPrediction(supplierAddress));
+    this.invoiceNumber = new Field(this.constructPrediction(invoiceNumber));
+    this.paymentDetails = new Field(this.constructPrediction(paymentDetails));
+    this.companyNumber = new Field(this.constructPrediction(companyNumber));
+    this.vatNumber = new Field(this.constructPrediction(vatNumber));
+    this.customerName = new Field(this.constructPrediction(customerName));
+    this.customerAddress = new Field(this.constructPrediction(customerAddress));
+    this.customerCompanyRegistration = new Field(
+      this.constructPrediction(customerCompanyRegistration)
+    );
     if (taxes !== undefined) {
       this.taxes = [];
       for (const t of taxes) {
@@ -114,10 +138,12 @@ class Invoice extends Document {
         );
       }
     }
+    if (this.level === "page") {
+      this.orientation = new Orientation(this.constructPrediction(orientation));
+    }
   }
 
-  #initFromApiPrediction(apiPrediction, pageNumber) {
-    this.words = [];
+  #initFromApiPrediction(apiPrediction, pageNumber, words) {
     this.locale = new Locale({ prediction: apiPrediction.locale, pageNumber });
     this.totalIncl = new Amount({
       prediction: apiPrediction.total_incl,
@@ -125,7 +151,7 @@ class Invoice extends Document {
       pageNumber,
     });
     this.totalTax = new Amount({
-      prediction: { value: undefined, probability: 0.0 },
+      prediction: { value: undefined, confidence: 0.0 },
       valueKey: "value",
       pageNumber,
     });
@@ -153,10 +179,6 @@ class Invoice extends Document {
         codeKey: "code",
       });
     });
-    this.orientation = new Orientation({
-      prediction: apiPrediction.orientation,
-      pageNumber,
-    });
     this.companyNumber = apiPrediction.company_registration.map(function (
       companyNumber
     ) {
@@ -179,13 +201,49 @@ class Invoice extends Document {
       prediction: apiPrediction.supplier,
       pageNumber,
     });
+    this.supplierAddress = new Field({
+      prediction: apiPrediction.supplier_address,
+      pageNumber,
+    });
+    this.customerName = new Field({
+      prediction: apiPrediction.customer,
+      pageNumber,
+    });
+    this.customerAddress = new Field({
+      prediction: apiPrediction.customer_address,
+      pageNumber,
+    });
+    this.customerCompanyRegistration = apiPrediction.customer_company_registration.map(
+      function (customerCompanyRegistration) {
+        return new Field({
+          prediction: customerCompanyRegistration,
+          pageNumber,
+          extraFields: ["type"],
+        });
+      }
+    );
     this.paymentDetails = apiPrediction.payment_details.map(function (
       paymentDetail
     ) {
       return new PaymentDetails({ prediction: paymentDetail, pageNumber });
     });
-
-    if ("mvision" in apiPrediction) this.words = apiPrediction.mvision;
+    if (this.level === "page") {
+      this.orientation = new Orientation({
+        prediction: apiPrediction.orientation,
+        pageNumber,
+      });
+    } else {
+      this.orientation = new Orientation(
+        this.constructPrediction({
+          prediction: {
+            value: undefined,
+            confidence: 0.0,
+            degrees: undefined,
+          },
+        })
+      );
+    }
+    if (words && words.length > 0) this.words = words;
   }
 
   toString() {
@@ -197,6 +255,9 @@ class Invoice extends Document {
     Total amount excluding taxes: ${this.totalExcl.value}
     Invoice Date: ${this.invoiceDate.value}
     Supplier name: ${this.supplier.value}
+    Supplier address: ${this.supplierAddress.value}
+    Customer name: ${this.customerName.value}
+    Customer address: ${this.customerAddress.value}
     Taxes: ${this.taxes.map((tax) => tax.toString()).join(" - ")}
     Total taxes: ${this.totalTax.value}
     `;
@@ -314,7 +375,7 @@ class Invoice extends Document {
         value: this.taxes.reduce((acc, tax) => {
           return tax.value !== undefined ? acc + tax.value : acc;
         }, 0),
-        probability: Field.arrayProbability(this.taxes),
+        confidence: Field.arrayProbability(this.taxes),
       };
       if (totalTax.value > 0)
         this.totalTax = new Amount({
@@ -334,7 +395,7 @@ class Invoice extends Document {
     ) {
       const totalTax = {
         value: this.totalIncl.value - this.totalExcl.value,
-        probability: this.totalIncl.probability * this.totalExcl.probability,
+        confidence: this.totalIncl.probability * this.totalExcl.probability,
       };
       if (totalTax.value > 0)
         this.totalTax = new Amount({
@@ -357,7 +418,7 @@ class Invoice extends Document {
           this.taxes.reduce((acc, tax) => {
             return tax.value !== undefined ? acc + tax.value : acc;
           }, 0),
-        probability:
+        confidence:
           Field.arrayProbability(this.taxes) * this.totalIncl.probability,
       };
       this.totalExcl = new Amount({
@@ -380,7 +441,7 @@ class Invoice extends Document {
           this.taxes.reduce((acc, tax) => {
             return tax.value ? acc + tax.value : acc;
           }, 0.0),
-        probability:
+        confidence:
           Field.arrayProbability(this.taxes) * this.totalExcl.probability,
       };
       this.totalIncl = new Amount({