mindee 4.36.3 → 5.0.0-alpha2

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

@@ -0,0 +1,135 @@
+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 _ResumeV1ProfessionalExperience_instances, _ResumeV1ProfessionalExperience_printableValues;
+import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { Polygon } from "../../../geometry/index.js";
+/**
+ * The list of the candidate's professional experiences.
+ */
+export class ResumeV1ProfessionalExperience {
+    constructor({ prediction = {} }) {
+        _ResumeV1ProfessionalExperience_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 = new Polygon();
+        this.contractType = prediction["contract_type"];
+        this.department = prediction["department"];
+        this.description = prediction["description"];
+        this.employer = prediction["employer"];
+        this.endMonth = prediction["end_month"];
+        this.endYear = prediction["end_year"];
+        this.role = prediction["role"];
+        this.startMonth = prediction["start_month"];
+        this.startYear = prediction["start_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, _ResumeV1ProfessionalExperience_instances, "m", _ResumeV1ProfessionalExperience_printableValues).call(this);
+        return ("Contract Type: " +
+            printable.contractType +
+            ", Department: " +
+            printable.department +
+            ", Description: " +
+            printable.description +
+            ", Employer: " +
+            printable.employer +
+            ", End Month: " +
+            printable.endMonth +
+            ", End Year: " +
+            printable.endYear +
+            ", Role: " +
+            printable.role +
+            ", Start Month: " +
+            printable.startMonth +
+            ", Start Year: " +
+            printable.startYear);
+    }
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine() {
+        const printable = __classPrivateFieldGet(this, _ResumeV1ProfessionalExperience_instances, "m", _ResumeV1ProfessionalExperience_printableValues).call(this);
+        return ("| " +
+            printable.contractType.padEnd(15) +
+            " | " +
+            printable.department.padEnd(10) +
+            " | " +
+            printable.description.padEnd(36) +
+            " | " +
+            printable.employer.padEnd(25) +
+            " | " +
+            printable.endMonth.padEnd(9) +
+            " | " +
+            printable.endYear.padEnd(8) +
+            " | " +
+            printable.role.padEnd(20) +
+            " | " +
+            printable.startMonth.padEnd(11) +
+            " | " +
+            printable.startYear.padEnd(10) +
+            " |");
+    }
+}
+_ResumeV1ProfessionalExperience_instances = new WeakSet(), _ResumeV1ProfessionalExperience_printableValues = function _ResumeV1ProfessionalExperience_printableValues() {
+    return {
+        contractType: this.contractType ?
+            this.contractType.length <= 15 ?
+                cleanSpecialChars(this.contractType) :
+                cleanSpecialChars(this.contractType).slice(0, 12) + "..." :
+            "",
+        department: this.department ?
+            this.department.length <= 10 ?
+                cleanSpecialChars(this.department) :
+                cleanSpecialChars(this.department).slice(0, 7) + "..." :
+            "",
+        description: this.description ?
+            this.description.length <= 36 ?
+                cleanSpecialChars(this.description) :
+                cleanSpecialChars(this.description).slice(0, 33) + "..." :
+            "",
+        employer: this.employer ?
+            this.employer.length <= 25 ?
+                cleanSpecialChars(this.employer) :
+                cleanSpecialChars(this.employer).slice(0, 22) + "..." :
+            "",
+        endMonth: this.endMonth ?
+            this.endMonth.length <= 9 ?
+                cleanSpecialChars(this.endMonth) :
+                cleanSpecialChars(this.endMonth).slice(0, 6) + "..." :
+            "",
+        endYear: this.endYear ?
+            this.endYear.length <= 8 ?
+                cleanSpecialChars(this.endYear) :
+                cleanSpecialChars(this.endYear).slice(0, 5) + "..." :
+            "",
+        role: this.role ?
+            this.role.length <= 20 ?
+                cleanSpecialChars(this.role) :
+                cleanSpecialChars(this.role).slice(0, 17) + "..." :
+            "",
+        startMonth: this.startMonth ?
+            this.startMonth.length <= 11 ?
+                cleanSpecialChars(this.startMonth) :
+                cleanSpecialChars(this.startMonth).slice(0, 8) + "..." :
+            "",
+        startYear: this.startYear ?
+            this.startYear.length <= 10 ?
+                cleanSpecialChars(this.startYear) :
+                cleanSpecialChars(this.startYear).slice(0, 7) + "..." :
+            "",
+    };
+};

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

@@ -0,0 +1,30 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { Polygon } from "../../../geometry/index.js";
+/**
+ * The list of social network profiles of the candidate.
+ */
+export declare class ResumeV1SocialNetworksUrl {
+    #private;
+    /** The name of the social network. */
+    name: string | null;
+    /** The URL of the social network. */
+    url: string | null;
+    /** 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/v1/product/resume/resumeV1SocialNetworksUrl.js

@@ -0,0 +1,65 @@
+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 _ResumeV1SocialNetworksUrl_instances, _ResumeV1SocialNetworksUrl_printableValues;
+import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { Polygon } from "../../../geometry/index.js";
+/**
+ * The list of social network profiles of the candidate.
+ */
+export class ResumeV1SocialNetworksUrl {
+    constructor({ prediction = {} }) {
+        _ResumeV1SocialNetworksUrl_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 = new Polygon();
+        this.name = prediction["name"];
+        this.url = prediction["url"];
+        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, _ResumeV1SocialNetworksUrl_instances, "m", _ResumeV1SocialNetworksUrl_printableValues).call(this);
+        return ("Name: " +
+            printable.name +
+            ", URL: " +
+            printable.url);
+    }
+    /**
+     * Output in a format suitable for inclusion in an rST table.
+     */
+    toTableLine() {
+        const printable = __classPrivateFieldGet(this, _ResumeV1SocialNetworksUrl_instances, "m", _ResumeV1SocialNetworksUrl_printableValues).call(this);
+        return ("| " +
+            printable.name.padEnd(20) +
+            " | " +
+            printable.url.padEnd(50) +
+            " |");
+    }
+}
+_ResumeV1SocialNetworksUrl_instances = new WeakSet(), _ResumeV1SocialNetworksUrl_printableValues = function _ResumeV1SocialNetworksUrl_printableValues() {
+    return {
+        name: this.name ?
+            this.name.length <= 20 ?
+                cleanSpecialChars(this.name) :
+                cleanSpecialChars(this.name).slice(0, 17) + "..." :
+            "",
+        url: this.url ?
+            this.url.length <= 50 ?
+                cleanSpecialChars(this.url) :
+                cleanSpecialChars(this.url).slice(0, 47) + "..." :
+            "",
+    };
+};

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

@@ -0,0 +1,17 @@
+import { Inference, StringDict, Page } from "../../../../v1/parsing/common/index.js";
+import { BankCheckV1Document } from "./bankCheckV1Document.js";
+import { BankCheckV1Page } from "./bankCheckV1Page.js";
+/**
+ * Bank Check API version 1 inference prediction.
+ */
+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/v1/product/us/bankCheck/bankCheckV1.js

@@ -0,0 +1,24 @@
+import { Inference, Page } from "../../../../v1/parsing/common/index.js";
+import { BankCheckV1Document } from "./bankCheckV1Document.js";
+import { BankCheckV1Page } from "./bankCheckV1Page.js";
+/**
+ * Bank Check API version 1 inference prediction.
+ */
+export class BankCheckV1 extends 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(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new Page(BankCheckV1Page, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}

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

@@ -0,0 +1,24 @@
+import { Prediction, StringDict } from "../../../../v1/parsing/common/index.js";
+import { AmountField, DateField, StringField } from "../../../../v1/parsing/standard/index.js";
+/**
+ * Bank Check API version 1.1 document data.
+ */
+export declare class BankCheckV1Document implements Prediction {
+    /** The check payer's account number. */
+    accountNumber: StringField;
+    /** The amount of the check. */
+    amount: AmountField;
+    /** The issuer's check number. */
+    checkNumber: StringField;
+    /** The date the check was issued. */
+    date: DateField;
+    /** List of the check's payees (recipients). */
+    payees: StringField[];
+    /** The check issuer's routing number. */
+    routingNumber: StringField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

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

@@ -0,0 +1,50 @@
+import { cleanOutString, } from "../../../../v1/parsing/common/index.js";
+import { AmountField, DateField, StringField, } from "../../../../v1/parsing/standard/index.js";
+/**
+ * Bank Check API version 1.1 document data.
+ */
+export class BankCheckV1Document {
+    constructor(rawPrediction, pageId) {
+        /** List of the check's payees (recipients). */
+        this.payees = [];
+        this.accountNumber = new StringField({
+            prediction: rawPrediction["account_number"],
+            pageId: pageId,
+        });
+        this.amount = new AmountField({
+            prediction: rawPrediction["amount"],
+            pageId: pageId,
+        });
+        this.checkNumber = new StringField({
+            prediction: rawPrediction["check_number"],
+            pageId: pageId,
+        });
+        this.date = new DateField({
+            prediction: rawPrediction["date"],
+            pageId: pageId,
+        });
+        if (rawPrediction["payees"]) {
+            rawPrediction["payees"].map((itemPrediction) => this.payees.push(new StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        }
+        this.routingNumber = new StringField({
+            prediction: rawPrediction["routing_number"],
+            pageId: pageId,
+        });
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const payees = this.payees.join("\n         ");
+        const outStr = `:Check Issue Date: ${this.date}
+:Amount: ${this.amount}
+:Payees: ${payees}
+:Routing Number: ${this.routingNumber}
+:Account Number: ${this.accountNumber}
+:Check Number: ${this.checkNumber}`.trimEnd();
+        return cleanOutString(outStr);
+    }
+}

package/src/v1/product/us/bankCheck/bankCheckV1Page.d.ts

@@ -0,0 +1,14 @@
+import { StringDict } from "../../../../v1/parsing/common/index.js";
+import { PositionField } from "../../../../v1/parsing/standard/index.js";
+import { BankCheckV1Document } from "./bankCheckV1Document.js";
+/**
+ * Bank Check API version 1.1 page data.
+ */
+export declare class BankCheckV1Page extends BankCheckV1Document {
+    /** The position of the check on the document. */
+    checkPosition: PositionField;
+    /** List of signature positions */
+    signaturesPositions: PositionField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    toString(): string;
+}

package/src/v1/product/us/bankCheck/bankCheckV1Page.js

@@ -0,0 +1,28 @@
+import { cleanOutString } from "../../../../v1/parsing/common/index.js";
+import { PositionField } from "../../../../v1/parsing/standard/index.js";
+import { BankCheckV1Document } from "./bankCheckV1Document.js";
+/**
+ * Bank Check API version 1.1 page data.
+ */
+export class BankCheckV1Page extends BankCheckV1Document {
+    constructor(rawPrediction, pageId) {
+        super(rawPrediction, pageId);
+        /** List of signature positions */
+        this.signaturesPositions = [];
+        this.checkPosition = new PositionField({
+            prediction: rawPrediction["check_position"],
+            pageId: pageId,
+        });
+        rawPrediction["signatures_positions"].map((itemPrediction) => this.signaturesPositions.push(new PositionField({
+            prediction: itemPrediction,
+            pageId: pageId,
+        })));
+    }
+    toString() {
+        const signaturesPositions = this.signaturesPositions.join("\n                      ");
+        let outStr = `:Check Position: ${this.checkPosition}
+:Signature Positions: ${signaturesPositions}`.trimEnd();
+        outStr += "\n" + super.toString();
+        return cleanOutString(outStr);
+    }
+}

package/src/v1/product/us/bankCheck/index.d.ts

@@ -0,0 +1,3 @@
+export { BankCheckV1 } from "./bankCheckV1.js";
+export { BankCheckV1Document } from "./bankCheckV1Document.js";
+export { BankCheckV1Page } from "./bankCheckV1Page.js";

package/src/v1/product/us/bankCheck/index.js

@@ -0,0 +1,3 @@
+export { BankCheckV1 } from "./bankCheckV1.js";
+export { BankCheckV1Document } from "./bankCheckV1Document.js";
+export { BankCheckV1Page } from "./bankCheckV1Page.js";

package/src/v1/product/us/index.d.ts

@@ -0,0 +1,2 @@
+export { BankCheckV1 } from "./bankCheck/index.js";
+export * as bankCheck from "./bankCheck/index.js";

package/src/v1/product/us/index.js

@@ -0,0 +1,2 @@
+export { BankCheckV1 } from "./bankCheck/index.js";
+export * as bankCheck from "./bankCheck/index.js";

package/src/v2/cli.d.ts

@@ -0,0 +1 @@
+export declare function cli(): void;

package/src/v2/cli.js

@@ -0,0 +1,66 @@
+import { Command } from "commander";
+import { Client } from "./client.js";
+import { PathInput } from "../input/index.js";
+import * as console from "console";
+import { Classification, Crop, Extraction, Ocr, Split, } from "../v2/product/index.js";
+const program = new Command();
+//
+// EXECUTE THE COMMANDS
+//
+function initClient(options) {
+    return new Client({
+        apiKey: options.apiKey,
+        debug: options.debug,
+    });
+}
+async function enqueueAndGetInference(product, inputPath, options) {
+    const mindeeClient = initClient(options);
+    const inputSource = new PathInput({ inputPath: inputPath });
+    const response = await mindeeClient.enqueueAndGetResult(product, inputSource, {
+        modelId: options.model,
+        pollingOptions: {
+            initialDelaySec: 2,
+            delaySec: 1.5,
+            maxRetries: 80,
+        }
+    });
+    if (!response.inference) {
+        throw Error("Inference could not be retrieved");
+    }
+    printResponse(response.inference);
+}
+function printResponse(document) {
+    if (document) {
+        console.log(`\n${document}`);
+    }
+}
+//
+// BUILD THE COMMANDS
+//
+function addMainOptions(prog) {
+    prog.requiredOption("-m, --model <model_id>", "Model ID (required)");
+    prog.argument("<input_path>", "full path to the file");
+}
+export function cli() {
+    program.name("mindee")
+        .description("Command line interface for Mindee V2 products.")
+        .option("-d, --debug", "high verbosity mode")
+        .option("-k, --api-key <api_key>", "your Mindee API key");
+    const inferenceTypes = [
+        { name: "extraction", description: "Extract data from a document.", product: Extraction },
+        { name: "crop", description: "Crop a document.", product: Crop },
+        { name: "split", description: "Split a document into pages.", product: Split },
+        { name: "ocr", description: "Read text from a document.", product: Ocr },
+        { name: "classification", description: "Classify a document.", product: Classification },
+    ];
+    for (const inference of inferenceTypes) {
+        const inferenceCmd = program.command(inference.name)
+            .description(inference.description);
+        addMainOptions(inferenceCmd);
+        inferenceCmd.action(function (inputPath, options) {
+            const allOptions = { ...program.opts(), ...options };
+            return enqueueAndGetInference(inference.product, inputPath, allOptions);
+        });
+    }
+    program.parse(process.argv);
+}

package/src/v2/client/baseParameters.d.ts

@@ -0,0 +1,66 @@
+import { ValidatedPollingOptions } from "../../v2/client/pollingOptions.js";
+import { PollingOptions } from "../../v2/index.js";
+/**
+ * Constructor parameters for BaseParameters and its subclasses.
+ */
+export interface BaseParametersConstructor {
+    modelId: string;
+    alias?: string;
+    webhookIds?: string[];
+    pollingOptions?: PollingOptions;
+    closeFile?: boolean;
+}
+/**
+ * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ *
+ * All fields are optional except `modelId`.
+ *
+ * @category ClientV2
+ * @example
+ * const params = {
+ *   modelId: "YOUR_MODEL_ID",
+ *   rag: true,
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export declare abstract class BaseParameters {
+    /**
+     * Model ID to use for the inference. **Required.**
+     */
+    modelId: string;
+    /**
+     * Use an alias to link the file to your own DB.
+     * If empty, no alias will be used.
+     */
+    alias?: string;
+    /**
+     * Webhook IDs to call after all processing is finished.
+     * If empty, no webhooks will be used.
+     */
+    webhookIds?: string[];
+    /**
+     * Client-side polling configuration (see {@link PollingOptions}).
+     */
+    pollingOptions?: PollingOptions;
+    /**
+     * By default, the file is closed once the upload is finished.
+     * Set to `false` to keep it open.
+     */
+    closeFile?: boolean;
+    protected constructor(params: BaseParametersConstructor);
+    /**
+     * Checks the values for asynchronous parsing. Returns their corrected value if they are undefined.
+     * @returns A valid `AsyncOptions`.
+     */
+    getValidatedPollingOptions(): ValidatedPollingOptions;
+    /**
+     * Returns the form data to send to the API.
+     * @returns A `FormData` object.
+     */
+    getFormData(): FormData;
+}

package/src/v2/client/baseParameters.js

@@ -0,0 +1,81 @@
+import { MindeeConfigurationError } from "../../errors/index.js";
+/**
+ * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ *
+ * All fields are optional except `modelId`.
+ *
+ * @category ClientV2
+ * @example
+ * const params = {
+ *   modelId: "YOUR_MODEL_ID",
+ *   rag: true,
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export class BaseParameters {
+    constructor(params) {
+        if (params.modelId === undefined || params.modelId === null || params.modelId === "") {
+            throw new MindeeConfigurationError("Model ID must be provided");
+        }
+        this.modelId = params.modelId;
+        this.alias = params.alias;
+        this.webhookIds = params.webhookIds;
+        this.closeFile = params.closeFile;
+        this.pollingOptions = params.pollingOptions;
+    }
+    /**
+     * Checks the values for asynchronous parsing. Returns their corrected value if they are undefined.
+     * @returns A valid `AsyncOptions`.
+     */
+    getValidatedPollingOptions() {
+        const minDelaySec = 1;
+        const minInitialDelay = 1;
+        const minRetries = 2;
+        let newAsyncParams;
+        if (this.pollingOptions === undefined) {
+            newAsyncParams = {
+                delaySec: 1.5,
+                initialDelaySec: 2,
+                maxRetries: 80
+            };
+        }
+        else {
+            newAsyncParams = { ...this.pollingOptions };
+            if (!newAsyncParams.delaySec ||
+                !newAsyncParams.initialDelaySec ||
+                !newAsyncParams.maxRetries) {
+                throw Error("Invalid polling options.");
+            }
+            if (newAsyncParams.delaySec < minDelaySec) {
+                throw Error(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
+            }
+            if (newAsyncParams.initialDelaySec < minInitialDelay) {
+                throw Error(`Cannot set initial parsing delay to less than ${minInitialDelay} second(s).`);
+            }
+            if (newAsyncParams.maxRetries < minRetries) {
+                throw Error(`Cannot set retry to less than ${minRetries}.`);
+            }
+        }
+        return newAsyncParams;
+    }
+    /**
+     * Returns the form data to send to the API.
+     * @returns A `FormData` object.
+     */
+    getFormData() {
+        const form = new FormData();
+        form.set("model_id", this.modelId);
+        if (this.alias !== undefined && this.alias !== null) {
+            form.set("alias", this.alias);
+        }
+        if (this.webhookIds && this.webhookIds.length > 0) {
+            form.set("webhook_ids", this.webhookIds.join(","));
+        }
+        return form;
+    }
+}

package/src/v2/client/index.d.ts

@@ -0,0 +1,2 @@
+export type { PollingOptions, ValidatedPollingOptions } from "./pollingOptions.js";
+export { BaseParameters } from "./baseParameters.js";

package/src/v2/client/index.js

@@ -0,0 +1 @@
+export { BaseParameters } from "./baseParameters.js";