mindee 4.0.0 → 4.0.2

package/src/product/invoiceSplitter/invoiceSplitterV1Document.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvoiceSplitterV1Document = void 0;
 const common_1 = require("../../parsing/common");
 const invoiceSplitterV1PageGroup_1 = require("./invoiceSplitterV1PageGroup");
+/**
+ * Document data for Invoice Splitter, API version 1.
+ */
 class InvoiceSplitterV1Document extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
@@ -11,6 +14,9 @@ class InvoiceSplitterV1Document extends common_1.Inference {
         rawPrediction["invoice_page_groups"] &&
             rawPrediction["invoice_page_groups"].forEach((prediction) => this.invoicePageGroups.push(new invoiceSplitterV1PageGroup_1.PageGroup(prediction)));
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const invoicePageGroups = this.invoicePageGroups
             .map((item) => "\n  " + item.toString())

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.d.ts

@@ -1,7 +1,15 @@
 import { StringDict } from "../../parsing/common";
+/**
+ * Pages indexes in a group.
+ */
 export declare class PageGroup {
+    /** List of page indexes. */
     pageIndexes: number[];
+    /** Confidence score. */
     confidence: number;
     constructor(prediction: StringDict);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/invoiceSplitter/invoiceSplitterV1PageGroup.js

@@ -1,12 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageGroup = void 0;
+/**
+ * Pages indexes in a group.
+ */
 class PageGroup {
     constructor(prediction) {
+        /** List of page indexes. */
         this.pageIndexes = [];
         this.pageIndexes = prediction.page_indexes;
         this.confidence = prediction["confidence"];
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         return `:Page indexes: ${this.pageIndexes.join(", ")}`;
     }

package/src/product/passport/passportV1.d.ts

@@ -1,9 +1,16 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { PassportV1Document } from "./passportV1Document";
+/**
+ * Inference prediction for Passport, API version 1.
+ */
 export declare class PassportV1 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: PassportV1Document;
+    /** The document's pages. */
     pages: Page<PassportV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/passport/passportV1.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PassportV1 = void 0;
 const common_1 = require("../../parsing/common");
 const passportV1Document_1 = require("./passportV1Document");
+/**
+ * Inference prediction for Passport, API version 1.
+ */
 class PassportV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "passport";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new passportV1Document_1.PassportV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(passportV1Document_1.PassportV1Document, page, page["id"], page["orientation"]));

package/src/product/passport/passportV1Document.d.ts

@@ -27,5 +27,8 @@ export declare class PassportV1Document implements Prediction {
     /** The surname of the passport holder. */
     surname: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/passport/passportV1Document.js

@@ -56,6 +56,9 @@ class PassportV1Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const givenNames = this.givenNames.join("\n              ");
         const outStr = `:Country Code: ${this.country}

package/src/product/proofOfAddress/proofOfAddressV1.d.ts

@@ -1,9 +1,16 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { ProofOfAddressV1Document } from "./proofOfAddressV1Document";
+/**
+ * Inference prediction for Proof of Address, API version 1.
+ */
 export declare class ProofOfAddressV1 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: ProofOfAddressV1Document;
+    /** The document's pages. */
     pages: Page<ProofOfAddressV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/proofOfAddress/proofOfAddressV1.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProofOfAddressV1 = void 0;
 const common_1 = require("../../parsing/common");
 const proofOfAddressV1Document_1 = require("./proofOfAddressV1Document");
+/**
+ * Inference prediction for Proof of Address, API version 1.
+ */
 class ProofOfAddressV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "proof_of_address";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new proofOfAddressV1Document_1.ProofOfAddressV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(proofOfAddressV1Document_1.ProofOfAddressV1Document, page, page["id"], page["orientation"]));

package/src/product/proofOfAddress/proofOfAddressV1Document.d.ts

@@ -23,5 +23,8 @@ export declare class ProofOfAddressV1Document implements Prediction {
     /** The name of the person or company receiving the document. */
     recipientName: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/proofOfAddress/proofOfAddressV1Document.js

@@ -53,6 +53,9 @@ class ProofOfAddressV1Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const issuerCompanyRegistration = this.issuerCompanyRegistration.join("\n                              ");
         const recipientCompanyRegistration = this.recipientCompanyRegistration.join("\n                                 ");

package/src/product/receipt/receiptV4.d.ts

@@ -1,9 +1,16 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { ReceiptV4Document } from "./receiptV4Document";
+/**
+ * Inference prediction for Receipt, API version 4.
+ */
 export declare class ReceiptV4 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: ReceiptV4Document;
+    /** The document's pages. */
     pages: Page<ReceiptV4Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/receipt/receiptV4.js

@@ -3,10 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReceiptV4 = void 0;
 const common_1 = require("../../parsing/common");
 const receiptV4Document_1 = require("./receiptV4Document");
+/**
+ * Inference prediction for Receipt, API version 4.
+ */
 class ReceiptV4 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "expense_receipts";
+        /** The endpoint's version. */
         this.endpointVersion = "4";
         this.prediction = new receiptV4Document_1.ReceiptV4Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(receiptV4Document_1.ReceiptV4Document, page, page["id"], page["orientation"]));

package/src/product/receipt/receiptV4Document.d.ts

@@ -1,5 +1,8 @@
 import { Prediction, StringDict } from "../../parsing/common";
 import { ClassificationField, AmountField, DateField, StringField, LocaleField, TaxField } from "../../parsing/standard";
+/**
+ * Document data for Receipt, API version 5.
+ */
 export declare class ReceiptV4Document implements Prediction {
     /** Where the purchase was made, the language, and the currency. */
     locale: LocaleField;
@@ -26,5 +29,8 @@ export declare class ReceiptV4Document implements Prediction {
     /** Total tax amount of the purchase. */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/receipt/receiptV4Document.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReceiptV4Document = void 0;
 const common_1 = require("../../parsing/common");
 const standard_1 = require("../../parsing/standard");
+/**
+ * Document data for Receipt, API version 5.
+ */
 class ReceiptV4Document {
     constructor(rawPrediction, pageId) {
         this.locale = new standard_1.LocaleField({
@@ -48,6 +51,9 @@ class ReceiptV4Document {
         });
         this.taxes = new standard_1.Taxes().init(rawPrediction["taxes"], pageId);
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const outStr = `:Locale: ${this.locale}
 :Date: ${this.date}

package/src/product/receipt/receiptV5.d.ts

@@ -1,9 +1,16 @@
 import { Inference, StringDict, Page } from "../../parsing/common";
 import { ReceiptV5Document } from "./receiptV5Document";
+/**
+ * Inference prediction for Receipt, API version 5.
+ */
 export declare class ReceiptV5 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: ReceiptV5Document;
+    /** The document's pages. */
     pages: Page<ReceiptV5Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/receipt/receiptV5.js

@@ -3,11 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReceiptV5 = void 0;
 const common_1 = require("../../parsing/common");
 const receiptV5Document_1 = require("./receiptV5Document");
+/**
+ * Inference prediction for Receipt, API version 5.
+ */
 class ReceiptV5 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "expense_receipts";
+        /** The endpoint's version. */
         this.endpointVersion = "5";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new receiptV5Document_1.ReceiptV5Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(receiptV5Document_1.ReceiptV5Document, page, page["id"], page["orientation"]));

package/src/product/receipt/receiptV5Document.d.ts

@@ -38,5 +38,8 @@ export declare class ReceiptV5Document implements Prediction {
     /** The total amount of taxes. */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/receipt/receiptV5Document.js

@@ -73,6 +73,9 @@ class ReceiptV5Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const supplierCompanyRegistrations = this.supplierCompanyRegistrations.join("\n                                 ");
         let lineItemsSummary = "";

package/src/product/us/bankCheck/bankCheckV1.d.ts

@@ -1,10 +1,17 @@
 import { Inference, StringDict, Page } from "../../../parsing/common";
 import { BankCheckV1Document } from "./bankCheckV1Document";
 import { BankCheckV1Page } from "./bankCheckV1Page";
+/**
+ * Inference prediction for Bank Check, API version 1.
+ */
 export declare class BankCheckV1 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: BankCheckV1Document;
+    /** The document's pages. */
     pages: Page<BankCheckV1Page>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/us/bankCheck/bankCheckV1.js

@@ -4,11 +4,17 @@ exports.BankCheckV1 = void 0;
 const common_1 = require("../../../parsing/common");
 const bankCheckV1Document_1 = require("./bankCheckV1Document");
 const bankCheckV1Page_1 = require("./bankCheckV1Page");
+/**
+ * Inference prediction for Bank Check, API version 1.
+ */
 class BankCheckV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "bank_check";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new bankCheckV1Document_1.BankCheckV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(bankCheckV1Page_1.BankCheckV1Page, page, page["id"], page["orientation"]));

package/src/product/us/bankCheck/bankCheckV1Document.d.ts

@@ -17,5 +17,8 @@ export declare class BankCheckV1Document implements Prediction {
     /** The check issuer's routing number. */
     routingNumber: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/us/bankCheck/bankCheckV1Document.js

@@ -36,6 +36,9 @@ class BankCheckV1Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const payees = this.payees.join("\n         ");
         const outStr = `:Check Issue Date: ${this.date}

package/src/product/us/driverLicense/driverLicenseV1.d.ts

@@ -1,10 +1,17 @@
 import { Inference, StringDict, Page } from "../../../parsing/common";
 import { DriverLicenseV1Document } from "./driverLicenseV1Document";
 import { DriverLicenseV1Page } from "./driverLicenseV1Page";
+/**
+ * Inference prediction for Driver License, API version 1.
+ */
 export declare class DriverLicenseV1 extends Inference {
+    /** The endpoint's name. */
     endpointName: string;
+    /** The endpoint's version. */
     endpointVersion: string;
+    /** The document-level prediction. */
     prediction: DriverLicenseV1Document;
+    /** The document's pages. */
     pages: Page<DriverLicenseV1Page>[];
     constructor(rawPrediction: StringDict);
 }

package/src/product/us/driverLicense/driverLicenseV1.js

@@ -4,11 +4,17 @@ exports.DriverLicenseV1 = void 0;
 const common_1 = require("../../../parsing/common");
 const driverLicenseV1Document_1 = require("./driverLicenseV1Document");
 const driverLicenseV1Page_1 = require("./driverLicenseV1Page");
+/**
+ * Inference prediction for Driver License, API version 1.
+ */
 class DriverLicenseV1 extends common_1.Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
+        /** The endpoint's name. */
         this.endpointName = "us_driver_license";
+        /** The endpoint's version. */
         this.endpointVersion = "1";
+        /** The document's pages. */
         this.pages = [];
         this.prediction = new driverLicenseV1Document_1.DriverLicenseV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].map((page) => new common_1.Page(driverLicenseV1Page_1.DriverLicenseV1Page, page, page["id"], page["orientation"]));

package/src/product/us/driverLicense/driverLicenseV1Document.d.ts

@@ -39,5 +39,8 @@ export declare class DriverLicenseV1Document implements Prediction {
     /** US driver license holders weight */
     weight: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
     toString(): string;
 }

package/src/product/us/driverLicense/driverLicenseV1Document.js

@@ -77,6 +77,9 @@ class DriverLicenseV1Document {
             pageId: pageId,
         });
     }
+    /**
+     * Default string representation.
+     */
     toString() {
         const outStr = `:State: ${this.state}
 :Driver License ID: ${this.driverLicenseId}