mindee 4.36.3 → 5.0.0-alpha2

package/src/v2/product/ocr/index.d.ts

@@ -0,0 +1,7 @@
+export { Ocr } from "./ocr.js";
+export { OcrParameters } from "./params/index.js";
+export { OcrResponse } from "./ocrResponse.js";
+export { OcrInference } from "./ocrInference.js";
+export { OcrResult } from "./ocrResult.js";
+export { OcrPage } from "./ocrPage.js";
+export { OcrWord } from "./ocrWord.js";

package/src/v2/product/ocr/index.js

@@ -0,0 +1,7 @@
+export { Ocr } from "./ocr.js";
+export { OcrParameters } from "./params/index.js";
+export { OcrResponse } from "./ocrResponse.js";
+export { OcrInference } from "./ocrInference.js";
+export { OcrResult } from "./ocrResult.js";
+export { OcrPage } from "./ocrPage.js";
+export { OcrWord } from "./ocrWord.js";

package/src/v2/product/ocr/ocr.d.ts

@@ -0,0 +1,8 @@
+import { OcrResponse } from "./ocrResponse.js";
+import { OcrParameters } from "./params/index.js";
+import { BaseProduct } from "../../../v2/product/baseProduct.js";
+export declare class Ocr extends BaseProduct {
+    static get parametersClass(): typeof OcrParameters;
+    static get responseClass(): typeof OcrResponse;
+    static get slug(): string;
+}

package/src/v2/product/ocr/ocr.js

@@ -0,0 +1,14 @@
+import { OcrResponse } from "./ocrResponse.js";
+import { OcrParameters } from "./params/index.js";
+import { BaseProduct } from "../../../v2/product/baseProduct.js";
+export class Ocr extends BaseProduct {
+    static get parametersClass() {
+        return OcrParameters;
+    }
+    static get responseClass() {
+        return OcrResponse;
+    }
+    static get slug() {
+        return "ocr";
+    }
+}

package/src/v2/product/ocr/ocrInference.d.ts

@@ -0,0 +1,11 @@
+import { StringDict } from "../../../parsing/index.js";
+import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+import { OcrResult } from "../../../v2/product/ocr/ocrResult.js";
+export declare class OcrInference extends BaseInference {
+    /**
+     * Result of an OCR inference.
+     */
+    result: OcrResult;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/ocr/ocrInference.js

@@ -0,0 +1,15 @@
+import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+import { OcrResult } from "../../../v2/product/ocr/ocrResult.js";
+export class OcrInference extends BaseInference {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.result = new OcrResult(serverResponse["result"]);
+    }
+    toString() {
+        return ("Inference\n" +
+            "#########\n" +
+            this.model.toString() + "\n" +
+            this.file.toString() + "\n" +
+            this.result.toString() + "\n");
+    }
+}

package/src/v2/product/ocr/ocrPage.d.ts

@@ -0,0 +1,14 @@
+import { OcrWord } from "./ocrWord.js";
+import { StringDict } from "../../../parsing/index.js";
+export declare class OcrPage {
+    /**
+     * List of words extracted from the document page.
+     */
+    words: OcrWord[];
+    /**
+     * Full text content extracted from the document page.
+     */
+    content: string;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/ocr/ocrPage.js

@@ -0,0 +1,16 @@
+import { OcrWord } from "./ocrWord.js";
+export class OcrPage {
+    constructor(serverResponse) {
+        this.words = serverResponse["words"].map(word => new OcrWord(word));
+        this.content = serverResponse["content"];
+    }
+    toString() {
+        let ocrWords = "\n";
+        if (this.words.length > 0) {
+            ocrWords += this.words.map(word => word.toString()).join("\n\n");
+        }
+        let outStr = `OCR Words\n---------${ocrWords}`;
+        outStr += `\n\n:Content: ${this.content}`;
+        return outStr;
+    }
+}

package/src/v2/product/ocr/ocrResponse.d.ts

@@ -0,0 +1,13 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { OcrInference } from "./ocrInference.js";
+import { BaseResponse } from "../../../v2/parsing/index.js";
+export declare class OcrResponse extends BaseResponse {
+    /**
+     * Response for an OCR utility inference.
+     */
+    inference: OcrInference;
+    /**
+     * @param serverResponse JSON response from the server.
+     */
+    constructor(serverResponse: StringDict);
+}

package/src/v2/product/ocr/ocrResponse.js

@@ -0,0 +1,11 @@
+import { OcrInference } from "./ocrInference.js";
+import { BaseResponse } from "../../../v2/parsing/index.js";
+export class OcrResponse extends BaseResponse {
+    /**
+     * @param serverResponse JSON response from the server.
+     */
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.inference = new OcrInference(serverResponse["inference"]);
+    }
+}

package/src/v2/product/ocr/ocrResult.d.ts

@@ -0,0 +1,13 @@
+import { StringDict } from "../../../parsing/index.js";
+import { OcrPage } from "./ocrPage.js";
+/**
+ * OCR result info.
+ */
+export declare class OcrResult {
+    /**
+     * List of OCR results for each page in the document.
+     */
+    pages: OcrPage[];
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/ocr/ocrResult.js

@@ -0,0 +1,16 @@
+import { OcrPage } from "./ocrPage.js";
+/**
+ * OCR result info.
+ */
+export class OcrResult {
+    constructor(serverResponse) {
+        this.pages = serverResponse.pages.map((ocr) => new OcrPage(ocr));
+    }
+    toString() {
+        let pages = "\n";
+        if (this.pages.length > 0) {
+            pages += this.pages.map(ocr => ocr.toString()).join("\n\n");
+        }
+        return `Pages\n======${pages}`;
+    }
+}

package/src/v2/product/ocr/ocrWord.d.ts

@@ -0,0 +1,14 @@
+import { Polygon } from "../../../geometry/index.js";
+import { StringDict } from "../../../parsing/index.js";
+export declare class OcrWord {
+    /**
+     * Text content of the word.
+     */
+    content: string;
+    /**
+     * Position information as a list of points in clockwise order.
+     */
+    polygon: Polygon;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/ocr/ocrWord.js

@@ -0,0 +1,10 @@
+import { Polygon } from "../../../geometry/index.js";
+export class OcrWord {
+    constructor(serverResponse) {
+        this.content = serverResponse["content"];
+        this.polygon = new Polygon(...serverResponse["polygon"]);
+    }
+    toString() {
+        return this.content;
+    }
+}

package/src/v2/product/ocr/params/index.d.ts

@@ -0,0 +1 @@
+export { OcrParameters } from "./ocrParameters.js";

package/src/v2/product/ocr/params/index.js

@@ -0,0 +1 @@
+export { OcrParameters } from "./ocrParameters.js";

package/src/v2/product/ocr/params/ocrParameters.d.ts

@@ -0,0 +1,21 @@
+import { BaseParameters, BaseParametersConstructor } from "../../../../v2/client/baseParameters.js";
+/**
+ * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ *
+ * All fields are optional except `modelId`.
+ *
+ * @category ClientV2
+ * @example
+ * const params = {
+ *   modelId: "YOUR_MODEL_ID",
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export declare class OcrParameters extends BaseParameters {
+    constructor(params: BaseParametersConstructor & {});
+}

package/src/v2/product/ocr/params/ocrParameters.js

@@ -0,0 +1,25 @@
+import { BaseParameters } from "../../../../v2/client/baseParameters.js";
+import { logger } from "../../../../logger.js";
+/**
+ * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ *
+ * All fields are optional except `modelId`.
+ *
+ * @category ClientV2
+ * @example
+ * const params = {
+ *   modelId: "YOUR_MODEL_ID",
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export class OcrParameters extends BaseParameters {
+    constructor(params) {
+        super({ ...params });
+        logger.debug("OCR parameters initialized.");
+    }
+}

package/src/v2/product/split/index.d.ts

@@ -0,0 +1,6 @@
+export { Split } from "./split.js";
+export { SplitParameters } from "./params/index.js";
+export { SplitResponse } from "./splitResponse.js";
+export { SplitInference } from "./splitInference.js";
+export { SplitRange } from "./splitRange.js";
+export { SplitResult } from "./splitResult.js";

package/src/v2/product/split/index.js

@@ -0,0 +1,6 @@
+export { Split } from "./split.js";
+export { SplitParameters } from "./params/index.js";
+export { SplitResponse } from "./splitResponse.js";
+export { SplitInference } from "./splitInference.js";
+export { SplitRange } from "./splitRange.js";
+export { SplitResult } from "./splitResult.js";

package/src/v2/product/split/params/index.d.ts

@@ -0,0 +1 @@
+export { SplitParameters } from "./splitParameters.js";

package/src/v2/product/split/params/index.js

@@ -0,0 +1 @@
+export { SplitParameters } from "./splitParameters.js";

package/src/v2/product/split/params/splitParameters.d.ts

@@ -0,0 +1,21 @@
+import { BaseParameters, BaseParametersConstructor } from "../../../../v2/client/baseParameters.js";
+/**
+ * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ *
+ * All fields are optional except `modelId`.
+ *
+ * @category ClientV2
+ * @example
+ * const params = {
+ *   modelId: "YOUR_MODEL_ID",
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export declare class SplitParameters extends BaseParameters {
+    constructor(params: BaseParametersConstructor & {});
+}

package/src/v2/product/split/params/splitParameters.js

@@ -0,0 +1,25 @@
+import { BaseParameters, } from "../../../../v2/client/baseParameters.js";
+import { logger } from "../../../../logger.js";
+/**
+ * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ *
+ * All fields are optional except `modelId`.
+ *
+ * @category ClientV2
+ * @example
+ * const params = {
+ *   modelId: "YOUR_MODEL_ID",
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export class SplitParameters extends BaseParameters {
+    constructor(params) {
+        super({ ...params });
+        logger.debug("Split parameters initialized.");
+    }
+}

package/src/v2/product/split/split.d.ts

@@ -0,0 +1,8 @@
+import { SplitResponse } from "./splitResponse.js";
+import { SplitParameters } from "./params/index.js";
+import { BaseProduct } from "../../../v2/product/baseProduct.js";
+export declare class Split extends BaseProduct {
+    static get parametersClass(): typeof SplitParameters;
+    static get responseClass(): typeof SplitResponse;
+    static get slug(): string;
+}

package/src/v2/product/split/split.js

@@ -0,0 +1,14 @@
+import { SplitResponse } from "./splitResponse.js";
+import { SplitParameters } from "./params/index.js";
+import { BaseProduct } from "../../../v2/product/baseProduct.js";
+export class Split extends BaseProduct {
+    static get parametersClass() {
+        return SplitParameters;
+    }
+    static get responseClass() {
+        return SplitResponse;
+    }
+    static get slug() {
+        return "split";
+    }
+}

package/src/v2/product/split/splitInference.d.ts

@@ -0,0 +1,11 @@
+import { StringDict } from "../../../parsing/index.js";
+import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+import { SplitResult } from "./splitResult.js";
+export declare class SplitInference extends BaseInference {
+    /**
+     * Result of a split inference.
+     */
+    result: SplitResult;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/split/splitInference.js

@@ -0,0 +1,12 @@
+import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+import { SplitResult } from "./splitResult.js";
+export class SplitInference extends BaseInference {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.result = new SplitResult(serverResponse["result"]);
+    }
+    toString() {
+        return (super.toString() +
+            this.result.toString() + "\n");
+    }
+}

package/src/v2/product/split/splitRange.d.ts

@@ -0,0 +1,17 @@
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * Split inference result.
+ */
+export declare class SplitRange {
+    /**
+     * 0-based page indexes, where the first integer indicates the start page and the
+     * second integer indicates the end page.
+     */
+    pageRange: number[];
+    /**
+     * The document type, as identified on given classification values.
+     */
+    documentType: string;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/split/splitRange.js

@@ -0,0 +1,13 @@
+/**
+ * Split inference result.
+ */
+export class SplitRange {
+    constructor(serverResponse) {
+        this.pageRange = serverResponse["page_range"];
+        this.documentType = serverResponse["document_type"];
+    }
+    toString() {
+        const pageRange = this.pageRange.join(",");
+        return `* :Page Range: ${pageRange}\n  :Document Type: ${this.documentType}`;
+    }
+}

package/src/v2/product/split/splitResponse.d.ts

@@ -0,0 +1,13 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { SplitInference } from "./splitInference.js";
+import { BaseResponse } from "../../../v2/parsing/index.js";
+export declare class SplitResponse extends BaseResponse {
+    /**
+     * Response for an OCR utility inference.
+     */
+    inference: SplitInference;
+    /**
+     * @param serverResponse JSON response from the server.
+     */
+    constructor(serverResponse: StringDict);
+}

package/src/v2/product/split/splitResponse.js

@@ -0,0 +1,11 @@
+import { SplitInference } from "./splitInference.js";
+import { BaseResponse } from "../../../v2/parsing/index.js";
+export class SplitResponse extends BaseResponse {
+    /**
+     * @param serverResponse JSON response from the server.
+     */
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.inference = new SplitInference(serverResponse["inference"]);
+    }
+}

package/src/v2/product/split/splitResult.d.ts

@@ -0,0 +1,13 @@
+import { SplitRange } from "./splitRange.js";
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * Split result info.
+ */
+export declare class SplitResult {
+    /**
+     * List of split ranges.
+     */
+    splits: SplitRange[];
+    constructor(rawResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/split/splitResult.js

@@ -0,0 +1,16 @@
+import { SplitRange } from "./splitRange.js";
+/**
+ * Split result info.
+ */
+export class SplitResult {
+    constructor(rawResponse) {
+        this.splits = rawResponse.splits.map((split) => new SplitRange(split));
+    }
+    toString() {
+        let splits = "\n";
+        if (this.splits.length > 0) {
+            splits += this.splits.map(split => split.toString()).join("\n\n");
+        }
+        return `Splits\n======${splits}`;
+    }
+}

package/bin/mindee.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cli_1 = require("../src/cli");
-(0, cli_1.cli)();