mindee 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## v1.1.2
+
+### Fixes
+
+- fix: 🐛 Fix returned probability value
+- fix: 🐛 Fix returned bbox value
+
+### new
+
+- new: ✨ New Mindee Invoice API V3 support
+- new: ✨ Add new supplier and customer fields
+
 ## v1.1.0 (2022-01-03)
 
 ### new

package/README.md

@@ -2,9 +2,14 @@
 
 # Installation
 
+## Requirements
+
+The SDK is officially supported on Node.js LTS _active_ and _maintenance_
+[versions](https://nodejs.org/en/about/releases/).
+
 ## From source code
 
-Download and decompress or clone the source code from github and then do in your node project :
+Download and decompress or clone the source code from GitHub and then do in your Node.js project:
 
 ```sh
 npm install mindee
@@ -12,7 +17,7 @@ npm install mindee
 
 # Usage
 
-You can use the SDK easily by creating a Client like this :
+You can use the SDK easily by creating a Client like this:
 
 ```js
 const { Client } = require("mindee");
@@ -32,11 +37,14 @@ mindeeClient.financialDocument.parse({
 
 Three apis are actually supported : invoice (`ìnvoice`), receipt (`receipt`) and financial document (`financialDocument`)
 
-You can find more examples on how to use the SDK into the folder `examples`
+You can find more examples on how to use the SDK into the folder `examples`.
 
 ## Client
 
-The mindee Client can take multiple parameters to be initialize. Some this parameters can also be set with env variables. If the env variable and the parameter are both set, the parameter will be the one chosen by the client. This is a list of them:
+The Mindee client can take multiple parameters to be initialize.
+Some this parameters can also be set with env variables.
+If the env variable and the parameter are both set, the parameter will be the one chosen by the client.
+This is a list of them:
 
 - invoiceToken (env variable : `MINDEE_INVOICE_TOKEN`) The expense api token
 - receiptToken (env variable : `MINDEE_RECEIPT_TOKEN`) The invoice api token
@@ -118,15 +126,6 @@ mindeeClient.financialDocument
 
 # Tests
 
-First, link your package to the test repository by linking the node package to the tests :
-
-```sh
-cd mindee-api-nodejs/
-npm link
-cd tests/
-npm link mindee
-```
-
 To run the tests, use the command `npm run test`
 
 # Documentation
@@ -135,3 +134,4 @@ A basic documentation of the sdk has been done with the help of JSDoc.
 If you want to generate it, you can use the command `npm run documentation`.
 A folder `docs` will be created with generated documentation.
 Open the `index.html` in your browser to read the documentation.
+

package/lib/api/financialDocument.js

@@ -46,7 +46,7 @@ class APIFinancialDocument extends APIObject {
       });
       yield inputFile.init();
       _this.apiToken = inputFile.fileExtension === "application/pdf" ? _this.invoiceToken : _this.receiptToken;
-      var url = inputFile.fileExtension === "application/pdf" ? "/invoices/v2/predict" : "/expense_receipts/v3/predict";
+      var url = inputFile.fileExtension === "application/pdf" ? "/invoices/v3/predict" : "/expense_receipts/v3/predict";
 
       _superprop_getParse().call(_this);
 

package/lib/api/invoice.js

@@ -34,7 +34,7 @@ class APIInvoice extends APIObject {
         input,
         inputType = "path",
         filename = undefined,
-        version = "2",
+        version = "3",
         cutPdf = true,
         includeWords = false
       } = _ref;

package/lib/api/request.js

@@ -62,7 +62,7 @@ var request = function request(url, method, headers, input) {
             data: JSON.parse(responseBody)
           }));
         } catch (error) {
-          console.log("error");
+          console.log(responseBody, error);
         }
       });
     });

package/lib/api/response.js

@@ -14,8 +14,6 @@ function _objectWithoutProperties(source, excluded) { if (source == null) return
 
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 
-var Document = require("../documents").document;
-
 var Receipt = require("../documents").receipt;
 
 var Invoice = require("../documents").invoice;
@@ -84,7 +82,7 @@ class Response {
     this[this.documentType] = constructors[this.documentType]({
       apiPrediction: this.httpResponse.data.document.inference.prediction,
       inputFile: this.input,
-      pageNumber: -1,
+      pageNumber: this.httpResponse.data.document.n_pages,
       level: "document"
     });
   }

package/lib/documents/fields/field.js

@@ -19,13 +19,11 @@ class Field {
     this.pageNumber = pageNumber;
     this.reconstructed = reconstructed;
     this.value = undefined;
-    this.probability = 0.0;
-    this.bbox = [];
+    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 (var fieldName of extraFields) {

package/lib/documents/financialDocument.js

@@ -45,13 +45,17 @@ 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
    */
@@ -66,13 +70,17 @@ class FinancialDocument extends Document {
       invoiceNumber: _invoiceNumber = undefined,
       dueDate: _dueDate = undefined,
       taxes: _taxes = undefined,
-      merchantName = undefined,
+      supplier: _supplier = undefined,
+      supplierAddress: _supplierAddress = undefined,
       paymentDetails: _paymentDetails = undefined,
       companyNumber: _companyNumber = undefined,
       vatNumber: _vatNumber = undefined,
       orientation: _orientation = undefined,
       totalTax: _totalTax = undefined,
       time: _time = undefined,
+      customerName: _customerName = undefined,
+      customerAddress: _customerAddress = undefined,
+      customerCompanyRegistration: _customerCompanyRegistration = undefined,
       pageNumber: _pageNumber = 0,
       level = "page"
     } = _ref;
@@ -97,14 +105,18 @@ class FinancialDocument extends Document {
         invoiceNumber: _invoiceNumber,
         dueDate: _dueDate,
         taxes: _taxes,
-        supplier,
+        supplier: _supplier,
+        supplierAddress: _supplierAddress,
         paymentDetails: _paymentDetails,
         companyNumber: _companyNumber,
         vatNumber: _vatNumber,
         orientation: _orientation,
         pageNumber: _pageNumber,
         totalTax: _totalTax,
-        time: _time
+        time: _time,
+        customerName: _customerName,
+        customerAddress: _customerAddress,
+        customerCompanyRegistration: _customerCompanyRegistration
       });
     } else {
       _classPrivateMethodGet(this, _initFromApiPrediction, _initFromApiPrediction2).call(this, _apiPrediction, _inputFile, _pageNumber);
@@ -135,7 +147,11 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
     orientation,
     pageNumber,
     supplier,
-    time
+    supplierAddress,
+    time,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration
   } = _ref2;
 
   var constructPrediction = function constructPrediction(item) {
@@ -155,12 +171,16 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
   this.date = new Date(constructPrediction(date));
   this.dueDate = new Date(constructPrediction(dueDate));
   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 = [];
@@ -195,6 +215,7 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, in
     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;
@@ -202,9 +223,12 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, in
     this.time = new Field({
       prediction: {
         value: undefined,
-        probability: 0.0
+        confidence: 0.0
       }
     });
+    this.customerName = invoice.customerName;
+    this.customerAddress = invoice.customerAddress;
+    this.customerCompanyRegistration = invoice.customerCompanyRegistration;
   } else {
     var receipt = new Receipt({
       apiPrediction,
@@ -220,26 +244,45 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, in
     this.totalIncl = receipt.totalIncl;
     this.totalExcl = receipt.totalExcl;
     this.supplier = receipt.merchantName;
+    this.supplierAddress = new Field({
+      prediction: {
+        value: undefined,
+        confidence: 0.0
+      }
+    });
     this.time = receipt.time;
     this.totalTax = receipt.totalTax;
     this.invoiceNumber = new Field({
       prediction: {
         value: undefined,
-        probability: 0.0
+        confidence: 0.0
       }
     });
     this.paymentDetails = new Field({
       prediction: {
         value: undefined,
-        probability: 0.0
+        confidence: 0.0
       }
     });
     this.companyNumber = new Field({
       prediction: {
         value: undefined,
-        probability: 0.0
+        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 = [];
   }
 };
 
@@ -267,7 +310,7 @@ var _taxesMatchTotalIncl2 = function _taxesMatchTotalIncl2() {
 
   if (this.totalIncl.value * (1 - eps) - 0.02 <= reconstructedTotal && reconstructedTotal <= this.totalIncl.value * (1 + eps) + 0.02) {
     this.taxes = this.taxes.map(tax => _objectSpread(_objectSpread({}, tax), {}, {
-      probability: 1.0
+      confidence: 1.0
     }));
     this.totalTax.probability = 1.0;
     this.totalIncl.probability = 1.0;

package/lib/documents/invoice.js

@@ -57,11 +57,15 @@ 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} 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
    */
@@ -77,11 +81,15 @@ class Invoice extends Document {
       dueDate: _dueDate = undefined,
       taxes: _taxes = undefined,
       supplier: _supplier = undefined,
+      supplierAddress: _supplierAddress = undefined,
       paymentDetails: _paymentDetails = undefined,
       companyNumber: _companyNumber = undefined,
       vatNumber: _vatNumber = undefined,
       orientation: _orientation = undefined,
       totalTax: _totalTax = undefined,
+      customerName: _customerName = undefined,
+      customerAddress: _customerAddress = undefined,
+      customerCompanyRegistration: _customerCompanyRegistration = undefined,
       pageNumber: _pageNumber = 0,
       level = "page"
     } = _ref;
@@ -131,12 +139,16 @@ class Invoice extends Document {
         dueDate: _dueDate,
         taxes: _taxes,
         supplier: _supplier,
+        supplierAddress: _supplierAddress,
         paymentDetails: _paymentDetails,
         companyNumber: _companyNumber,
         vatNumber: _vatNumber,
         orientation: _orientation,
         pageNumber: _pageNumber,
-        totalTax: _totalTax
+        totalTax: _totalTax,
+        customerName: _customerName,
+        customerAddress: _customerAddress,
+        customerCompanyRegistration: _customerCompanyRegistration
       });
     } else {
       _classPrivateMethodGet(this, _initFromApiPrediction, _initFromApiPrediction2).call(this, _apiPrediction, _pageNumber);
@@ -148,7 +160,7 @@ class Invoice extends Document {
   }
 
   toString() {
-    return "\n    -----Invoice data-----\n    Filename: ".concat(this.filename, "\n    Invoice number: ").concat(this.invoiceNumber.value, "\n    Total amount including taxes: ").concat(this.totalIncl.value, "\n    Total amount excluding taxes: ").concat(this.totalExcl.value, "\n    Invoice Date: ").concat(this.invoiceDate.value, "\n    Supplier name: ").concat(this.supplier.value, "\n    Taxes: ").concat(this.taxes.map(tax => tax.toString()).join(" - "), "\n    Total taxes: ").concat(this.totalTax.value, "\n    ");
+    return "\n    -----Invoice data-----\n    Filename: ".concat(this.filename, "\n    Invoice number: ").concat(this.invoiceNumber.value, "\n    Total amount including taxes: ").concat(this.totalIncl.value, "\n    Total amount excluding taxes: ").concat(this.totalExcl.value, "\n    Invoice Date: ").concat(this.invoiceDate.value, "\n    Supplier name: ").concat(this.supplier.value, "\n    Supplier address: ").concat(this.supplierAddress.value, "\n    Customer name: ").concat(this.customerName.value, "\n    Customer address: ").concat(this.customerAddress.value, "\n    Taxes: ").concat(this.taxes.map(tax => tax.toString()).join(" - "), "\n    Total taxes: ").concat(this.totalTax.value, "\n    ");
   }
 
 }
@@ -164,11 +176,15 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
     dueDate,
     taxes,
     supplier,
+    supplierAddress,
     paymentDetails,
     companyNumber,
     vatNumber,
     orientation,
-    pageNumber
+    pageNumber,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration
   } = _ref2;
   this.locale = new Locale(this.constructPrediction(locale));
   this.totalIncl = new Amount(this.constructPrediction(totalIncl));
@@ -178,10 +194,14 @@ var _initFromScratch2 = function _initFromScratch2(_ref2) {
   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 = [];
@@ -218,7 +238,7 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
   this.totalTax = new Amount({
     prediction: {
       value: undefined,
-      probability: 0.0
+      confidence: 0.0
     },
     valueKey: "value",
     pageNumber
@@ -267,6 +287,25 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
     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,
@@ -283,7 +322,7 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
     this.orientation = new Orientation(this.constructPrediction({
       prediction: {
         value: undefined,
-        probability: 0.0,
+        confidence: 0.0,
         degrees: undefined
       }
     }));
@@ -392,7 +431,7 @@ var _reconstructTotalTax2 = function _reconstructTotalTax2() {
       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({
       prediction: totalTax,
@@ -406,7 +445,7 @@ var _reconstructTotalTaxFromTotals2 = function _reconstructTotalTaxFromTotals2()
   if (this.totalTax.value === undefined && this.totalIncl.value > 0 && this.totalExcl.value > 0 && this.totalExcl.value <= this.totalIncl.value) {
     var 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({
       prediction: totalTax,
@@ -422,7 +461,7 @@ var _reconstructTotalExcl2 = function _reconstructTotalExcl2() {
       value: this.totalIncl.value - this.taxes.reduce((acc, tax) => {
         return tax.value !== undefined ? acc + tax.value : acc;
       }, 0),
-      probability: Field.arrayProbability(this.taxes) * this.totalIncl.probability
+      confidence: Field.arrayProbability(this.taxes) * this.totalIncl.probability
     };
     this.totalExcl = new Amount({
       prediction: totalExcl,
@@ -438,7 +477,7 @@ var _reconstructTotalIncl2 = function _reconstructTotalIncl2() {
       value: this.totalExcl.value + this.taxes.reduce((acc, tax) => {
         return tax.value ? acc + tax.value : acc;
       }, 0.0),
-      probability: Field.arrayProbability(this.taxes) * this.totalExcl.probability
+      confidence: Field.arrayProbability(this.taxes) * this.totalExcl.probability
     };
     this.totalIncl = new Amount({
       prediction: totalIncl,

package/lib/documents/receipt.js

@@ -229,7 +229,7 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
   this.totalTax = new Amount({
     prediction: {
       value: undefined,
-      probability: 0
+      confidence: 0
     },
     valueKey: "value",
     pageNumber
@@ -237,7 +237,7 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
   this.totalExcl = new Amount({
     prediction: {
       value: undefined,
-      probability: 0
+      confidence: 0
     },
     valueKey: "value",
     pageNumber
@@ -252,7 +252,7 @@ var _initFromApiPrediction2 = function _initFromApiPrediction2(apiPrediction, pa
     this.orientation = new Orientation(this.constructPrediction({
       prediction: {
         value: undefined,
-        probability: 0.0,
+        confidence: 0.0,
         degrees: undefined
       }
     }));
@@ -305,7 +305,7 @@ var _reconstructTotalExclFromTCCAndTaxes2 = function _reconstructTotalExclFromTC
   if (this.taxes.length && this.totalIncl.value != null) {
     var totalExcl = {
       value: this.totalIncl.value - Field.arraySum(this.taxes),
-      probability: Field.arrayProbability(this.taxes) * this.totalIncl.probability
+      confidence: Field.arrayProbability(this.taxes) * this.totalIncl.probability
     };
     this.totalExcl = new Amount({
       prediction: totalExcl,
@@ -319,7 +319,7 @@ var _reconstructTotalTax2 = function _reconstructTotalTax2() {
   if (this.taxes.length && this.totalTax.value == null) {
     var totalTax = {
       value: this.taxes.map(tax => tax.value || 0).reduce((a, b) => a + b, 0),
-      probability: Field.arrayProbability(this.taxes)
+      confidence: Field.arrayProbability(this.taxes)
     };
     if (totalTax.value > 0) this.totalTax = new Amount({
       prediction: totalTax,

package/mindee/api/financialDocument.js

@@ -37,7 +37,7 @@ class APIFinancialDocument extends APIObject {
         : this.receiptToken;
     const url =
       inputFile.fileExtension === "application/pdf"
-        ? "/invoices/v2/predict"
+        ? "/invoices/v3/predict"
         : "/expense_receipts/v3/predict";
     super.parse();
     return await super._request(url, inputFile, version, includeWords);

package/mindee/api/invoice.js

@@ -19,7 +19,7 @@ class APIInvoice extends APIObject {
     input,
     inputType = "path",
     filename = undefined,
-    version = "2",
+    version = "3",
     cutPdf = true,
     includeWords = false,
   }) {

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;
@@ -56,7 +55,7 @@ class Response {
     this[this.documentType] = constructors[this.documentType]({
       apiPrediction: this.httpResponse.data.document.inference.prediction,
       inputFile: this.input,
-      pageNumber: -1,
+      pageNumber: this.httpResponse.data.document.n_pages,
       level: "document",
     });
   }

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 = [];
+    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,13 +19,17 @@ 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
    */
@@ -39,13 +43,17 @@ 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,
     pageNumber = 0,
     level = "page",
   }) {
@@ -61,6 +69,7 @@ class FinancialDocument extends Document {
         dueDate,
         taxes,
         supplier,
+        supplierAddress,
         paymentDetails,
         companyNumber,
         vatNumber,
@@ -68,6 +77,9 @@ class FinancialDocument extends Document {
         pageNumber,
         totalTax,
         time,
+        customerName,
+        customerAddress,
+        customerCompanyRegistration,
       });
     } else {
       this.#initFromApiPrediction(apiPrediction, inputFile, pageNumber);
@@ -90,7 +102,11 @@ class FinancialDocument extends Document {
     orientation,
     pageNumber,
     supplier,
+    supplierAddress,
     time,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration,
   }) {
     const constructPrediction = function (item) {
       return { prediction: { value: item }, valueKey: "value", pageNumber };
@@ -102,12 +118,18 @@ class FinancialDocument extends Document {
     this.date = new Date(constructPrediction(date));
     this.dueDate = new Date(constructPrediction(dueDate));
     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) {
@@ -139,13 +161,17 @@ class FinancialDocument extends Document {
       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;
       this.time = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        prediction: { value: undefined, confidence: 0.0 },
       });
+      this.customerName = invoice.customerName;
+      this.customerAddress = invoice.customerAddress;
+      this.customerCompanyRegistration = invoice.customerCompanyRegistration;
     } else {
       const receipt = new Receipt({
         apiPrediction,
@@ -161,17 +187,27 @@ class FinancialDocument extends Document {
       this.totalIncl = receipt.totalIncl;
       this.totalExcl = receipt.totalExcl;
       this.supplier = receipt.merchantName;
+      this.supplierAddress = new Field({
+        prediction: { value: undefined, confidence: 0.0 },
+      });
       this.time = receipt.time;
       this.totalTax = receipt.totalTax;
       this.invoiceNumber = new Field({
-        prediction: { value: undefined, probability: 0.0 },
+        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 = [];
     }
   }
 
@@ -216,7 +252,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

@@ -18,11 +18,15 @@ 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} 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
    */
@@ -37,11 +41,15 @@ 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,
     pageNumber = 0,
     level = "page",
   }) {
@@ -60,12 +68,16 @@ class Invoice extends Document {
         dueDate,
         taxes,
         supplier,
+        supplierAddress,
         paymentDetails,
         companyNumber,
         vatNumber,
         orientation,
         pageNumber,
         totalTax,
+        customerName,
+        customerAddress,
+        customerCompanyRegistration,
       });
     } else {
       this.#initFromApiPrediction(apiPrediction, pageNumber);
@@ -84,11 +96,15 @@ class Invoice extends Document {
     dueDate,
     taxes,
     supplier,
+    supplierAddress,
     paymentDetails,
     companyNumber,
     vatNumber,
     orientation,
     pageNumber,
+    customerName,
+    customerAddress,
+    customerCompanyRegistration,
   }) {
     this.locale = new Locale(this.constructPrediction(locale));
     this.totalIncl = new Amount(this.constructPrediction(totalIncl));
@@ -98,10 +114,16 @@ class Invoice extends Document {
     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) {
@@ -129,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,
     });
@@ -179,6 +201,27 @@ 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
     ) {
@@ -194,7 +237,7 @@ class Invoice extends Document {
         this.constructPrediction({
           prediction: {
             value: undefined,
-            probability: 0.0,
+            confidence: 0.0,
             degrees: undefined,
           },
         })
@@ -213,6 +256,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}
     `;
@@ -330,7 +376,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({
@@ -350,7 +396,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({
@@ -373,7 +419,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({
@@ -396,7 +442,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({

package/mindee/documents/receipt.js

@@ -146,12 +146,12 @@ class Receipt extends Document {
         })
     );
     this.totalTax = new Amount({
-      prediction: { value: undefined, probability: 0 },
+      prediction: { value: undefined, confidence: 0 },
       valueKey: "value",
       pageNumber,
     });
     this.totalExcl = new Amount({
-      prediction: { value: undefined, probability: 0 },
+      prediction: { value: undefined, confidence: 0 },
       valueKey: "value",
       pageNumber,
     });
@@ -165,7 +165,7 @@ class Receipt extends Document {
         this.constructPrediction({
           prediction: {
             value: undefined,
-            probability: 0.0,
+            confidence: 0.0,
             degrees: undefined,
           },
         })
@@ -250,7 +250,7 @@ class Receipt extends Document {
     if (this.taxes.length && this.totalIncl.value != null) {
       const totalExcl = {
         value: this.totalIncl.value - Field.arraySum(this.taxes),
-        probability:
+        confidence:
           Field.arrayProbability(this.taxes) * this.totalIncl.probability,
       };
       this.totalExcl = new Amount({
@@ -272,7 +272,7 @@ class Receipt extends Document {
         value: this.taxes
           .map((tax) => tax.value || 0)
           .reduce((a, b) => a + b, 0),
-        probability: Field.arrayProbability(this.taxes),
+        confidence: Field.arrayProbability(this.taxes),
       };
       if (totalTax.value > 0)
         this.totalTax = new Amount({

package/mindee/inputs.js

@@ -74,7 +74,6 @@ class Input {
 
     // Check if file type is valid
     const filetype = this.filename.split(".").pop();
-    console.log(this.filename.split("."));
     if (!(filetype in this.MIMETYPES)) {
       errorHandler.throw(
         new Error(

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "mindee",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Mindee API SDK for Node.js",
   "main": "mindee/index.js",
-  "license": "GPL-3.0",
+  "license": "Apache-2.0",
   "scripts": {
     "build": "babel mindee -d lib",
     "test": "npm run build && mocha tests/**/*.js",