mindee 5.0.0-alpha2 → 5.0.0-rc2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 5.0.0-rc2 - 2026-01-18
+### Changes
+* :sparkles: add Job to inference responses
+### Fixes
+* :bug: fix for bin scripts
+
+
+## 5.0.0-rc1 - 2026-01-17
+### Changes
+* :boom: drop support for node.js 18
+* :boom: :recycle: separate polling options
+
+
 ## 5.0.0-alpha2 - 2026-01-16
 ### Changes
 * :recycle: use node test methods

package/package.json

@@ -1,11 +1,27 @@
 {
     "name": "mindee",
-    "version": "5.0.0-alpha2",
+    "version": "5.0.0-rc2",
     "description": "Mindee Client Library for Node.js",
-    "main": "src/index.js",
-    "bin": "bin/mindee.js",
+    "author": {
+        "name": "Mindee",
+        "email": "opensource@mindee.com",
+        "url": "https://mindee.com/"
+    },
     "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
+    },
+    "bugs": {
+        "url": "https://github.com/mindee/mindee-api-nodejs/issues"
+    },
+    "homepage": "https://mindee.com/",
     "type": "module",
+    "main": "src/index.js",
+    "bin": {
+        "mindeeV1": "bin/mindeeV1.js",
+        "mindeeV2": "bin/mindeeV2.js"
+    },
     "scripts": {
         "build": "tsc --build && tsc-alias",
         "build-for-dist": "tsc --build && tsc-alias && cp LICENSE README.md CHANGELOG.md ./dist",
@@ -28,34 +44,7 @@
         "CHANGELOG.md"
     ],
     "engines": {
-        "node": ">= 18.17"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/mindee/mindee-api-nodejs.git"
-    },
-    "author": {
-        "name": "Mindee",
-        "email": "opensource@mindee.com",
-        "url": "https://mindee.com/"
-    },
-    "bugs": {
-        "url": "https://github.com/mindee/mindee-api-nodejs/issues"
-    },
-    "homepage": "https://mindee.com/",
-    "devDependencies": {
-        "@types/mocha": "^10.0.10",
-        "@types/node": "^18.19.130",
-        "@types/tmp": "^0.2.6",
-        "@typescript-eslint/eslint-plugin": "^8.55.0",
-        "@typescript-eslint/parser": "^8.55.0",
-        "eslint": "^9.39.2",
-        "eslint-plugin-jsdoc": "^52.0.4",
-        "mocha": "^11.7.5",
-        "tsc-alias": "^1.8.16",
-        "tsx": "^4.21.0",
-        "typedoc": "~0.28.16",
-        "typescript": "^5.9.3"
+        "node": ">= 20.1"
     },
     "dependencies": {
         "commander": "~9.4.1",
@@ -65,10 +54,24 @@
         "undici": "^6.23.0"
     },
     "optionalDependencies": {
-        "sharp": "~0.34.5",
         "@cantoo/pdf-lib": "^2.3.2",
+        "node-poppler": "^7.2.4",
         "pdf.js-extract": "^0.2.1",
-        "node-poppler": "^7.2.4"
+        "sharp": "~0.34.5"
+    },
+    "devDependencies": {
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^20.19.33",
+        "@types/tmp": "^0.2.6",
+        "@typescript-eslint/eslint-plugin": "^8.56.0",
+        "@typescript-eslint/parser": "^8.56.0",
+        "eslint": "^9.39.2",
+        "eslint-plugin-jsdoc": "^62.6.0",
+        "mocha": "^11.7.5",
+        "tsc-alias": "^1.8.16",
+        "tsx": "^4.21.0",
+        "typedoc": "^0.28.17",
+        "typescript": "^5.9.3"
     },
     "keywords": [
         "typescript",

package/src/v2/client/baseParameters.d.ts

@@ -1,5 +1,3 @@
-import { ValidatedPollingOptions } from "../../v2/client/pollingOptions.js";
-import { PollingOptions } from "../../v2/index.js";
 /**
  * Constructor parameters for BaseParameters and its subclasses.
  */
@@ -7,11 +5,10 @@ export interface BaseParametersConstructor {
     modelId: string;
     alias?: string;
     webhookIds?: string[];
-    pollingOptions?: PollingOptions;
     closeFile?: boolean;
 }
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ * Parameters accepted by all v2 products.
  *
  * All fields are optional except `modelId`.
  *
@@ -22,10 +19,6 @@ export interface BaseParametersConstructor {
  *   rag: true,
  *   alias: "YOUR_ALIAS",
  *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
  * };
  */
 export declare abstract class BaseParameters {
@@ -43,21 +36,12 @@ export declare abstract class BaseParameters {
      * 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;
     protected constructor(params: BaseParametersConstructor);
-    /**
-     * Checks the values for asynchronous parsing. Returns their corrected value if they are undefined.
-     * @returns A valid `AsyncOptions`.
-     */
-    getValidatedPollingOptions(): ValidatedPollingOptions;
     /**
      * Returns the form data to send to the API.
      * @returns A `FormData` object.

package/src/v2/client/baseParameters.js

@@ -1,6 +1,6 @@
 import { MindeeConfigurationError } from "../../errors/index.js";
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ * Parameters accepted by all v2 products.
  *
  * All fields are optional except `modelId`.
  *
@@ -11,10 +11,6 @@ import { MindeeConfigurationError } from "../../errors/index.js";
  *   rag: true,
  *   alias: "YOUR_ALIAS",
  *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
  * };
  */
 export class BaseParameters {
@@ -26,42 +22,6 @@ export class BaseParameters {
         this.alias = params.alias;
         this.webhookIds = params.webhookIds;
         this.closeFile = params.closeFile;
-        this.pollingOptions = params.pollingOptions;
-    }
-    /**
-     * Checks the values for asynchronous parsing. Returns their corrected value if they are undefined.
-     * @returns A valid `AsyncOptions`.
-     */
-    getValidatedPollingOptions() {
-        const minDelaySec = 1;
-        const minInitialDelay = 1;
-        const minRetries = 2;
-        let newAsyncParams;
-        if (this.pollingOptions === undefined) {
-            newAsyncParams = {
-                delaySec: 1.5,
-                initialDelaySec: 2,
-                maxRetries: 80
-            };
-        }
-        else {
-            newAsyncParams = { ...this.pollingOptions };
-            if (!newAsyncParams.delaySec ||
-                !newAsyncParams.initialDelaySec ||
-                !newAsyncParams.maxRetries) {
-                throw Error("Invalid polling options.");
-            }
-            if (newAsyncParams.delaySec < minDelaySec) {
-                throw Error(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
-            }
-            if (newAsyncParams.initialDelaySec < minInitialDelay) {
-                throw Error(`Cannot set initial parsing delay to less than ${minInitialDelay} second(s).`);
-            }
-            if (newAsyncParams.maxRetries < minRetries) {
-                throw Error(`Cannot set retry to less than ${minRetries}.`);
-            }
-        }
-        return newAsyncParams;
     }
     /**
      * Returns the form data to send to the API.

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

@@ -1,2 +1,3 @@
-export type { PollingOptions, ValidatedPollingOptions } from "./pollingOptions.js";
+export { PollingOptions } from "./pollingOptions.js";
+export type { PollingOptionsConstructor, TimerOptions, } from "./pollingOptions.js";
 export { BaseParameters } from "./baseParameters.js";

package/src/v2/client/index.js

@@ -1 +1,2 @@
+export { PollingOptions } from "./pollingOptions.js";
 export { BaseParameters } from "./baseParameters.js";

package/src/v2/client/pollingOptions.d.ts

@@ -1,9 +1,20 @@
+export interface TimerOptions {
+    ref?: boolean;
+    signal?: AbortSignal;
+}
+export interface PollingOptionsConstructor {
+    initialDelaySec?: number;
+    delaySec?: number;
+    maxRetries?: number;
+    initialTimerOptions?: TimerOptions;
+    recurringTimerOptions?: TimerOptions;
+}
 /**
  * Parameters for the internal polling loop in `enqueueAndGetInference()`.
  *
  * Default behavior:
- * - `initialDelaySec` = 2s
- * - `delaySec` = 1.5s
+ * - `initialDelaySec` = 2
+ * - `delaySec` = 1.5
  * - `maxRetries` = 80
  *
  * Validation rules:
@@ -12,38 +23,34 @@
  * - `maxRetries` >= 2
  *
  * The `initialTimerOptions` and `recurringTimerOptions` objects let you pass an
- * `AbortSignal` or make the timer `unref`-ed to the `setTimeout()`.
+ * `AbortSignal` or make the timer `ref`-ed to the `setTimeout()`.
  *
  * @category ClientV2
  * @example
- * const params = {
+ * ```
+ * const pollingOptions = {
  *   initialDelaySec: 4,
  *   delaySec: 2,
  *   maxRetries: 50
  * };
  *
- * const inference = await client.enqueueAndGetInference(inputDoc, params);
+ * const inference = await client.enqueueAndGetInference(
+ *   inputDoc, params, pollingOptions
+ * );
+ * ```
  */
-export interface PollingOptions {
+export declare class PollingOptions {
     /** Number of seconds to wait *before the first poll*. */
-    initialDelaySec?: number;
+    initialDelaySec: number;
     /** Interval in seconds between two consecutive polls. */
-    delaySec?: number;
+    delaySec: number;
     /** Maximum number of polling attempts (including the first one). */
-    maxRetries?: number;
+    maxRetries: number;
     /** Options passed to the initial `setTimeout()`. */
-    initialTimerOptions?: {
-        ref?: boolean;
-        signal?: AbortSignal;
-    };
+    initialTimerOptions?: TimerOptions;
     /** Options passed to every recurring `setTimeout()`. */
-    recurringTimerOptions?: {
-        ref?: boolean;
-        signal?: AbortSignal;
-    };
-}
-export interface ValidatedPollingOptions extends PollingOptions {
-    initialDelaySec: number;
-    delaySec: number;
-    maxRetries: number;
+    recurringTimerOptions?: TimerOptions;
+    constructor(params?: PollingOptionsConstructor);
+    validateOptions(): void;
+    toString(): string;
 }

package/src/v2/client/pollingOptions.js

@@ -1 +1,82 @@
-export {};
+import { MindeeConfigurationError } from "../../errors/index.js";
+import { logger } from "../../logger.js";
+const minInitialDelay = 1;
+const minDelaySec = 1;
+const minRetries = 2;
+/**
+ * Parameters for the internal polling loop in `enqueueAndGetInference()`.
+ *
+ * Default behavior:
+ * - `initialDelaySec` = 2
+ * - `delaySec` = 1.5
+ * - `maxRetries` = 80
+ *
+ * Validation rules:
+ * - `initialDelaySec` >= 1
+ * - `delaySec` >= 1
+ * - `maxRetries` >= 2
+ *
+ * The `initialTimerOptions` and `recurringTimerOptions` objects let you pass an
+ * `AbortSignal` or make the timer `ref`-ed to the `setTimeout()`.
+ *
+ * @category ClientV2
+ * @example
+ * ```
+ * const pollingOptions = {
+ *   initialDelaySec: 4,
+ *   delaySec: 2,
+ *   maxRetries: 50
+ * };
+ *
+ * const inference = await client.enqueueAndGetInference(
+ *   inputDoc, params, pollingOptions
+ * );
+ * ```
+ */
+export class PollingOptions {
+    constructor(params) {
+        if (!params) {
+            params = {};
+        }
+        if (!params.initialDelaySec) {
+            this.initialDelaySec = 2;
+        }
+        else {
+            this.initialDelaySec = params.initialDelaySec;
+        }
+        if (!params.delaySec) {
+            this.delaySec = 1.5;
+        }
+        else {
+            this.delaySec = params.delaySec;
+        }
+        if (!params.maxRetries) {
+            this.maxRetries = 80;
+        }
+        else {
+            this.maxRetries = params.maxRetries;
+        }
+        if (params.initialTimerOptions) {
+            this.initialTimerOptions = params.initialTimerOptions;
+        }
+        if (params.recurringTimerOptions) {
+            this.recurringTimerOptions = params.recurringTimerOptions;
+        }
+        this.validateOptions();
+        logger.debug(`Polling options initialized: ${this.toString()}`);
+    }
+    validateOptions() {
+        if (this.delaySec < minDelaySec) {
+            throw new MindeeConfigurationError(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
+        }
+        if (this.initialDelaySec < minInitialDelay) {
+            throw new MindeeConfigurationError(`Cannot set initial parsing delay to less than ${minInitialDelay} second(s).`);
+        }
+        if (this.maxRetries < minRetries) {
+            throw new MindeeConfigurationError(`Cannot set retry to less than ${minRetries}.`);
+        }
+    }
+    toString() {
+        return `{ initialDelaySec: ${this.initialDelaySec}, delaySec: ${this.delaySec}, maxRetries: ${this.maxRetries} }`;
+    }
+}

package/src/v2/client.d.ts

@@ -2,7 +2,7 @@ import { Dispatcher } from "undici";
 import { InputSource } from "../input/index.js";
 import { JobResponse } from "./parsing/index.js";
 import { MindeeApiV2 } from "./http/mindeeApiV2.js";
-import { ValidatedPollingOptions } from "./client/index.js";
+import { PollingOptions, PollingOptionsConstructor } from "./client/index.js";
 import { BaseProduct } from "../v2/product/baseProduct.js";
 /**
  * Options for the V2 Mindee Client.
@@ -65,15 +65,16 @@ export declare class Client {
      * @param inputSource file or URL to parse.
      * @param params parameters relating to prediction options.
      *
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
      * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
      * @category Synchronous
      * @returns a `Promise` containing parsing results.
      */
-    enqueueAndGetResult<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0]): Promise<InstanceType<P["responseClass"]>>;
+    enqueueAndGetResult<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0], pollingOptions?: PollingOptionsConstructor): Promise<InstanceType<P["responseClass"]>>;
     /**
      * Send a document to an endpoint and poll the server until the result is sent or
      * until the maximum number of tries is reached.
      * @protected
      */
-    protected pollForResult<P extends typeof BaseProduct>(product: typeof BaseProduct, pollingOptions: ValidatedPollingOptions, queueId: string): Promise<InstanceType<P["responseClass"]>>;
+    protected pollForResult<P extends typeof BaseProduct>(product: typeof BaseProduct, pollingOptions: PollingOptions, queueId: string): Promise<InstanceType<P["responseClass"]>>;
 }

package/src/v2/client.js

@@ -4,6 +4,7 @@ import { errorHandler } from "../errors/handler.js";
 import { LOG_LEVELS, logger } from "../logger.js";
 import { MindeeApiV2 } from "./http/mindeeApiV2.js";
 import { MindeeHttpErrorV2 } from "./http/errors.js";
+import { PollingOptions } from "./client/index.js";
 /**
  * Mindee Client V2 class that centralizes most basic operations.
  *
@@ -76,15 +77,16 @@ export class Client {
      * @param inputSource file or URL to parse.
      * @param params parameters relating to prediction options.
      *
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
      * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
      * @category Synchronous
      * @returns a `Promise` containing parsing results.
      */
-    async enqueueAndGetResult(product, inputSource, params) {
+    async enqueueAndGetResult(product, inputSource, params, pollingOptions) {
         const paramsInstance = new product.parametersClass(params);
-        const pollingOptions = paramsInstance.getValidatedPollingOptions();
+        const pollingOptionsInstance = new PollingOptions(pollingOptions);
         const jobResponse = await this.enqueue(product, inputSource, paramsInstance);
-        return await this.pollForResult(product, pollingOptions, jobResponse.job.id);
+        return await this.pollForResult(product, pollingOptionsInstance, jobResponse.job.id);
     }
     /**
      * Send a document to an endpoint and poll the server until the result is sent or
@@ -114,8 +116,7 @@ export class Client {
             await setTimeout(pollingOptions.delaySec * 1000, undefined, pollingOptions.recurringTimerOptions);
             retryCounter++;
         }
-        throw new MindeeError("Asynchronous parsing request timed out after " +
-            pollingOptions.delaySec * retryCounter +
-            " seconds");
+        throw new MindeeError(`Polling failed to retrieve a result after ${retryCounter} attempts. ` +
+            "You can increase poll attempts by passing the pollingOptions argument to enqueueAndGetResult()");
     }
 }

package/src/v2/http/{apiSettingsV2.d.ts → apiSettings.d.ts}

@@ -1,5 +1,5 @@
 import { BaseSettings, MindeeApiConstructorProps } from "../../http/baseSettings.js";
-export declare class ApiSettingsV2 extends BaseSettings {
+export declare class ApiSettings extends BaseSettings {
     baseHeaders: Record<string, string>;
     constructor({ apiKey, dispatcher, }: MindeeApiConstructorProps);
     protected apiKeyFromEnv(): string;

package/src/v2/http/{apiSettingsV2.js → apiSettings.js}

@@ -4,7 +4,7 @@ import { MindeeConfigurationError } from "../../errors/index.js";
 const API_V2_KEY_ENVVAR_NAME = "MINDEE_V2_API_KEY";
 const API_V2_HOST_ENVVAR_NAME = "MINDEE_V2_API_HOST";
 const DEFAULT_MINDEE_API_HOST = "api-v2.mindee.net";
-export class ApiSettingsV2 extends BaseSettings {
+export class ApiSettings extends BaseSettings {
     constructor({ apiKey, dispatcher, }) {
         super(apiKey, dispatcher);
         if (!this.apiKey || this.apiKey.length === 0) {
@@ -16,6 +16,7 @@ export class ApiSettingsV2 extends BaseSettings {
             "User-Agent": this.getUserAgent(),
             Authorization: `${this.apiKey}`,
         };
+        /* eslint-enable @typescript-eslint/naming-convention */
     }
     apiKeyFromEnv() {
         const envVarValue = process.env[API_V2_KEY_ENVVAR_NAME];

package/src/v2/http/errors.d.ts

@@ -1,5 +1,8 @@
 import { ErrorDetails, ErrorItem, ErrorResponse } from "../../v2/parsing/index.js";
 import { MindeeError } from "../../errors/index.js";
+/**
+ * HTTP error returned by the API.
+ */
 export declare class MindeeHttpErrorV2 extends MindeeError implements ErrorDetails {
     status: number;
     detail: string;

package/src/v2/http/errors.js

@@ -1,4 +1,7 @@
 import { MindeeError } from "../../errors/index.js";
+/**
+ * HTTP error returned by the API.
+ */
 export class MindeeHttpErrorV2 extends MindeeError {
     constructor(error) {
         super(`HTTP ${error.status} - ${error.title} :: ${error.code} - ${error.detail}`);

package/src/v2/http/mindeeApiV2.d.ts

@@ -1,4 +1,4 @@
-import { ApiSettingsV2 } from "./apiSettingsV2.js";
+import { ApiSettings } from "./apiSettings.js";
 import { Dispatcher } from "undici";
 import { BaseParameters } from "../../v2/client/index.js";
 import { JobResponse } from "../../v2/parsing/index.js";
@@ -6,7 +6,7 @@ import { InputSource } from "../../input/index.js";
 import { BaseProduct } from "../../v2/product/baseProduct.js";
 export declare class MindeeApiV2 {
     #private;
-    settings: ApiSettingsV2;
+    settings: ApiSettings;
     constructor(dispatcher?: Dispatcher, apiKey?: string);
     /**
      * Sends a file to the extraction inference queue.

package/src/v2/http/mindeeApiV2.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _MindeeApiV2_instances, _MindeeApiV2_processResponse, _MindeeApiV2_reqPostProductEnqueue, _MindeeApiV2_reqGetJob, _MindeeApiV2_reqGetProductResult;
-import { ApiSettingsV2 } from "./apiSettingsV2.js";
+import { ApiSettings } from "./apiSettings.js";
 import { ErrorResponse, JobResponse, } from "../../v2/parsing/index.js";
 import { sendRequestAndReadResponse } from "../../http/apiCore.js";
 import { LocalInputSource } from "../../input/index.js";
@@ -14,7 +14,7 @@ import { logger } from "../../logger.js";
 export class MindeeApiV2 {
     constructor(dispatcher, apiKey) {
         _MindeeApiV2_instances.add(this);
-        this.settings = new ApiSettingsV2({ dispatcher: dispatcher, apiKey: apiKey });
+        this.settings = new ApiSettings({ dispatcher: dispatcher, apiKey: apiKey });
     }
     /**
      * Sends a file to the extraction inference queue.
@@ -58,7 +58,8 @@ export class MindeeApiV2 {
     }
 }
 _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseClass) {
-    if (result.messageObj?.statusCode && (result.messageObj?.statusCode > 399 || result.messageObj?.statusCode < 200)) {
+    if (result.messageObj?.statusCode
+        && (result.messageObj?.statusCode > 399 || result.messageObj?.statusCode < 200)) {
         if (result.data?.status !== null) {
             throw new MindeeHttpErrorV2(new ErrorResponse(result.data));
         }

package/src/v2/index.d.ts

@@ -3,4 +3,5 @@ export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
 export { Client } from "./client.js";
 export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";
-export type { PollingOptions, BaseParameters } from "./client/index.js";
+export type { BaseParameters, TimerOptions } from "./client/index.js";
+export { PollingOptions } from "./client/index.js";

package/src/v2/index.js

@@ -3,3 +3,4 @@ export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
 export { Client } from "./client.js";
 export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";
+export { PollingOptions } from "./client/index.js";

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

@@ -1,11 +1,16 @@
+import { StringDict } from "../../../parsing/index.js";
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
-import { StringDict } from "../../../parsing/index.js";
+import { InferenceJob } from "./inferenceJob.js";
 export declare abstract class BaseInference {
     /**
      * Model info for the inference.
      */
     model: InferenceModel;
+    /**
+     * Job the inference belongs to.
+     */
+    job: InferenceJob;
     /**
      * File info for the inference.
      */

package/src/v2/parsing/inference/baseInference.js

@@ -1,8 +1,10 @@
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
+import { InferenceJob } from "./inferenceJob.js";
 export class BaseInference {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
+        this.job = new InferenceJob(serverResponse["job"]);
         this.model = new InferenceModel(serverResponse["model"]);
         this.file = new InferenceFile(serverResponse["file"]);
     }

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

@@ -0,0 +1,9 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+export declare class InferenceJob {
+    /**
+     * UUID of the Job.
+     */
+    id: string;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/parsing/inference/inferenceJob.js

@@ -0,0 +1,10 @@
+export class InferenceJob {
+    constructor(serverResponse) {
+        this.id = serverResponse["id"];
+    }
+    toString() {
+        return ("Job\n" +
+            "===\n" +
+            `:ID: ${this.id}\n`);
+    }
+}

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

@@ -1,5 +1,10 @@
 import { BaseParameters } from "../../v2/client/index.js";
 import { ResponseConstructor } from "../../v2/parsing/index.js";
+/**
+ * Base class for all V2 product definitions.
+ *
+ * Child classes are passed to the Client when making requests.
+ */
 export declare abstract class BaseProduct {
     static get parametersClass(): new (...args: any[]) => BaseParameters;
     static get responseClass(): ResponseConstructor<any>;

package/src/v2/product/baseProduct.js

@@ -1,3 +1,8 @@
+/**
+ * Base class for all V2 product definitions.
+ *
+ * Child classes are passed to the Client when making requests.
+ */
 export class BaseProduct {
     static get parametersClass() {
         throw new Error("Must define static parameters property");

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

@@ -1,6 +1,9 @@
 import { ClassificationResponse } from "./classificationResponse.js";
 import { ClassificationParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically sort any image or scanned document into categories.
+ */
 export declare class Classification extends BaseProduct {
     static get parametersClass(): typeof ClassificationParameters;
     static get responseClass(): typeof ClassificationResponse;

package/src/v2/product/classification/classification.js

@@ -1,6 +1,9 @@
 import { ClassificationResponse } from "./classificationResponse.js";
 import { ClassificationParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically sort any image or scanned document into categories.
+ */
 export class Classification extends BaseProduct {
     static get parametersClass() {
         return ClassificationParameters;

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

@@ -1,6 +1,9 @@
 import { CropResponse } from "./cropResponse.js";
 import { CropParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Identify the borders of documents on each page, matching each one to a category.
+ */
 export declare class Crop extends BaseProduct {
     static get parametersClass(): typeof CropParameters;
     static get responseClass(): typeof CropResponse;

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

@@ -1,6 +1,9 @@
 import { CropResponse } from "./cropResponse.js";
 import { CropParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Identify the borders of documents on each page, matching each one to a category.
+ */
 export class Crop extends BaseProduct {
     static get parametersClass() {
         return CropParameters;

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

@@ -1,6 +1,9 @@
 import { ExtractionResponse } from "./extractionResponse.js";
 import { ExtractionParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically extract structured data from any image or scanned document.
+ */
 export declare class Extraction extends BaseProduct {
     static get parametersClass(): typeof ExtractionParameters;
     static get responseClass(): typeof ExtractionResponse;

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

@@ -1,6 +1,9 @@
 import { ExtractionResponse } from "./extractionResponse.js";
 import { ExtractionParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Automatically extract structured data from any image or scanned document.
+ */
 export class Extraction extends BaseProduct {
     static get parametersClass() {
         return ExtractionParameters;

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

@@ -1,6 +1,9 @@
 import { OcrResponse } from "./ocrResponse.js";
 import { OcrParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Extract raw text (OCR) from any image or scanned document.
+ */
 export declare class Ocr extends BaseProduct {
     static get parametersClass(): typeof OcrParameters;
     static get responseClass(): typeof OcrResponse;

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

@@ -1,6 +1,9 @@
 import { OcrResponse } from "./ocrResponse.js";
 import { OcrParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Extract raw text (OCR) from any image or scanned document.
+ */
 export class Ocr extends BaseProduct {
     static get parametersClass() {
         return OcrParameters;

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

@@ -1,6 +1,9 @@
 import { SplitResponse } from "./splitResponse.js";
 import { SplitParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Break a multipage source file into separate documents, associating a class for each one.
+ */
 export declare class Split extends BaseProduct {
     static get parametersClass(): typeof SplitParameters;
     static get responseClass(): typeof SplitResponse;

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

@@ -1,6 +1,9 @@
 import { SplitResponse } from "./splitResponse.js";
 import { SplitParameters } from "./params/index.js";
 import { BaseProduct } from "../../../v2/product/baseProduct.js";
+/**
+ * Break a multipage source file into separate documents, associating a class for each one.
+ */
 export class Split extends BaseProduct {
     static get parametersClass() {
         return SplitParameters;