mindee 4.8.2 → 4.9.1

package/src/product/internationalId/internationalIdV2Document.d.ts

@@ -0,0 +1,46 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { ClassificationField, DateField, StringField } from "../../parsing/standard";
+/**
+ * Document data for International ID, API version 2.
+ */
+export declare class InternationalIdV2Document implements Prediction {
+    /** The physical address of the document holder. */
+    address: StringField;
+    /** The date of birth of the document holder. */
+    birthDate: DateField;
+    /** The place of birth of the document holder. */
+    birthPlace: StringField;
+    /** The country where the document was issued. */
+    countryOfIssue: StringField;
+    /** The unique identifier assigned to the document. */
+    documentNumber: StringField;
+    /** The type of personal identification document. */
+    documentType: ClassificationField;
+    /** The date when the document becomes invalid. */
+    expiryDate: DateField;
+    /** The list of the document holder's given names. */
+    givenNames: StringField[];
+    /** The date when the document was issued. */
+    issueDate: DateField;
+    /** The Machine Readable Zone, first line. */
+    mrzLine1: StringField;
+    /** The Machine Readable Zone, second line. */
+    mrzLine2: StringField;
+    /** The Machine Readable Zone, third line. */
+    mrzLine3: StringField;
+    /** The country of citizenship of the document holder. */
+    nationality: StringField;
+    /** The unique identifier assigned to the document holder. */
+    personalNumber: StringField;
+    /** The biological sex of the document holder. */
+    sex: StringField;
+    /** The state or territory where the document was issued. */
+    stateOfIssue: StringField;
+    /** The list of the document holder's family names. */
+    surnames: StringField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/product/internationalId/internationalIdV2Document.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternationalIdV2Document = void 0;
+const common_1 = require("../../parsing/common");
+const standard_1 = require("../../parsing/standard");
+/**
+ * Document data for International ID, API version 2.
+ */
+class InternationalIdV2Document {
+    constructor(rawPrediction, pageId) {
+        /** The list of the document holder's given names. */
+        this.givenNames = [];
+        /** The list of the document holder's family names. */
+        this.surnames = [];
+        this.address = new standard_1.StringField({
+            prediction: rawPrediction["address"],
+            pageId: pageId,
+        });
+        this.birthDate = new standard_1.DateField({
+            prediction: rawPrediction["birth_date"],
+            pageId: pageId,
+        });
+        this.birthPlace = new standard_1.StringField({
+            prediction: rawPrediction["birth_place"],
+            pageId: pageId,
+        });
+        this.countryOfIssue = new standard_1.StringField({
+            prediction: rawPrediction["country_of_issue"],
+            pageId: pageId,
+        });
+        this.documentNumber = new standard_1.StringField({
+            prediction: rawPrediction["document_number"],
+            pageId: pageId,
+        });
+        this.documentType = new standard_1.ClassificationField({
+            prediction: rawPrediction["document_type"],
+        });
+        this.expiryDate = new standard_1.DateField({
+            prediction: rawPrediction["expiry_date"],
+            pageId: pageId,
+        });
+        rawPrediction["given_names"] &&
+            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        this.issueDate = new standard_1.DateField({
+            prediction: rawPrediction["issue_date"],
+            pageId: pageId,
+        });
+        this.mrzLine1 = new standard_1.StringField({
+            prediction: rawPrediction["mrz_line1"],
+            pageId: pageId,
+        });
+        this.mrzLine2 = new standard_1.StringField({
+            prediction: rawPrediction["mrz_line2"],
+            pageId: pageId,
+        });
+        this.mrzLine3 = new standard_1.StringField({
+            prediction: rawPrediction["mrz_line3"],
+            pageId: pageId,
+        });
+        this.nationality = new standard_1.StringField({
+            prediction: rawPrediction["nationality"],
+            pageId: pageId,
+        });
+        this.personalNumber = new standard_1.StringField({
+            prediction: rawPrediction["personal_number"],
+            pageId: pageId,
+        });
+        this.sex = new standard_1.StringField({
+            prediction: rawPrediction["sex"],
+            pageId: pageId,
+        });
+        this.stateOfIssue = new standard_1.StringField({
+            prediction: rawPrediction["state_of_issue"],
+            pageId: pageId,
+        });
+        rawPrediction["surnames"] &&
+            rawPrediction["surnames"].map((itemPrediction) => this.surnames.push(new standard_1.StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const surnames = this.surnames.join("\n           ");
+        const givenNames = this.givenNames.join("\n              ");
+        const outStr = `:Document Type: ${this.documentType}
+:Document Number: ${this.documentNumber}
+:Surnames: ${surnames}
+:Given Names: ${givenNames}
+:Sex: ${this.sex}
+:Birth Date: ${this.birthDate}
+:Birth Place: ${this.birthPlace}
+:Nationality: ${this.nationality}
+:Personal Number: ${this.personalNumber}
+:Country of Issue: ${this.countryOfIssue}
+:State of Issue: ${this.stateOfIssue}
+:Issue Date: ${this.issueDate}
+:Expiration Date: ${this.expiryDate}
+:Address: ${this.address}
+:MRZ Line 1: ${this.mrzLine1}
+:MRZ Line 2: ${this.mrzLine2}
+:MRZ Line 3: ${this.mrzLine3}`.trimEnd();
+        return (0, common_1.cleanOutString)(outStr);
+    }
+}
+exports.InternationalIdV2Document = InternationalIdV2Document;

package/src/product/invoice/invoiceV4.js

@@ -16,7 +16,12 @@ class InvoiceV4 extends common_1.Inference {
         /** The document's pages. */
         this.pages = [];
         this.prediction = new invoiceV4Document_1.InvoiceV4Document(rawPrediction["prediction"]);
-        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(invoiceV4Document_1.InvoiceV4Document, page, page["id"], page["orientation"]));
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(invoiceV4Document_1.InvoiceV4Document, page, page["id"], page["orientation"]));
+            }
+        });
     }
 }
 exports.InvoiceV4 = InvoiceV4;

package/src/product/multiReceiptsDetector/multiReceiptsDetectorV1.js

@@ -16,7 +16,12 @@ class MultiReceiptsDetectorV1 extends common_1.Inference {
         /** The document's pages. */
         this.pages = [];
         this.prediction = new multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document(rawPrediction["prediction"]);
-        this.pages = rawPrediction["pages"].map((page) => new common_1.Page(multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document, page, page["id"], page["orientation"]));
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(multiReceiptsDetectorV1Document_1.MultiReceiptsDetectorV1Document, page, page["id"], page["orientation"]));
+            }
+        });
     }
 }
 exports.MultiReceiptsDetectorV1 = MultiReceiptsDetectorV1;

package/src/product/passport/passportV1.js

@@ -16,7 +16,12 @@ class PassportV1 extends common_1.Inference {
         /** 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"]));
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(passportV1Document_1.PassportV1Document, page, page["id"], page["orientation"]));
+            }
+        });
     }
 }
 exports.PassportV1 = PassportV1;

package/src/product/proofOfAddress/proofOfAddressV1.js

@@ -16,7 +16,12 @@ class ProofOfAddressV1 extends common_1.Inference {
         /** 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"]));
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(proofOfAddressV1Document_1.ProofOfAddressV1Document, page, page["id"], page["orientation"]));
+            }
+        });
     }
 }
 exports.ProofOfAddressV1 = ProofOfAddressV1;

package/src/product/receipt/receiptV5.js

@@ -16,7 +16,12 @@ class ReceiptV5 extends common_1.Inference {
         /** 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"]));
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(receiptV5Document_1.ReceiptV5Document, page, page["id"], page["orientation"]));
+            }
+        });
     }
 }
 exports.ReceiptV5 = ReceiptV5;

package/src/product/resume/internal.d.ts

@@ -0,0 +1,7 @@
+export { ResumeV1 } from "./resumeV1";
+export { ResumeV1Document } from "./resumeV1Document";
+export { ResumeV1Certificate } from "./resumeV1Certificate";
+export { ResumeV1Education } from "./resumeV1Education";
+export { ResumeV1Language } from "./resumeV1Language";
+export { ResumeV1ProfessionalExperience } from "./resumeV1ProfessionalExperience";
+export { ResumeV1SocialNetworksUrl } from "./resumeV1SocialNetworksUrl";

package/src/product/resume/internal.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResumeV1SocialNetworksUrl = exports.ResumeV1ProfessionalExperience = exports.ResumeV1Language = exports.ResumeV1Education = exports.ResumeV1Certificate = exports.ResumeV1Document = exports.ResumeV1 = void 0;
+var resumeV1_1 = require("./resumeV1");
+Object.defineProperty(exports, "ResumeV1", { enumerable: true, get: function () { return resumeV1_1.ResumeV1; } });
+var resumeV1Document_1 = require("./resumeV1Document");
+Object.defineProperty(exports, "ResumeV1Document", { enumerable: true, get: function () { return resumeV1Document_1.ResumeV1Document; } });
+var resumeV1Certificate_1 = require("./resumeV1Certificate");
+Object.defineProperty(exports, "ResumeV1Certificate", { enumerable: true, get: function () { return resumeV1Certificate_1.ResumeV1Certificate; } });
+var resumeV1Education_1 = require("./resumeV1Education");
+Object.defineProperty(exports, "ResumeV1Education", { enumerable: true, get: function () { return resumeV1Education_1.ResumeV1Education; } });
+var resumeV1Language_1 = require("./resumeV1Language");
+Object.defineProperty(exports, "ResumeV1Language", { enumerable: true, get: function () { return resumeV1Language_1.ResumeV1Language; } });
+var resumeV1ProfessionalExperience_1 = require("./resumeV1ProfessionalExperience");
+Object.defineProperty(exports, "ResumeV1ProfessionalExperience", { enumerable: true, get: function () { return resumeV1ProfessionalExperience_1.ResumeV1ProfessionalExperience; } });
+var resumeV1SocialNetworksUrl_1 = require("./resumeV1SocialNetworksUrl");
+Object.defineProperty(exports, "ResumeV1SocialNetworksUrl", { enumerable: true, get: function () { return resumeV1SocialNetworksUrl_1.ResumeV1SocialNetworksUrl; } });

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

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

package/src/product/resume/resumeV1.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResumeV1 = void 0;
+const common_1 = require("../../parsing/common");
+const resumeV1Document_1 = require("./resumeV1Document");
+/**
+ * Inference prediction for Resume, API version 1.
+ */
+class ResumeV1 extends common_1.Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "resume";
+        /** The endpoint's version. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new resumeV1Document_1.ResumeV1Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new common_1.Page(resumeV1Document_1.ResumeV1Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}
+exports.ResumeV1 = ResumeV1;

package/src/product/resume/resumeV1Certificate.d.ts

@@ -0,0 +1,34 @@
+import { StringDict } from "../../parsing/common";
+import { Polygon } from "../../geometry";
+/**
+ * The list of certificates obtained by the candidate.
+ */
+export declare class ResumeV1Certificate {
+    #private;
+    /** The grade obtained for the certificate. */
+    grade: string | undefined;
+    /** The name of certification. */
+    name: string | undefined;
+    /** The organization or institution that issued the certificate. */
+    provider: string | undefined;
+    /** The year when a certificate was issued or received. */
+    year: string | undefined;
+    /** Confidence score */
+    confidence: number;
+    /** The document page on which the information was found. */
+    pageId: number;
+    /**
+     * Contains the relative vertices coordinates (points) of a polygon containing
+     * the field in the document.
+     */
+    polygon: Polygon;
+    constructor({ prediction }: StringDict);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine(): string;
+}

package/src/product/resume/resumeV1Certificate.js

@@ -0,0 +1,87 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ResumeV1Certificate_instances, _ResumeV1Certificate_printableValues;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResumeV1Certificate = void 0;
+/**
+ * The list of certificates obtained by the candidate.
+ */
+class ResumeV1Certificate {
+    constructor({ prediction = {} }) {
+        _ResumeV1Certificate_instances.add(this);
+        /** Confidence score */
+        this.confidence = 0.0;
+        /**
+         * Contains the relative vertices coordinates (points) of a polygon containing
+         * the field in the document.
+         */
+        this.polygon = [];
+        this.grade = prediction["grade"];
+        this.name = prediction["name"];
+        this.provider = prediction["provider"];
+        this.year = prediction["year"];
+        this.pageId = prediction["page_id"];
+        this.confidence = prediction["confidence"] ? prediction.confidence : 0.0;
+        if (prediction["polygon"]) {
+            this.polygon = prediction.polygon;
+        }
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const printable = __classPrivateFieldGet(this, _ResumeV1Certificate_instances, "m", _ResumeV1Certificate_printableValues).call(this);
+        return ("Grade: " +
+            printable.grade +
+            ", Name: " +
+            printable.name +
+            ", Provider: " +
+            printable.provider +
+            ", Year: " +
+            printable.year);
+    }
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine() {
+        const printable = __classPrivateFieldGet(this, _ResumeV1Certificate_instances, "m", _ResumeV1Certificate_printableValues).call(this);
+        return ("| " +
+            printable.grade.padEnd(10) +
+            " | " +
+            printable.name.padEnd(30) +
+            " | " +
+            printable.provider.padEnd(25) +
+            " | " +
+            printable.year.padEnd(4) +
+            " |");
+    }
+}
+exports.ResumeV1Certificate = ResumeV1Certificate;
+_ResumeV1Certificate_instances = new WeakSet(), _ResumeV1Certificate_printableValues = function _ResumeV1Certificate_printableValues() {
+    return {
+        grade: this.grade ?
+            this.grade.length <= 10 ?
+                this.grade :
+                this.grade.slice(0, 7) + "..." :
+            "",
+        name: this.name ?
+            this.name.length <= 30 ?
+                this.name :
+                this.name.slice(0, 27) + "..." :
+            "",
+        provider: this.provider ?
+            this.provider.length <= 25 ?
+                this.provider :
+                this.provider.slice(0, 22) + "..." :
+            "",
+        year: this.year ?
+            this.year.length <= 4 ?
+                this.year :
+                this.year.slice(0, 1) + "..." :
+            "",
+    };
+};

package/src/product/resume/resumeV1Document.d.ts

@@ -0,0 +1,51 @@
+import { Prediction, StringDict } from "../../parsing/common";
+import { ResumeV1SocialNetworksUrl } from "./resumeV1SocialNetworksUrl";
+import { ResumeV1Language } from "./resumeV1Language";
+import { ResumeV1Education } from "./resumeV1Education";
+import { ResumeV1ProfessionalExperience } from "./resumeV1ProfessionalExperience";
+import { ResumeV1Certificate } from "./resumeV1Certificate";
+import { ClassificationField, StringField } from "../../parsing/standard";
+/**
+ * Document data for Resume, API version 1.
+ */
+export declare class ResumeV1Document implements Prediction {
+    /** The location information of the candidate, including city, state, and country. */
+    address: StringField;
+    /** The list of certificates obtained by the candidate. */
+    certificates: ResumeV1Certificate[];
+    /** The ISO 639 code of the language in which the document is written. */
+    documentLanguage: StringField;
+    /** The type of the document sent. */
+    documentType: ClassificationField;
+    /** The list of the candidate's educational background. */
+    education: ResumeV1Education[];
+    /** The email address of the candidate. */
+    emailAddress: StringField;
+    /** The candidate's first or given names. */
+    givenNames: StringField[];
+    /** The list of the candidate's technical abilities and knowledge. */
+    hardSkills: StringField[];
+    /** The position that the candidate is applying for. */
+    jobApplied: StringField;
+    /** The list of languages that the candidate is proficient in. */
+    languages: ResumeV1Language[];
+    /** The ISO 3166 code for the country of citizenship of the candidate. */
+    nationality: StringField;
+    /** The phone number of the candidate. */
+    phoneNumber: StringField;
+    /** The candidate's current profession. */
+    profession: StringField;
+    /** The list of the candidate's professional experiences. */
+    professionalExperiences: ResumeV1ProfessionalExperience[];
+    /** The list of social network profiles of the candidate. */
+    socialNetworksUrls: ResumeV1SocialNetworksUrl[];
+    /** The list of the candidate's interpersonal and communication abilities. */
+    softSkills: StringField[];
+    /** The candidate's last names. */
+    surnames: StringField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}