mindee 5.8.0 → 5.10.0

package/src/v1/product/invoiceSplitter/invoiceSplitterV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document.js";
 /**
  * Invoice Splitter API version 1 inference prediction.
@@ -6,11 +6,17 @@ import { InvoiceSplitterV1Document } from "./invoiceSplitterV1Document.js";
 export class InvoiceSplitterV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "invoice_splitter";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new InvoiceSplitterV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/invoiceSplitter/invoiceSplitterV1Document.d.ts

@@ -1,10 +1,12 @@
-import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
+import { Prediction, StringDict } from "../../parsing/common/index.js";
 import { InvoiceSplitterV1InvoicePageGroup } from "./invoiceSplitterV1InvoicePageGroup.js";
 /**
  * Invoice Splitter API version 1.4 document data.
  */
 export declare class InvoiceSplitterV1Document implements Prediction {
-    /** List of page groups. Each group represents a single invoice within a multi-invoice document. */
+    /**
+     * List of page groups. Each group represents a single invoice within a multi-invoice document.
+     */
     invoicePageGroups: InvoiceSplitterV1InvoicePageGroup[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/invoiceSplitter/invoiceSplitterV1Document.js

@@ -1,11 +1,13 @@
-import { cleanOutString, lineSeparator, } from "../../../v1/parsing/common/index.js";
+import { cleanOutString, lineSeparator, } from "../../parsing/common/index.js";
 import { InvoiceSplitterV1InvoicePageGroup } from "./invoiceSplitterV1InvoicePageGroup.js";
 /**
  * Invoice Splitter API version 1.4 document data.
  */
 export class InvoiceSplitterV1Document {
     constructor(rawPrediction, pageId) {
-        /** List of page groups. Each group represents a single invoice within a multi-invoice document. */
+        /**
+         * List of page groups. Each group represents a single invoice within a multi-invoice document.
+         */
         this.invoicePageGroups = [];
         if (rawPrediction["invoice_page_groups"]) {
             rawPrediction["invoice_page_groups"].map((itemPrediction) => this.invoicePageGroups.push(new InvoiceSplitterV1InvoicePageGroup({

package/src/v1/product/invoiceSplitter/invoiceSplitterV1InvoicePageGroup.d.ts

@@ -5,11 +5,17 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class InvoiceSplitterV1InvoicePageGroup {
     #private;
-    /** List of page indexes that belong to the same invoice (group). */
+    /**
+     * List of page indexes that belong to the same invoice (group).
+     */
     pageIndexes: Array<number> | null;
-    /** Confidence score */
+    /**
+     * Confidence score
+     */
     confidence: number;
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId: number;
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/invoiceSplitter/invoiceSplitterV1InvoicePageGroup.js

@@ -11,7 +11,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class InvoiceSplitterV1InvoicePageGroup {
     constructor({ prediction = {} }) {
         _InvoiceSplitterV1InvoicePageGroup_instances.add(this);
-        /** Confidence score */
+        /**
+         * Confidence score
+         */
         this.confidence = 0.0;
         /**
          * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1.d.ts

@@ -1,16 +1,24 @@
-import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, StringDict, Page } from "../../parsing/common/index.js";
 import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Document.js";
 /**
  * Multi Receipts Detector API version 1 inference prediction.
  */
 export declare class MultiReceiptsDetectorV1 extends Inference {
-    /** The endpoint's name. */
+    /**
+     * The endpoint's name.
+     */
     endpointName: string;
-    /** The endpoint's version. */
+    /**
+     * The endpoint's version.
+     */
     endpointVersion: string;
-    /** The document-level prediction. */
+    /**
+     * The document-level prediction.
+     */
     prediction: MultiReceiptsDetectorV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<MultiReceiptsDetectorV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Document.js";
 /**
  * Multi Receipts Detector API version 1 inference prediction.
@@ -6,11 +6,17 @@ import { MultiReceiptsDetectorV1Document } from "./multiReceiptsDetectorV1Docume
 export class MultiReceiptsDetectorV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "multi_receipts_detector";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new MultiReceiptsDetectorV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.d.ts

@@ -1,10 +1,12 @@
-import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
-import { PositionField } from "../../../v1/parsing/standard/index.js";
+import { Prediction, StringDict } from "../../parsing/common/index.js";
+import { PositionField } from "../../parsing/standard/index.js";
 /**
  * Multi Receipts Detector API version 1.1 document data.
  */
 export declare class MultiReceiptsDetectorV1Document implements Prediction {
-    /** Positions of the receipts on the document. */
+    /**
+     * Positions of the receipts on the document.
+     */
     receipts: PositionField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.js

@@ -1,11 +1,13 @@
-import { cleanOutString, } from "../../../v1/parsing/common/index.js";
-import { PositionField } from "../../../v1/parsing/standard/index.js";
+import { cleanOutString, } from "../../parsing/common/index.js";
+import { PositionField } from "../../parsing/standard/index.js";
 /**
  * Multi Receipts Detector API version 1.1 document data.
  */
 export class MultiReceiptsDetectorV1Document {
     constructor(rawPrediction, pageId) {
-        /** Positions of the receipts on the document. */
+        /**
+         * Positions of the receipts on the document.
+         */
         this.receipts = [];
         if (rawPrediction["receipts"]) {
             rawPrediction["receipts"].map((itemPrediction) => this.receipts.push(new PositionField({

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

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

package/src/v1/product/passport/passportV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { PassportV1Document } from "./passportV1Document.js";
 /**
  * Passport API version 1 inference prediction.
@@ -6,11 +6,17 @@ import { PassportV1Document } from "./passportV1Document.js";
 export class PassportV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "passport";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new PassportV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

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

@@ -1,30 +1,52 @@
-import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
-import { DateField, StringField } from "../../../v1/parsing/standard/index.js";
+import { Prediction, StringDict } from "../../parsing/common/index.js";
+import { DateField, StringField } from "../../parsing/standard/index.js";
 /**
  * Passport API version 1.1 document data.
  */
 export declare class PassportV1Document implements Prediction {
-    /** The date of birth of the passport holder. */
+    /**
+     * The date of birth of the passport holder.
+     */
     birthDate: DateField;
-    /** The place of birth of the passport holder. */
+    /**
+     * The place of birth of the passport holder.
+     */
     birthPlace: StringField;
-    /** The country's 3 letter code (ISO 3166-1 alpha-3). */
+    /**
+     * The country's 3 letter code (ISO 3166-1 alpha-3).
+     */
     country: StringField;
-    /** The expiry date of the passport. */
+    /**
+     * The expiry date of the passport.
+     */
     expiryDate: DateField;
-    /** The gender of the passport holder. */
+    /**
+     * The gender of the passport holder.
+     */
     gender: StringField;
-    /** The given name(s) of the passport holder. */
+    /**
+     * The given name(s) of the passport holder.
+     */
     givenNames: StringField[];
-    /** The passport's identification number. */
+    /**
+     * The passport's identification number.
+     */
     idNumber: StringField;
-    /** The date the passport was issued. */
+    /**
+     * The date the passport was issued.
+     */
     issuanceDate: DateField;
-    /** Machine Readable Zone, first line */
+    /**
+     * Machine Readable Zone, first line
+     */
     mrz1: StringField;
-    /** Machine Readable Zone, second line */
+    /**
+     * Machine Readable Zone, second line
+     */
     mrz2: StringField;
-    /** The surname of the passport holder. */
+    /**
+     * The surname of the passport holder.
+     */
     surname: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/passport/passportV1Document.js

@@ -1,11 +1,13 @@
-import { cleanOutString, } from "../../../v1/parsing/common/index.js";
-import { DateField, StringField } from "../../../v1/parsing/standard/index.js";
+import { cleanOutString, } from "../../parsing/common/index.js";
+import { DateField, StringField } from "../../parsing/standard/index.js";
 /**
  * Passport API version 1.1 document data.
  */
 export class PassportV1Document {
     constructor(rawPrediction, pageId) {
-        /** The given name(s) of the passport holder. */
+        /**
+         * The given name(s) of the passport holder.
+         */
         this.givenNames = [];
         this.birthDate = new DateField({
             prediction: rawPrediction["birth_date"],

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

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

package/src/v1/product/receipt/receiptV5.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { ReceiptV5Document } from "./receiptV5Document.js";
 /**
  * Receipt API version 5 inference prediction.
@@ -6,11 +6,17 @@ import { ReceiptV5Document } from "./receiptV5Document.js";
 export class ReceiptV5 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "expense_receipts";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "5";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new ReceiptV5Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

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

@@ -1,43 +1,77 @@
-import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
+import { Prediction, StringDict } from "../../parsing/common/index.js";
 import { ReceiptV5LineItem } from "./receiptV5LineItem.js";
-import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, StringField, Taxes } from "../../../v1/parsing/standard/index.js";
+import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, StringField, Taxes } from "../../parsing/standard/index.js";
 /**
  * Receipt API version 5.4 document data.
  */
 export declare class ReceiptV5Document implements Prediction {
-    /** The purchase category of the receipt. */
+    /**
+     * The purchase category of the receipt.
+     */
     category: ClassificationField;
-    /** The date the purchase was made. */
+    /**
+     * The date the purchase was made.
+     */
     date: DateField;
-    /** The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT. */
+    /**
+     * The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
+     */
     documentType: ClassificationField;
-    /** List of all line items on the receipt. */
+    /**
+     * List of all line items on the receipt.
+     */
     lineItems: ReceiptV5LineItem[];
-    /** The locale of the document. */
+    /**
+     * The locale of the document.
+     */
     locale: LocaleField;
-    /** The receipt number or identifier. */
+    /**
+     * The receipt number or identifier.
+     */
     receiptNumber: StringField;
-    /** The purchase subcategory of the receipt for transport and food. */
+    /**
+     * The purchase subcategory of the receipt for transport and food.
+     */
     subcategory: ClassificationField;
-    /** The address of the supplier or merchant. */
+    /**
+     * The address of the supplier or merchant.
+     */
     supplierAddress: StringField;
-    /** List of company registration numbers associated to the supplier. */
+    /**
+     * List of company registration numbers associated to the supplier.
+     */
     supplierCompanyRegistrations: CompanyRegistrationField[];
-    /** The name of the supplier or merchant. */
+    /**
+     * The name of the supplier or merchant.
+     */
     supplierName: StringField;
-    /** The phone number of the supplier or merchant. */
+    /**
+     * The phone number of the supplier or merchant.
+     */
     supplierPhoneNumber: StringField;
-    /** The list of taxes present on the receipt. */
+    /**
+     * The list of taxes present on the receipt.
+     */
     taxes: Taxes;
-    /** The time the purchase was made. */
+    /**
+     * The time the purchase was made.
+     */
     time: StringField;
-    /** The total amount of tip and gratuity. */
+    /**
+     * The total amount of tip and gratuity.
+     */
     tip: AmountField;
-    /** The total amount paid: includes taxes, discounts, fees, tips, and gratuity. */
+    /**
+     * The total amount paid: includes taxes, discounts, fees, tips, and gratuity.
+     */
     totalAmount: AmountField;
-    /** The net amount paid: does not include taxes, fees, and discounts. */
+    /**
+     * The net amount paid: does not include taxes, fees, and discounts.
+     */
     totalNet: AmountField;
-    /** The sum of all taxes. */
+    /**
+     * The sum of all taxes.
+     */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/receipt/receiptV5Document.js

@@ -1,14 +1,18 @@
-import { cleanOutString, lineSeparator, } from "../../../v1/parsing/common/index.js";
+import { cleanOutString, lineSeparator, } from "../../parsing/common/index.js";
 import { ReceiptV5LineItem } from "./receiptV5LineItem.js";
-import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, StringField, Taxes, } from "../../../v1/parsing/standard/index.js";
+import { AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, StringField, Taxes, } from "../../parsing/standard/index.js";
 /**
  * Receipt API version 5.4 document data.
  */
 export class ReceiptV5Document {
     constructor(rawPrediction, pageId) {
-        /** List of all line items on the receipt. */
+        /**
+         * List of all line items on the receipt.
+         */
         this.lineItems = [];
-        /** List of company registration numbers associated to the supplier. */
+        /**
+         * List of company registration numbers associated to the supplier.
+         */
         this.supplierCompanyRegistrations = [];
         this.category = new ClassificationField({
             prediction: rawPrediction["category"],

package/src/v1/product/receipt/receiptV5LineItem.d.ts

@@ -5,17 +5,29 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class ReceiptV5LineItem {
     #private;
-    /** The item description. */
+    /**
+     * The item description.
+     */
     description: string | null;
-    /** The item quantity. */
+    /**
+     * The item quantity.
+     */
     quantity: number | null;
-    /** The item total amount. */
+    /**
+     * The item total amount.
+     */
     totalAmount: number | null;
-    /** The item unit price. */
+    /**
+     * The item unit price.
+     */
     unitPrice: number | null;
-    /** Confidence score */
+    /**
+     * Confidence score
+     */
     confidence: number;
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId: number;
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/receipt/receiptV5LineItem.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ReceiptV5LineItem_instances, _ReceiptV5LineItem_printableValues;
-import { cleanAndTruncate, floatToString } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate, floatToString } from "../../parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * List of all line items on the receipt.
@@ -12,7 +12,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class ReceiptV5LineItem {
     constructor({ prediction = {} }) {
         _ReceiptV5LineItem_instances.add(this);
-        /** Confidence score */
+        /**
+         * Confidence score
+         */
         this.confidence = 0.0;
         /**
          * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/resume/resumeV1.d.ts

@@ -1,16 +1,24 @@
-import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, StringDict, Page } from "../../parsing/common/index.js";
 import { ResumeV1Document } from "./resumeV1Document.js";
 /**
  * Resume API version 1 inference prediction.
  */
 export declare class ResumeV1 extends Inference {
-    /** The endpoint's name. */
+    /**
+     * The endpoint's name.
+     */
     endpointName: string;
-    /** The endpoint's version. */
+    /**
+     * The endpoint's version.
+     */
     endpointVersion: string;
-    /** The document-level prediction. */
+    /**
+     * The document-level prediction.
+     */
     prediction: ResumeV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<ResumeV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/resume/resumeV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../parsing/common/index.js";
 import { ResumeV1Document } from "./resumeV1Document.js";
 /**
  * Resume API version 1 inference prediction.
@@ -6,11 +6,17 @@ import { ResumeV1Document } from "./resumeV1Document.js";
 export class ResumeV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "resume";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new ResumeV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {