mindee 4.33.1 → 4.34.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v4.34.0 - 2025-12-02
+### Changes
+* :sparkles: add support for text context
+
+
 ## v4.33.1 - 2025-10-28
 ### Changes
 * :loud_sound: add error code to v2 exceptions

package/package.json

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

package/src/clientV2.d.ts

@@ -17,12 +17,6 @@ import { MindeeApiV2 } from "./http/mindeeApiV2";
  * The `initialTimerOptions` and `recurringTimerOptions` objects let you pass an
  * `AbortSignal` or make the timer `unref`-ed to the `setTimeout()`.
  *
- * @property initialDelaySec Number of seconds to wait **before the first poll**.
- * @property delaySec Interval in seconds between two consecutive polls.
- * @property maxRetries Maximum number of polling attempts (including the first one).
- * @property initialTimerOptions Options passed to the initial `setTimeout()`.
- * @property recurringTimerOptions Options passed to every recurring `setTimeout()`.
- *
  * @category ClientV2
  * @example
  * const params = {
@@ -34,13 +28,18 @@ import { MindeeApiV2 } from "./http/mindeeApiV2";
  * const inference = await client.enqueueAndGetInference(inputDoc, params);
  */
 export interface PollingOptions {
+    /** Number of seconds to wait *before the first poll*. */
     initialDelaySec?: number;
+    /** Interval in seconds between two consecutive polls. */
     delaySec?: number;
+    /** Maximum number of polling attempts (including the first one). */
     maxRetries?: number;
+    /** Options passed to the initial `setTimeout()`. */
     initialTimerOptions?: {
         ref?: boolean;
         signal?: AbortSignal;
     };
+    /** Options passed to every recurring `setTimeout()`. */
     recurringTimerOptions?: {
         ref?: boolean;
         signal?: AbortSignal;
@@ -51,16 +50,6 @@ export interface PollingOptions {
  *
  * All fields are optional except `modelId`.
  *
- * @property modelId Identifier of the model that must process the document. **Required**.
- * @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}).
- * @property closeFile By default the file is closed once the upload is finished, set to `false` to keep it open.
  * @category ClientV2
  * @example
  * const params = {
@@ -75,23 +64,34 @@ export interface PollingOptions {
  * };
  */
 export interface InferenceParameters {
+    /** Model ID to use for the inference. **Required** */
     modelId: string;
+    /** 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;
+    /** Use an alias to link the file to your own DB. If empty, no alias will be used. */
     alias?: string;
+    /** Additional text context used by the model during inference.
+     * *Not recommended*, for specific use only. */
+    textContext?: 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;
 }
 /**
  * Options for the V2 Mindee Client.
  *
- * @property apiKey Your API key for all endpoints.
- * @property throwOnError Raise an `Error` on errors.
- * @property debug Log debug messages.
- *
  * @category ClientV2
  * @example
  * const client = new MindeeClientV2({
@@ -101,8 +101,11 @@ export interface InferenceParameters {
  * });
  */
 export interface ClientOptions {
+    /** Your API key for all endpoints. */
     apiKey?: string;
+    /** Raise an `Error` on errors. */
     throwOnError?: boolean;
+    /** Log debug messages. */
     debug?: boolean;
 }
 /**

package/src/http/mindeeApiV2.js

@@ -99,6 +99,9 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
     if (params.rawText !== undefined && params.rawText !== null) {
         form.append("raw_text", params.rawText.toString().toLowerCase());
     }
+    if (params.textContext !== undefined && params.textContext !== null) {
+        form.append("text_context", params.textContext);
+    }
     if (params.webhookIds && params.webhookIds.length > 0) {
         form.append("webhook_ids", params.webhookIds.join(","));
     }

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

@@ -1,7 +1,10 @@
 import { StringDict } from "../common";
+/**
+ * Explicit details on a problem.
+ */
 export declare class ErrorItem {
     /**
-     * The HTTP status code returned by the server.
+     * A JSON Pointer to the location of the body property.
      */
     pointer?: string;
     /**

package/src/parsing/v2/errorItem.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorItem = void 0;
+/**
+ * Explicit details on a problem.
+ */
 class ErrorItem {
     /**
      * @param serverResponse JSON response from the server.

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

@@ -18,7 +18,7 @@ export interface ErrorDetails {
      */
     code: string;
     /**
-     * A machine-readable code specific to the occurrence of the problem.
+     * A list of explicit error details.
      */
     errors: ErrorItem[];
 }

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

@@ -16,6 +16,10 @@ export declare class InferenceActiveOptions {
      * Whether the confidence feature was activated.
      */
     confidence: boolean;
+    /**
+     * Whether the text context feature was activated.
+     */
+    textContext: boolean;
     constructor(serverResponse: StringDict);
     toString(): string;
 }

package/src/parsing/v2/inferenceActiveOptions.js

@@ -7,6 +7,7 @@ class InferenceActiveOptions {
         this.rawText = serverResponse["raw_text"];
         this.polygon = serverResponse["polygon"];
         this.confidence = serverResponse["confidence"];
+        this.textContext = serverResponse["text_context"];
     }
     toString() {
         return "Active Options\n" +