mindee 4.36.3 → 5.0.0-alpha1

package/src/v2/product/crop/cropResult.d.ts

@@ -0,0 +1,10 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { CropItem } from "../../../v2/product/crop/cropItem.js";
+export declare class CropResult {
+    /**
+     * Fields contained in the inference.
+     */
+    crops: CropItem[];
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/crop/cropResult.js

@@ -0,0 +1,14 @@
+import { CropItem } from "../../../v2/product/crop/cropItem.js";
+export class CropResult {
+    constructor(serverResponse) {
+        /**
+         * Fields contained in the inference.
+         */
+        this.crops = [];
+        this.crops = serverResponse["crops"].map((cropItem) => new CropItem(cropItem));
+    }
+    toString() {
+        const crops = this.crops.map(item => item.toString()).join("\n * ");
+        return `Crop\n====\n * ${crops}`;
+    }
+}

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

@@ -0,0 +1,6 @@
+export { Crop } from "./crop.js";
+export { CropParameters } from "./params/index.js";
+export { CropInference } from "./cropInference.js";
+export { CropItem } from "./cropItem.js";
+export { CropResponse } from "./cropResponse.js";
+export { CropResult } from "./cropResult.js";

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

@@ -0,0 +1,6 @@
+export { Crop } from "./crop.js";
+export { CropParameters } from "./params/index.js";
+export { CropInference } from "./cropInference.js";
+export { CropItem } from "./cropItem.js";
+export { CropResponse } from "./cropResponse.js";
+export { CropResult } from "./cropResult.js";

package/src/v2/product/crop/params/cropParameters.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 CropParameters extends BaseParameters {
+    constructor(params: BaseParametersConstructor & {});
+}

package/src/v2/product/crop/params/cropParameters.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 CropParameters extends BaseParameters {
+    constructor(params) {
+        super({ ...params });
+        logger.debug("Crop parameters initialized.");
+    }
+}

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

@@ -0,0 +1 @@
+export { CropParameters } from "./cropParameters.js";

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

@@ -0,0 +1 @@
+export { CropParameters } from "./cropParameters.js";

package/src/v2/product/extraction/dataSchemaActiveOption.d.ts

@@ -0,0 +1,12 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+/**
+ * Data schema options activated during the inference.
+ */
+export declare class DataSchemaActiveOption {
+    /**
+     * Whether to replace the data schema.
+     */
+    replace: boolean;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/extraction/dataSchemaActiveOption.js

@@ -0,0 +1,11 @@
+/**
+ * Data schema options activated during the inference.
+ */
+export class DataSchemaActiveOption {
+    constructor(serverResponse) {
+        this.replace = serverResponse["replace"];
+    }
+    toString() {
+        return `Data Schema\n-----------\n:Replace: ${this.replace ? "True" : "False"}`;
+    }
+}

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

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

package/src/v2/product/extraction/extraction.js

@@ -0,0 +1,14 @@
+import { ExtractionResponse } from "./extractionResponse.js";
+import { ExtractionParameters } from "./params/index.js";
+import { BaseProduct } from "../../../v2/product/baseProduct.js";
+export class Extraction extends BaseProduct {
+    static get parametersClass() {
+        return ExtractionParameters;
+    }
+    static get responseClass() {
+        return ExtractionResponse;
+    }
+    static get slug() {
+        return "extraction";
+    }
+}

package/src/v2/product/extraction/extractionActiveOptions.d.ts

@@ -0,0 +1,30 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
+export declare class ExtractionActiveOptions {
+    /**
+     * Whether the RAG feature was activated.
+     */
+    rag: boolean;
+    /**
+     * Whether the Raw Text feature was activated.
+     */
+    rawText: boolean;
+    /**
+     * Whether the polygon feature was activated.
+     */
+    polygon: boolean;
+    /**
+     * Whether the confidence feature was activated.
+     */
+    confidence: boolean;
+    /**
+     * Whether the text context feature was activated.
+     */
+    textContext: boolean;
+    /**
+     * Data schema options provided for the inference.
+     */
+    dataSchema: DataSchemaActiveOption;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/extraction/extractionActiveOptions.js

@@ -0,0 +1,21 @@
+import { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
+export class ExtractionActiveOptions {
+    constructor(serverResponse) {
+        this.rag = serverResponse["rag"];
+        this.rawText = serverResponse["raw_text"];
+        this.polygon = serverResponse["polygon"];
+        this.confidence = serverResponse["confidence"];
+        this.textContext = serverResponse["text_context"];
+        this.dataSchema = new DataSchemaActiveOption(serverResponse["data_schema"]);
+    }
+    toString() {
+        return "Active Options\n" +
+            "==============\n" +
+            `:Raw Text: ${this.rawText ? "True" : "False"}\n` +
+            `:Polygon: ${this.polygon ? "True" : "False"}\n` +
+            `:Confidence: ${this.confidence ? "True" : "False"}\n` +
+            `:RAG: ${this.rag ? "True" : "False"}\n` +
+            `:Text Context: ${this.textContext ? "True" : "False"}\n\n` +
+            `${this.dataSchema}\n`;
+    }
+}

package/src/v2/product/extraction/extractionInference.d.ts

@@ -0,0 +1,16 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { ExtractionResult } from "./extractionResult.js";
+import { ExtractionActiveOptions } from "./extractionActiveOptions.js";
+import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+export declare class ExtractionInference extends BaseInference {
+    /**
+     * Result of the inference.
+     */
+    result: ExtractionResult;
+    /**
+     * Active options for the inference.
+     */
+    activeOptions: ExtractionActiveOptions;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/extraction/extractionInference.js

@@ -0,0 +1,15 @@
+import { ExtractionResult } from "./extractionResult.js";
+import { ExtractionActiveOptions } from "./extractionActiveOptions.js";
+import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+export class ExtractionInference extends BaseInference {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.result = new ExtractionResult(serverResponse["result"]);
+        this.activeOptions = new ExtractionActiveOptions(serverResponse["active_options"]);
+    }
+    toString() {
+        return (super.toString() +
+            this.activeOptions.toString() + "\n" +
+            this.result.toString() + "\n");
+    }
+}

package/src/v2/product/extraction/extractionResponse.d.ts

@@ -0,0 +1,13 @@
+import { ExtractionInference } from "./extractionInference.js";
+import { StringDict } from "../../../parsing/stringDict.js";
+import { BaseResponse } from "../../../v2/parsing/index.js";
+export declare class ExtractionResponse extends BaseResponse {
+    /**
+     * The inference result for an extraction request.
+     */
+    inference: ExtractionInference;
+    /**
+     * @param serverResponse JSON response from the server.
+     */
+    constructor(serverResponse: StringDict);
+}

package/src/v2/product/extraction/extractionResponse.js

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

package/src/v2/product/extraction/extractionResult.d.ts

@@ -0,0 +1,20 @@
+import { InferenceFields } from "../../../v2/parsing/inference/field/index.js";
+import { StringDict } from "../../../parsing/stringDict.js";
+import { RawText } from "../../../v2/parsing/inference/field/rawText.js";
+import { RagMetadata } from "../../../v2/parsing/inference/field/ragMetadata.js";
+export declare class ExtractionResult {
+    /**
+     * Fields contained in the inference.
+     */
+    fields: InferenceFields;
+    /**
+     * Raw text extracted from all pages.
+     */
+    rawText?: RawText;
+    /**
+     * RAG metadata.
+     */
+    rag?: RagMetadata;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/product/extraction/extractionResult.js

@@ -0,0 +1,17 @@
+import { InferenceFields } from "../../../v2/parsing/inference/field/index.js";
+import { RawText } from "../../../v2/parsing/inference/field/rawText.js";
+import { RagMetadata } from "../../../v2/parsing/inference/field/ragMetadata.js";
+export class ExtractionResult {
+    constructor(serverResponse) {
+        this.fields = new InferenceFields(serverResponse["fields"]);
+        if (serverResponse["raw_text"]) {
+            this.rawText = new RawText(serverResponse["raw_text"]);
+        }
+        if (serverResponse["rag"]) {
+            this.rag = new RagMetadata(serverResponse["rag"]);
+        }
+    }
+    toString() {
+        return `Fields\n======\n${this.fields}`;
+    }
+}

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

@@ -0,0 +1,8 @@
+export { Extraction } from "./extraction.js";
+export { ExtractionParameters } from "./params/index.js";
+export * as params from "./params/index.js";
+export { ExtractionInference } from "./extractionInference.js";
+export { ExtractionActiveOptions } from "./extractionActiveOptions.js";
+export { ExtractionResponse } from "./extractionResponse.js";
+export { ExtractionResult } from "./extractionResult.js";
+export { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";

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

@@ -0,0 +1,8 @@
+export { Extraction } from "./extraction.js";
+export { ExtractionParameters } from "./params/index.js";
+export * as params from "./params/index.js";
+export { ExtractionInference } from "./extractionInference.js";
+export { ExtractionActiveOptions } from "./extractionActiveOptions.js";
+export { ExtractionResponse } from "./extractionResponse.js";
+export { ExtractionResult } from "./extractionResult.js";
+export { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";

package/src/v2/product/extraction/params/dataSchema.d.ts

@@ -0,0 +1,18 @@
+import { StringDict } from "../../../../parsing/stringDict.js";
+import { DataSchemaReplace } from "./dataSchemaReplace.js";
+/**
+ * Modify the Data Schema.
+ */
+export declare class DataSchema {
+    /**
+     * If set, completely replaces the data schema of the model.
+     */
+    replace?: DataSchemaReplace;
+    constructor(dataSchema: StringDict | string);
+    toJSON(): {
+        replace: {
+            fields: Record<string, unknown>[];
+        } | undefined;
+    };
+    toString(): string;
+}

package/src/v2/product/extraction/params/dataSchema.js

@@ -0,0 +1,23 @@
+import { DataSchemaReplace } from "./dataSchemaReplace.js";
+/**
+ * Modify the Data Schema.
+ */
+export class DataSchema {
+    constructor(dataSchema) {
+        if (typeof dataSchema === "string") {
+            this.replace = new DataSchemaReplace(JSON.parse(dataSchema)["replace"]);
+        }
+        else if (dataSchema instanceof DataSchema) {
+            this.replace = dataSchema.replace;
+        }
+        else {
+            this.replace = new DataSchemaReplace(dataSchema["replace"]);
+        }
+    }
+    toJSON() {
+        return { replace: this.replace?.toJSON() };
+    }
+    toString() {
+        return JSON.stringify(this.toJSON());
+    }
+}

package/src/v2/product/extraction/params/dataSchemaField.d.ts

@@ -0,0 +1,43 @@
+import { StringDict } from "../../../../parsing/index.js";
+export declare class DataSchemaField {
+    /**
+     * Display name for the field, also impacts inference results.
+     */
+    title: string;
+    /**
+     * Name of the field in the data schema.
+     */
+    name: string;
+    /**
+     * Whether this field can contain multiple values.
+     */
+    isArray: boolean;
+    /**
+     * Data type of the field.
+     */
+    type: string;
+    /**
+     * Allowed values when type is `classification`. Leave empty for other types.
+     */
+    classificationValues?: Array<string>;
+    /**
+     * Whether to remove duplicate values in the array.
+     * Only applicable if `is_array` is True.
+     */
+    uniqueValues?: boolean;
+    /**
+     * Detailed description of what this field represents.
+     */
+    description?: string;
+    /**
+     * Optional extraction guidelines.
+     */
+    guidelines?: string;
+    /**
+     * Subfields when type is `nested_object`. Leave empty for other types.
+     */
+    nestedFields?: StringDict;
+    constructor(fields: StringDict);
+    toJSON(): Record<string, unknown>;
+    toString(): string;
+}

package/src/v2/product/extraction/params/dataSchemaField.js

@@ -0,0 +1,39 @@
+export class DataSchemaField {
+    constructor(fields) {
+        this.name = fields["name"];
+        this.title = fields["title"];
+        this.isArray = fields["is_array"];
+        this.type = fields["type"];
+        this.classificationValues = fields["classification_values"];
+        this.uniqueValues = fields["unique_values"];
+        this.description = fields["description"];
+        this.guidelines = fields["guidelines"];
+        this.nestedFields = fields["nested_fields"];
+    }
+    toJSON() {
+        const out = {
+            name: this.name,
+            title: this.title,
+            // eslint-disable-next-line @typescript-eslint/naming-convention,camelcase
+            is_array: this.isArray,
+            type: this.type,
+        };
+        // eslint-disable-next-line camelcase
+        if (this.classificationValues !== undefined)
+            out.classification_values = this.classificationValues;
+        // eslint-disable-next-line camelcase
+        if (this.uniqueValues !== undefined)
+            out.unique_values = this.uniqueValues;
+        if (this.description !== undefined)
+            out.description = this.description;
+        if (this.guidelines !== undefined)
+            out.guidelines = this.guidelines;
+        // eslint-disable-next-line camelcase
+        if (this.nestedFields !== undefined)
+            out.nested_fields = this.nestedFields;
+        return out;
+    }
+    toString() {
+        return JSON.stringify(this.toJSON());
+    }
+}

package/src/v2/product/extraction/params/dataSchemaReplace.d.ts

@@ -0,0 +1,16 @@
+import { StringDict } from "../../../../parsing/index.js";
+import { DataSchemaField } from "./dataSchemaField.js";
+/**
+ * The structure to completely replace the data schema of the model.
+ */
+export declare class DataSchemaReplace {
+    /**
+     * List of fields in the Data Schema.
+     */
+    fields: Array<DataSchemaField>;
+    constructor(dataSchemaReplace: StringDict);
+    toJSON(): {
+        fields: Record<string, unknown>[];
+    };
+    toString(): string;
+}

package/src/v2/product/extraction/params/dataSchemaReplace.js

@@ -0,0 +1,22 @@
+import { DataSchemaField } from "./dataSchemaField.js";
+import { MindeeError } from "../../../../errors/index.js";
+/**
+ * The structure to completely replace the data schema of the model.
+ */
+export class DataSchemaReplace {
+    constructor(dataSchemaReplace) {
+        if (!dataSchemaReplace || !dataSchemaReplace.fields) {
+            throw new MindeeError("Invalid Data Schema provided.");
+        }
+        if (dataSchemaReplace["fields"].length === 0) {
+            throw new TypeError("Data Schema replacement fields cannot be empty.");
+        }
+        this.fields = dataSchemaReplace["fields"].map((field) => (new DataSchemaField(field)));
+    }
+    toJSON() {
+        return { fields: this.fields.map(e => e.toJSON()) };
+    }
+    toString() {
+        return JSON.stringify(this.toJSON());
+    }
+}

package/src/v2/product/extraction/params/extractionParameters.d.ts

@@ -0,0 +1,59 @@
+import { StringDict } from "../../../../parsing/stringDict.js";
+import { DataSchema } from "./dataSchema.js";
+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",
+ *   rag: true,
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export declare class ExtractionParameters extends BaseParameters {
+    /**
+     * Use Retrieval-Augmented Generation during inference.
+     */
+    rag?: boolean;
+    /**
+     * Extract the entire text from the document as strings, and fill the `rawText` attribute.
+     */
+    rawText?: boolean;
+    /**
+     * Calculate bounding box polygons for values, and fill the `locations` attribute of fields.
+     */
+    polygon?: boolean;
+    /**
+     * Calculate confidence scores for values, and fill the `confidence` attribute of fields.
+     * Useful for automation.
+     */
+    confidence?: boolean;
+    /**
+     * Additional text context used by the model during inference.
+     * *Not recommended*, for specific use only.
+     */
+    textContext?: string;
+    /**
+     * Dynamic changes to the data schema of the model for this inference.
+     * Not recommended, for specific use only.
+     */
+    dataSchema?: DataSchema | StringDict | string;
+    constructor(params: BaseParametersConstructor & {
+        rag?: boolean;
+        rawText?: boolean;
+        polygon?: boolean;
+        confidence?: boolean;
+        textContext?: string;
+        dataSchema?: DataSchema | StringDict | string;
+    });
+    getFormData(): FormData;
+}

package/src/v2/product/extraction/params/extractionParameters.js

@@ -0,0 +1,66 @@
+import { DataSchema } from "./dataSchema.js";
+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",
+ *   rag: true,
+ *   alias: "YOUR_ALIAS",
+ *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
+ *   pollingOptions: {
+ *     initialDelaySec: 2,
+ *     delaySec: 1.5,
+ *   }
+ * };
+ */
+export class ExtractionParameters extends BaseParameters {
+    constructor(params) {
+        super({ ...params });
+        this.rag = params.rag;
+        this.rawText = params.rawText;
+        this.polygon = params.polygon;
+        this.confidence = params.confidence;
+        this.textContext = params.textContext;
+        if (params.dataSchema !== undefined && params.dataSchema !== null) {
+            if (!(params.dataSchema instanceof DataSchema)) {
+                this.dataSchema = new DataSchema(params.dataSchema);
+            }
+            else {
+                this.dataSchema = params.dataSchema;
+            }
+        }
+        logger.debug("Extraction parameters initialized.");
+    }
+    getFormData() {
+        const form = new FormData();
+        form.set("model_id", this.modelId);
+        if (this.rag !== undefined && this.rag !== null) {
+            form.set("rag", this.rag.toString());
+        }
+        if (this.polygon !== undefined && this.polygon !== null) {
+            form.set("polygon", this.polygon.toString().toLowerCase());
+        }
+        if (this.confidence !== undefined && this.confidence !== null) {
+            form.set("confidence", this.confidence.toString().toLowerCase());
+        }
+        if (this.rawText !== undefined && this.rawText !== null) {
+            form.set("raw_text", this.rawText.toString().toLowerCase());
+        }
+        if (this.textContext !== undefined && this.textContext !== null) {
+            form.set("text_context", this.textContext);
+        }
+        if (this.dataSchema !== undefined && this.dataSchema !== null) {
+            form.set("data_schema", this.dataSchema.toString());
+        }
+        if (this.webhookIds && this.webhookIds.length > 0) {
+            form.set("webhook_ids", this.webhookIds.join(","));
+        }
+        return form;
+    }
+}

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

@@ -0,0 +1,4 @@
+export { ExtractionParameters } from "./extractionParameters.js";
+export { DataSchema } from "./dataSchema.js";
+export { DataSchemaReplace } from "./dataSchemaReplace.js";
+export { DataSchemaField } from "./dataSchemaField.js";

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

@@ -0,0 +1,4 @@
+export { ExtractionParameters } from "./extractionParameters.js";
+export { DataSchema } from "./dataSchema.js";
+export { DataSchemaReplace } from "./dataSchemaReplace.js";
+export { DataSchemaField } from "./dataSchemaField.js";

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

@@ -0,0 +1,10 @@
+export { Classification, ClassificationResponse } from "./classification/index.js";
+export * as classification from "./classification/index.js";
+export { Crop, CropResponse } from "./crop/index.js";
+export * as crop from "./crop/index.js";
+export { Extraction, ExtractionResponse } from "./extraction/index.js";
+export * as extraction from "./extraction/index.js";
+export { Ocr, OcrResponse } from "./ocr/index.js";
+export * as ocr from "./ocr/index.js";
+export { Split, SplitResponse } from "./split/index.js";
+export * as split from "./split/index.js";

package/src/v2/product/index.js

@@ -0,0 +1,10 @@
+export { Classification, ClassificationResponse } from "./classification/index.js";
+export * as classification from "./classification/index.js";
+export { Crop, CropResponse } from "./crop/index.js";
+export * as crop from "./crop/index.js";
+export { Extraction, ExtractionResponse } from "./extraction/index.js";
+export * as extraction from "./extraction/index.js";
+export { Ocr, OcrResponse } from "./ocr/index.js";
+export * as ocr from "./ocr/index.js";
+export { Split, SplitResponse } from "./split/index.js";
+export * as split from "./split/index.js";