mindee 4.32.0 → 4.33.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v4.33.0 - 2025-10-27
+### Changes
+* :sparkles: add more details to V2 errors
+* :sparkles: add RAG metadata in V2 results
+
+
 ## v4.32.0 - 2025-10-13
 ### Changes
 * :sparkles: add getting page count of a local source
@@ -12,7 +18,7 @@
 
 ## v4.31.0 - 2025-10-07
 ### Changes
-* :sparkles: allow comparing v2 field confidence
+* :sparkles: allow comparing V2 field confidence
 * :coffin: remove obsolete US Mail V2
 
 

package/README.md

@@ -6,26 +6,26 @@ Quickly and easily connect to Mindee's API services using Node.js.
 ## Mindee API Versions
 This client library has support for both Mindee platform versions.
 
-### Latest - V2
-This is the new platform located here:
+### V2 - Latest
+This is the latest platform located here:
 
 https://app.mindee.com
 
 It uses **API version 2**.
 
 Consult the
-**[Latest Documentation](https://docs.mindee.com/integrations/client-libraries-sdk)**
+**[V2 Documentation](https://docs.mindee.com/integrations/client-libraries-sdk)**
 
 
-### Legacy - V1
-This is the legacy platform located here:
+### V1
+This is the platform located here:
 
 https://platform.mindee.com/
 
 It uses **API version 1**.
 
 Consult the
-**[Legacy Documentation](https://developers.mindee.com/docs/nodejs-getting-started)**
+**[V1 Documentation](https://docs.mindee.com/v1/libraries/nodejs-sdk)**
 
 ## Additional Information
 

package/package.json

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

package/src/clientV2.js

@@ -105,7 +105,7 @@ class ClientV2 {
                 return this.getInference(pollResults.job.id);
             }
             logger_1.logger.debug(`Polling server for parsing result with queueId: ${queueId}.
-Attempt n°${retryCounter}/${validatedAsyncParams.maxRetries}.
+Attempt no. ${retryCounter} of ${validatedAsyncParams.maxRetries}.
 Job status: ${pollResults.job.status}.`);
             await (0, promises_1.setTimeout)(validatedAsyncParams.delaySec * 1000, undefined, validatedAsyncParams.recurringTimerOptions);
             pollResults = await this.getJob(queueId);
@@ -113,7 +113,7 @@ Job status: ${pollResults.job.status}.`);
         }
         const error = pollResults.job.error;
         if (error) {
-            throw new mindeeError_1.MindeeHttpErrorV2(error.status, error.detail);
+            throw new mindeeError_1.MindeeHttpErrorV2(error);
         }
         throw Error("Asynchronous parsing request timed out after " +
             validatedAsyncParams.delaySec * retryCounter +

package/src/errors/mindeeError.d.ts

@@ -1,3 +1,4 @@
+import { ErrorDetails, ErrorResponse } from "../parsing/v2";
 /**
  * Main Mindee Error custom class.
  */
@@ -19,8 +20,10 @@ export declare class MindeePdfError extends MindeeError {
 export declare class MindeeApiV2Error extends MindeeError {
     constructor(message: string);
 }
-export declare class MindeeHttpErrorV2 extends MindeeError {
+export declare class MindeeHttpErrorV2 extends MindeeError implements ErrorDetails {
     status: number;
     detail: string;
-    constructor(status: number, detail: string);
+    title: string;
+    code: string;
+    constructor(error: ErrorResponse);
 }

package/src/errors/mindeeError.js

@@ -43,10 +43,12 @@ class MindeeApiV2Error extends MindeeError {
 }
 exports.MindeeApiV2Error = MindeeApiV2Error;
 class MindeeHttpErrorV2 extends MindeeError {
-    constructor(status, detail) {
-        super(`HTTP ${status} - ${detail}`);
-        this.status = status;
-        this.detail = detail;
+    constructor(error) {
+        super(`HTTP ${error.status} :: ${error.title} - ${error.detail}`);
+        this.status = error.status;
+        this.detail = error.detail;
+        this.title = error.title;
+        this.code = error.code;
         this.name = "MindeeHttpErrorV2";
     }
 }

package/src/http/mindeeApiV2.d.ts

@@ -28,7 +28,7 @@ export declare class MindeeApiV2 {
      * Throws an error if the server's response contains one.
      * @param jobId The document's ID in the queue.
      * @category Asynchronous
-     * @returns a `Promise` containing either the parsed result, or information on the queue.
+     * @returns a `Promise` containing information on the queue.
      */
     reqGetJob(jobId: string): Promise<JobResponse>;
 }

package/src/http/mindeeApiV2.js

@@ -36,8 +36,8 @@ class MindeeApiV2 {
             throw new Error("Model ID must be provided");
         }
         const result = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_documentEnqueuePost).call(this, inputSource, params);
-        if (result.data.error?.code !== undefined) {
-            throw new mindeeError_1.MindeeHttpErrorV2(result.data.error.code, result.data.error.message ?? "Unknown error.");
+        if (result.data.error !== undefined) {
+            throw new mindeeError_1.MindeeHttpErrorV2(result.data.error);
         }
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, result, v2_1.JobResponse);
     }
@@ -57,7 +57,7 @@ class MindeeApiV2 {
      * Throws an error if the server's response contains one.
      * @param jobId The document's ID in the queue.
      * @category Asynchronous
-     * @returns a `Promise` containing either the parsed result, or information on the queue.
+     * @returns a `Promise` containing information on the queue.
      */
     async reqGetJob(jobId) {
         const queueResponse = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_inferenceResultReqGet).call(this, jobId, "jobs");
@@ -68,9 +68,14 @@ exports.MindeeApiV2 = MindeeApiV2;
 _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseType) {
     if (result.messageObj?.statusCode && (result.messageObj?.statusCode > 399 || result.messageObj?.statusCode < 200)) {
         if (result.data?.status !== null) {
-            throw new mindeeError_1.MindeeHttpErrorV2(result.data?.status, result.data?.detail ?? "Unknown error.");
+            throw new mindeeError_1.MindeeHttpErrorV2(new v2_1.ErrorResponse(result.data));
         }
-        throw new mindeeError_1.MindeeHttpErrorV2(result.messageObj?.statusCode ?? -1, result.data?.statusMessage ?? "Unknown error.");
+        throw new mindeeError_1.MindeeHttpErrorV2(new v2_1.ErrorResponse({
+            status: result.messageObj?.statusCode ?? -1,
+            title: "Unknown Error",
+            detail: result.data?.detail ?? "The server returned an Unknown error.",
+            code: `${result.messageObj?.statusCode ?? -1}-000`,
+        }));
     }
     try {
         return new responseType(result.data);

package/src/index.d.ts

@@ -2,7 +2,7 @@ export * as product from "./product";
 export { Client, PredictOptions, WorkflowOptions } from "./client";
 export { ClientV2, InferenceParameters, PollingOptions } from "./clientV2";
 export { AsyncPredictResponse, PredictResponse, Inference, Prediction, Document, Page, } from "./parsing/common";
-export { InferenceFile, InferenceResponse, JobResponse, RawText, } from "./parsing/v2";
+export { InferenceFile, InferenceResponse, JobResponse, RawText, RagMetadata, } from "./parsing/v2";
 export { InputSource, Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput, PageOptions, PageOptionsOperation, LocalResponse } from "./input";
 export * as internal from "./internal";
 export * as imageOperations from "./imageOperations";

package/src/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.imageOperations = exports.internal = exports.LocalResponse = exports.PageOptionsOperation = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.BufferInput = exports.Base64Input = exports.InputSource = exports.RawText = exports.JobResponse = exports.InferenceResponse = exports.InferenceFile = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.ClientV2 = exports.Client = exports.product = void 0;
+exports.imageOperations = exports.internal = exports.LocalResponse = exports.PageOptionsOperation = exports.UrlInput = exports.StreamInput = exports.PathInput = exports.BytesInput = exports.BufferInput = exports.Base64Input = exports.InputSource = exports.RagMetadata = exports.RawText = exports.JobResponse = exports.InferenceResponse = exports.InferenceFile = exports.Page = exports.Document = exports.Prediction = exports.Inference = exports.PredictResponse = exports.AsyncPredictResponse = exports.ClientV2 = exports.Client = exports.product = void 0;
 exports.product = __importStar(require("./product"));
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
@@ -51,6 +51,7 @@ Object.defineProperty(exports, "InferenceFile", { enumerable: true, get: functio
 Object.defineProperty(exports, "InferenceResponse", { enumerable: true, get: function () { return v2_1.InferenceResponse; } });
 Object.defineProperty(exports, "JobResponse", { enumerable: true, get: function () { return v2_1.JobResponse; } });
 Object.defineProperty(exports, "RawText", { enumerable: true, get: function () { return v2_1.RawText; } });
+Object.defineProperty(exports, "RagMetadata", { enumerable: true, get: function () { return v2_1.RagMetadata; } });
 var input_1 = require("./input");
 Object.defineProperty(exports, "InputSource", { enumerable: true, get: function () { return input_1.InputSource; } });
 Object.defineProperty(exports, "Base64Input", { enumerable: true, get: function () { return input_1.Base64Input; } });

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

@@ -0,0 +1,15 @@
+import { StringDict } from "../common";
+export declare class ErrorItem {
+    /**
+     * The HTTP status code returned by the server.
+     */
+    pointer?: string;
+    /**
+     * Explicit information on the issue.
+     */
+    detail: string;
+    /**
+     * @param serverResponse JSON response from the server.
+     */
+    constructor(serverResponse: StringDict);
+}

package/src/parsing/v2/errorItem.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorItem = void 0;
+class ErrorItem {
+    /**
+     * @param serverResponse JSON response from the server.
+     */
+    constructor(serverResponse) {
+        if (serverResponse["pointer"] !== undefined) {
+            this.pointer = serverResponse["pointer"];
+        }
+        this.detail = serverResponse["detail"];
+    }
+}
+exports.ErrorItem = ErrorItem;

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

@@ -1,13 +1,35 @@
 import { StringDict } from "../common";
-export declare class ErrorResponse {
+import { ErrorItem } from "./errorItem";
+export interface ErrorDetails {
     /**
-     * The HTTP code status.
+     * The HTTP status code returned by the server.
      */
     status: number;
     /**
-     * The detail on the error.
+     * A human-readable explanation specific to the occurrence of the problem.
      */
     detail: string;
+    /**
+     * A short, human-readable summary of the problem.
+     */
+    title: string;
+    /**
+     * A machine-readable code specific to the occurrence of the problem.
+     */
+    code: string;
+}
+/**
+ * Error response detailing a problem. The format adheres to RFC 9457.
+ */
+export declare class ErrorResponse implements ErrorDetails {
+    status: number;
+    detail: string;
+    title: string;
+    code: string;
+    /**
+     * A machine-readable code specific to the occurrence of the problem.
+     */
+    errors: ErrorItem[];
     /**
      * @param serverResponse JSON response from the server.
      */

package/src/parsing/v2/errorResponse.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResponse = void 0;
+const errorItem_1 = require("./errorItem");
+/**
+ * Error response detailing a problem. The format adheres to RFC 9457.
+ */
 class ErrorResponse {
     /**
      * @param serverResponse JSON response from the server.
@@ -8,6 +12,14 @@ class ErrorResponse {
     constructor(serverResponse) {
         this.status = serverResponse["status"];
         this.detail = serverResponse["detail"];
+        this.title = serverResponse["title"];
+        this.code = serverResponse["code"];
+        if (serverResponse["errors"] !== undefined) {
+            this.errors = serverResponse["errors"].map((error) => new errorItem_1.ErrorItem(error));
+        }
+        else {
+            this.errors = [];
+        }
     }
 }
 exports.ErrorResponse = ErrorResponse;

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

@@ -1,5 +1,6 @@
 export { CommonResponse } from "./commonResponse";
-export { ErrorResponse } from "./errorResponse";
+export { ErrorResponse, ErrorDetails } from "./errorResponse";
+export { ErrorItem } from "./errorItem";
 export { Inference } from "./inference";
 export { InferenceActiveOptions } from "./inferenceActiveOptions";
 export { InferenceFile } from "./inferenceFile";
@@ -10,3 +11,4 @@ export { Job } from "./job";
 export { JobResponse } from "./jobResponse";
 export { RawText } from "./rawText";
 export { JobWebhook } from "./jobWebhook";
+export { RagMetadata } from "./ragMetadata";

package/src/parsing/v2/index.js

@@ -1,10 +1,12 @@
 "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.InferenceActiveOptions = exports.Inference = exports.ErrorResponse = exports.CommonResponse = void 0;
+exports.RagMetadata = exports.JobWebhook = exports.RawText = exports.JobResponse = exports.Job = exports.InferenceResult = exports.InferenceResponse = exports.InferenceModel = exports.InferenceFile = exports.InferenceActiveOptions = exports.Inference = exports.ErrorItem = 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 errorItem_1 = require("./errorItem");
+Object.defineProperty(exports, "ErrorItem", { enumerable: true, get: function () { return errorItem_1.ErrorItem; } });
 var inference_1 = require("./inference");
 Object.defineProperty(exports, "Inference", { enumerable: true, get: function () { return inference_1.Inference; } });
 var inferenceActiveOptions_1 = require("./inferenceActiveOptions");
@@ -25,3 +27,5 @@ var rawText_1 = require("./rawText");
 Object.defineProperty(exports, "RawText", { enumerable: true, get: function () { return rawText_1.RawText; } });
 var jobWebhook_1 = require("./jobWebhook");
 Object.defineProperty(exports, "JobWebhook", { enumerable: true, get: function () { return jobWebhook_1.JobWebhook; } });
+var ragMetadata_1 = require("./ragMetadata");
+Object.defineProperty(exports, "RagMetadata", { enumerable: true, get: function () { return ragMetadata_1.RagMetadata; } });

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

@@ -1,6 +1,7 @@
 import { InferenceFields } from "./field";
 import { StringDict } from "../common";
 import { RawText } from "./rawText";
+import { RagMetadata } from "./ragMetadata";
 export declare class InferenceResult {
     /**
      * Fields contained in the inference.
@@ -10,6 +11,10 @@ export declare class InferenceResult {
      * Raw text extracted from all pages.
      */
     rawText?: RawText;
+    /**
+     * RAG metadata.
+     */
+    rag?: RagMetadata;
     constructor(serverResponse: StringDict);
     toString(): string;
 }

package/src/parsing/v2/inferenceResult.js

@@ -3,12 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InferenceResult = void 0;
 const field_1 = require("./field");
 const rawText_1 = require("./rawText");
+const ragMetadata_1 = require("./ragMetadata");
 class InferenceResult {
     constructor(serverResponse) {
         this.fields = new field_1.InferenceFields(serverResponse["fields"]);
         if (serverResponse["raw_text"]) {
             this.rawText = new rawText_1.RawText(serverResponse["raw_text"]);
         }
+        if (serverResponse["rag"]) {
+            this.rag = new ragMetadata_1.RagMetadata(serverResponse["rag"]);
+        }
     }
     toString() {
         return `Fields\n======\n${this.fields}`;

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

@@ -0,0 +1,8 @@
+import { StringDict } from "../common";
+export declare class RagMetadata {
+    /**
+     * The UUID of the matched document used during the RAG operation.
+     */
+    retrievedDocumentId?: string;
+    constructor(serverResponse: StringDict);
+}

package/src/parsing/v2/ragMetadata.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RagMetadata = void 0;
+class RagMetadata {
+    constructor(serverResponse) {
+        this.retrievedDocumentId = serverResponse["retrieved_document_id"] ?? undefined;
+    }
+}
+exports.RagMetadata = RagMetadata;