mindee 4.29.0 → 4.30.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## v4.30.0 - 2025-09-04
+### Changes
+* :sparkles: add support for inference options
+* :recycle: refactor rst display to match other SDKs
+### ¡Breaking Changes!
+* :recycle: :boom: update raw text output from server
+
 ## v4.29.0 - 2025-08-29
 ### Changes
 * :sparkles: add typed accessors for fields, list, object

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.29.0",
+    "version": "4.30.0",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",

package/src/clientV2.d.ts

@@ -52,7 +52,11 @@ export interface PollingOptions {
  * All fields are optional except `modelId`.
  *
  * @property modelId Identifier of the model that must process the document. **Required**.
- * @property rag When `true`, activates Retrieval-Augmented Generation (RAG).
+ * @property rag Enhance extraction accuracy with Retrieval-Augmented Generation.
+ * @property rawText Extract the full text content from the document as strings, and fill the `raw_text` attribute.
+ * @property polygon Calculate bounding box polygons for all fields, and fill their `locations` attribute.
+ * @property confidence Boost the precision and accuracy of all extractions.
+ *     Calculate confidence scores for all fields and fill their `confidence` attribute.
  * @property alias Custom alias assigned to the uploaded document.
  * @property webhookIds List of webhook UUIDs that will receive the final API response.
  * @property pollingOptions Client-side polling configuration (see {@link PollingOptions}).
@@ -73,6 +77,9 @@ export interface PollingOptions {
 export interface InferenceParameters {
     modelId: string;
     rag?: boolean;
+    rawText?: boolean;
+    polygon?: boolean;
+    confidence?: boolean;
     alias?: string;
     webhookIds?: string[];
     pollingOptions?: PollingOptions;

package/src/http/mindeeApiV2.js

@@ -82,8 +82,17 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
 }, _MindeeApiV2_documentEnqueuePost = function _MindeeApiV2_documentEnqueuePost(inputSource, params) {
     const form = new form_data_1.default();
     form.append("model_id", params.modelId);
-    if (params.rag) {
-        form.append("rag", "true");
+    if (params.rag !== undefined && params.rag !== null) {
+        form.append("rag", params.rag.toString());
+    }
+    if (params.polygon !== undefined && params.polygon !== null) {
+        form.append("polygon", params.polygon.toString().toLowerCase());
+    }
+    if (params.confidence !== undefined && params.confidence !== null) {
+        form.append("confidence", params.confidence.toString().toLowerCase());
+    }
+    if (params.rawText !== undefined && params.rawText !== null) {
+        form.append("raw_text", params.rawText.toString().toLowerCase());
     }
     if (params.webhookIds && params.webhookIds.length > 0) {
         form.append("webhook_ids", params.webhookIds.join(","));

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

@@ -1,6 +1,7 @@
 export { CommonResponse } from "./commonResponse";
 export { ErrorResponse } from "./errorResponse";
 export { Inference } from "./inference";
+export { InferenceActiveOptions } from "./inferenceActiveOptions";
 export { InferenceFile } from "./inferenceFile";
 export { InferenceModel } from "./inferenceModel";
 export { InferenceResponse } from "./inferenceResponse";

package/src/parsing/v2/index.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JobWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceModel = exports.InferenceFile = exports.Inference = exports.ErrorResponse = exports.CommonResponse = void 0;
+exports.JobWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceModel = exports.InferenceFile = exports.InferenceActiveOptions = exports.Inference = exports.ErrorResponse = exports.CommonResponse = void 0;
 var commonResponse_1 = require("./commonResponse");
 Object.defineProperty(exports, "CommonResponse", { enumerable: true, get: function () { return commonResponse_1.CommonResponse; } });
 var errorResponse_1 = require("./errorResponse");
 Object.defineProperty(exports, "ErrorResponse", { enumerable: true, get: function () { return errorResponse_1.ErrorResponse; } });
 var inference_1 = require("./inference");
 Object.defineProperty(exports, "Inference", { enumerable: true, get: function () { return inference_1.Inference; } });
+var inferenceActiveOptions_1 = require("./inferenceActiveOptions");
+Object.defineProperty(exports, "InferenceActiveOptions", { enumerable: true, get: function () { return inferenceActiveOptions_1.InferenceActiveOptions; } });
 var inferenceFile_1 = require("./inferenceFile");
 Object.defineProperty(exports, "InferenceFile", { enumerable: true, get: function () { return inferenceFile_1.InferenceFile; } });
 var inferenceModel_1 = require("./inferenceModel");

package/src/parsing/v2/inference.d.ts

@@ -2,6 +2,7 @@ import { StringDict } from "../common";
 import { InferenceModel } from "./inferenceModel";
 import { InferenceResult } from "./inferenceResult";
 import { InferenceFile } from "./inferenceFile";
+import { InferenceActiveOptions } from "./inferenceActiveOptions";
 export declare class Inference {
     /**
      * Model info for the inference.
@@ -19,6 +20,10 @@ export declare class Inference {
      * ID of the inference.
      */
     id?: string;
+    /**
+     * Active options for the inference.
+     */
+    activeOptions: InferenceActiveOptions;
     constructor(serverResponse: StringDict);
     toString(): string;
 }

package/src/parsing/v2/inference.js

@@ -4,22 +4,20 @@ exports.Inference = void 0;
 const inferenceModel_1 = require("./inferenceModel");
 const inferenceResult_1 = require("./inferenceResult");
 const inferenceFile_1 = require("./inferenceFile");
+const inferenceActiveOptions_1 = require("./inferenceActiveOptions");
 class Inference {
     constructor(serverResponse) {
         this.model = new inferenceModel_1.InferenceModel(serverResponse["model"]);
         this.file = new inferenceFile_1.InferenceFile(serverResponse["file"]);
         this.result = new inferenceResult_1.InferenceResult(serverResponse["result"]);
-        if ("id" in serverResponse) {
-            this.id = serverResponse["id"];
-        }
+        this.activeOptions = new inferenceActiveOptions_1.InferenceActiveOptions(serverResponse["active_options"]);
     }
     toString() {
         return ("Inference\n" +
             "#########\n" +
-            "Model\n" +
-            "=====\n" +
-            `:ID: ${this.model.id}\n\n` +
+            this.model.toString() + "\n" +
             this.file.toString() + "\n" +
+            this.activeOptions.toString() + "\n" +
             this.result + "\n");
     }
 }

package/src/parsing/v2/inferenceActiveOptions.d.ts

@@ -0,0 +1,21 @@
+import { StringDict } from "../common";
+export declare class InferenceActiveOptions {
+    /**
+     * 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;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/parsing/v2/inferenceActiveOptions.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InferenceActiveOptions = void 0;
+class InferenceActiveOptions {
+    constructor(serverResponse) {
+        this.rag = serverResponse["rag"];
+        this.rawText = serverResponse["raw_text"];
+        this.polygon = serverResponse["polygon"];
+        this.confidence = serverResponse["confidence"];
+    }
+    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`;
+    }
+}
+exports.InferenceActiveOptions = InferenceActiveOptions;

package/src/parsing/v2/inferenceModel.d.ts

@@ -5,4 +5,5 @@ export declare class InferenceModel {
      */
     id: string;
     constructor(serverResponse: StringDict);
+    toString(): string;
 }

package/src/parsing/v2/inferenceModel.js

@@ -5,5 +5,10 @@ class InferenceModel {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
     }
+    toString() {
+        return "Model\n" +
+            "=====\n" +
+            `:ID: ${this.id}\n`;
+    }
 }
 exports.InferenceModel = InferenceModel;

package/src/parsing/v2/inferenceResult.js

@@ -11,12 +11,7 @@ class InferenceResult {
         }
     }
     toString() {
-        const parts = [
-            "Fields",
-            "======",
-            this.fields.toString(),
-        ];
-        return parts.join("\n");
+        return `Fields\n======\n${this.fields}`;
     }
 }
 exports.InferenceResult = InferenceResult;

package/src/parsing/v2/rawText.d.ts

@@ -6,4 +6,5 @@ export declare class RawText {
      */
     pages: Array<RawTextPage>;
     constructor(serverResponse: StringDict);
+    toString(): string;
 }

package/src/parsing/v2/rawText.js

@@ -6,5 +6,8 @@ class RawText {
     constructor(serverResponse) {
         this.pages = serverResponse["pages"] ? serverResponse["pages"].map((rawTextPage) => new rawTextPage_1.RawTextPage(rawTextPage)) : [];
     }
+    toString() {
+        return this.pages.map(page => page.toString()).join("\n\n");
+    }
 }
 exports.RawText = RawText;