mindee 4.28.0 → 4.29.0-rc1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## v4.29.0-rc1 - 2025-07-21
+### Changes
+* :sparkles: add support for V2 client
+* :recycle: tweak CI & testing
+* :recycle: deprecate `cutPdf()` in favor of `applyPageOperations()` in `LocalInputSource`
+* :recycle: refactor some internals to account for new changes
+
+### Fixes
+* :bug: fix bug where polling parameters could ignore validation checks on V1
+
+
 ## v4.28.0 - 2025-06-03
 ### Changes
 * :sparkles: add support for address fields

package/README.md

@@ -154,27 +154,6 @@ const apiResponse = mindeeClient.parse(
   });
 ```
 
-## Further Reading
-Complete details on the working of the library are available in the following guides: 
-
-* [Node.js Getting Started](https://developers.mindee.com/docs/nodejs-getting-started)
-* [Node.js Generated API](https://developers.mindee.com/docs/nodejs-generated-ocr)
-* [Node.js Custom OCR (Deprecated)](https://developers.mindee.com/docs/nodejs-api-builder)
-* [Node.js Invoice OCR](https://developers.mindee.com/docs/nodejs-invoice-ocr)
-* [Node.js International Id OCR](https://developers.mindee.com/docs/nodejs-international-id-ocr)
-* [Node.js Receipt OCR](https://developers.mindee.com/docs/nodejs-receipt-ocr)
-* [Node.js Resume OCR](https://developers.mindee.com/docs/nodejs-resume-ocr)
-* [Node.js Financial Document OCR](https://developers.mindee.com/docs/nodejs-financial-document-ocr)
-* [Node.js Passport OCR](https://developers.mindee.com/docs/nodejs-passport-ocr)
-* [Node.js FR Bank Account Detail OCR](https://developers.mindee.com/docs/nodejs-fr-bank-account-details-ocr)
-* [Node.js FR Health Card OCR](https://developers.mindee.com/docs/nodejs-fr-health-card-ocr)
-* [Node.js FR ID Card OCR](https://developers.mindee.com/docs/nodejs-fr-carte-nationale-didentite-ocr)
-* [Node.js US Bank Check OCR](https://developers.mindee.com/docs/nodejs-us-bank-check-ocr)
-* [Node.js Barcode Reader API](https://developers.mindee.com/docs/nodejs-barcode-reader-ocr)
-* [Node.js Cropper API](https://developers.mindee.com/docs/nodejs-cropper-ocr)
-* [Node.js Invoice Splitter API](https://developers.mindee.com/docs/nodejs-invoice-splitter-ocr)
-* [Node.js Multi Receipts Detector API](https://developers.mindee.com/docs/nodejs-multi-receipts-detector-ocr)
-
 You can also take a look at the **[Reference Documentation](https://mindee.github.io/mindee-api-nodejs/)**.
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mindee",
-    "version": "4.28.0",
+    "version": "4.29.0-rc1",
     "description": "Mindee Client Library for Node.js",
     "main": "src/index.js",
     "bin": "bin/mindee.js",
@@ -9,8 +9,8 @@
         "build": "tsc --build",
         "build-for-dist": "tsc --build && cp LICENSE README.md CHANGELOG.md ./dist",
         "clean": "rm -rf ./dist ./docs/_build",
-        "test": "mocha 'tests/**/*.spec.ts' --config .mocharc.json",
-        "test-integration": "mocha 'tests/**/*.integration.ts'",
+        "test": "mocha \"tests/**/*.spec.ts\" --config .mocharc.json",
+        "test-integration": "mocha \"tests/**/*.integration.ts\"",
         "lint": "eslint  './src/**/*.ts' --report-unused-disable-directives && echo 'Your .ts files look good.'",
         "lint-fix": "eslint './src/**/*.ts' --fix",
         "docs": "typedoc --out docs/_build ./src/index.ts",
@@ -44,15 +44,15 @@
         "@types/mocha": "^10.0.10",
         "@types/node": "^18.15.11",
         "@types/tmp": "^0.2.6",
-        "@typescript-eslint/eslint-plugin": "^8.15.0",
-        "@typescript-eslint/parser": "^8.15.0",
+        "@typescript-eslint/eslint-plugin": "^8.36.0",
+        "@typescript-eslint/parser": "^8.36.0",
         "chai": "^4.3.10",
         "eslint": "^9.15.0",
         "eslint-plugin-jsdoc": "^50.5.0",
-        "mocha": "^11.1.0",
+        "mocha": "^11.7.1",
         "nock": "^13.5.6",
         "ts-node": "^10.9.2",
-        "typedoc": "~0.26.11",
+        "typedoc": "~0.28.7",
         "typescript": "^5.6.3"
     },
     "dependencies": {

package/src/baseClient.d.ts

@@ -0,0 +1,38 @@
+import { Base64Input, BufferInput, BytesInput, PathInput, StreamInput, UrlInput } from "./input";
+import { Readable } from "stream";
+export declare abstract class BaseClient {
+    /**
+     * Load an input document from a local path.
+     * @param inputPath
+     */
+    docFromPath(inputPath: string): PathInput;
+    /**
+     * Load an input document from a base64 encoded string.
+     * @param inputString input content, as a string.
+     * @param filename file name.
+     */
+    docFromBase64(inputString: string, filename: string): Base64Input;
+    /**
+     * Load an input document from a `stream.Readable` object.
+     * @param inputStream input content, as a readable stream.
+     * @param filename file name.
+     */
+    docFromStream(inputStream: Readable, filename: string): StreamInput;
+    /**
+     * Load an input document from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
+     * @param filename file name.
+     */
+    docFromBytes(inputBytes: Uint8Array, filename: string): BytesInput;
+    /**
+     * Load an input document from a URL.
+     * @param url input url. Must be HTTPS.
+     */
+    docFromUrl(url: string): UrlInput;
+    /**
+     * Load an input document from a Buffer.
+     * @param buffer input content, as a buffer.
+     * @param filename file name.
+     */
+    docFromBuffer(buffer: Buffer, filename: string): BufferInput;
+}

package/src/baseClient.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseClient = void 0;
+const input_1 = require("./input");
+class BaseClient {
+    /**
+     * Load an input document from a local path.
+     * @param inputPath
+     */
+    docFromPath(inputPath) {
+        return new input_1.PathInput({
+            inputPath: inputPath,
+        });
+    }
+    /**
+     * Load an input document from a base64 encoded string.
+     * @param inputString input content, as a string.
+     * @param filename file name.
+     */
+    docFromBase64(inputString, filename) {
+        return new input_1.Base64Input({
+            inputString: inputString,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input document from a `stream.Readable` object.
+     * @param inputStream input content, as a readable stream.
+     * @param filename file name.
+     */
+    docFromStream(inputStream, filename) {
+        return new input_1.StreamInput({
+            inputStream: inputStream,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input document from bytes.
+     * @param inputBytes input content, as a Uint8Array or Buffer.
+     * @param filename file name.
+     */
+    docFromBytes(inputBytes, filename) {
+        return new input_1.BytesInput({
+            inputBytes: inputBytes,
+            filename: filename,
+        });
+    }
+    /**
+     * Load an input document from a URL.
+     * @param url input url. Must be HTTPS.
+     */
+    docFromUrl(url) {
+        return new input_1.UrlInput({
+            url: url,
+        });
+    }
+    /**
+     * Load an input document from a Buffer.
+     * @param buffer input content, as a buffer.
+     * @param filename file name.
+     */
+    docFromBuffer(buffer, filename) {
+        return new input_1.BufferInput({
+            buffer: buffer,
+            filename: filename,
+        });
+    }
+}
+exports.BaseClient = BaseClient;

package/src/cli.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cli = cli;
 const commander_1 = require("commander");

package/src/cliProducts.js

@@ -20,13 +20,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CLI_COMMAND_CONFIG = exports.COMMAND_GENERATED = exports.COMMAND_CUSTOM = void 0;
 const product = __importStar(require("./product"));

package/src/client.d.ts

@@ -1,9 +1,9 @@
-import { Readable } from "stream";
-import { Base64Input, BufferInput, BytesInput, InputSource, LocalResponse, PageOptions, PathInput, StreamInput, UrlInput } from "./input";
+import { InputSource, LocalResponse, PageOptions } from "./input";
 import { Endpoint } from "./http";
 import { AsyncPredictResponse, ExecutionPriority, FeedbackResponse, Inference, PredictResponse, StringDict } from "./parsing/common";
 import { GeneratedV1 } from "./product";
 import { WorkflowResponse } from "./parsing/common/workflowResponse";
+import { BaseClient } from "./baseClient";
 /**
  * Common options for workflows & predictions.
  */
@@ -103,7 +103,7 @@ export interface ClientOptions {
  *
  * @category Client
  */
-export declare class Client {
+export declare class Client extends BaseClient {
     #private;
     /** Key of the API. */
     protected apiKey: string;
@@ -211,39 +211,5 @@ export declare class Client {
      * @returns Endpoint a new product endpoint
      */
     createEndpoint(endpointName: string, accountName: string, endpointVersion?: string): Endpoint;
-    /**
-     * Load an input document from a local path.
-     * @param inputPath
-     */
-    docFromPath(inputPath: string): PathInput;
-    /**
-     * Load an input document from a base64 encoded string.
-     * @param inputString input content, as a string.
-     * @param filename file name.
-     */
-    docFromBase64(inputString: string, filename: string): Base64Input;
-    /**
-     * Load an input document from a `stream.Readable` object.
-     * @param inputStream input content, as a readable stream.
-     * @param filename file name.
-     */
-    docFromStream(inputStream: Readable, filename: string): StreamInput;
-    /**
-     * Load an input document from bytes.
-     * @param inputBytes input content, as a Uint8Array or Buffer.
-     * @param filename file name.
-     */
-    docFromBytes(inputBytes: Uint8Array, filename: string): BytesInput;
-    /**
-     * Load an input document from a URL.
-     * @param url input url. Must be HTTPS.
-     */
-    docFromUrl(url: string): UrlInput;
-    /**
-     * Load an input document from a Buffer.
-     * @param buffer input content, as a buffer.
-     * @param filename file name.
-     */
-    docFromBuffer(buffer: Buffer, filename: string): BufferInput;
 }
 export {};

package/src/client.js

@@ -7,7 +7,6 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _Client_instances, _Client_setAsyncParams, _Client_buildProductEndpoint, _Client_buildApiSettings, _Client_initializeOTSEndpoint, _Client_cleanAccountName, _Client_getOtsEndpoint;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
-const input_1 = require("./input");
 const http_1 = require("./http");
 const common_1 = require("./parsing/common");
 const handler_1 = require("./errors/handler");
@@ -18,12 +17,13 @@ const promises_1 = require("node:timers/promises");
 const errors_1 = require("./errors");
 const workflowResponse_1 = require("./parsing/common/workflowResponse");
 const workflowEndpoint_1 = require("./http/workflowEndpoint");
+const baseClient_1 = require("./baseClient");
 /**
  * Mindee Client class that centralizes most basic operations.
  *
  * @category Client
  */
-class Client {
+class Client extends baseClient_1.BaseClient {
     /**
      * @param {ClientOptions} options options for the initialization of a client.
      */
@@ -32,6 +32,7 @@ class Client {
         throwOnError: true,
         debug: false,
     }) {
+        super();
         _Client_instances.add(this);
         this.apiKey = apiKey ? apiKey : "";
         handler_1.errorHandler.throwOnError = throwOnError ?? true;
@@ -82,7 +83,7 @@ class Client {
     async enqueue(productClass, inputSource, params = {}) {
         const endpoint = params?.endpoint ?? __classPrivateFieldGet(this, _Client_instances, "m", _Client_initializeOTSEndpoint).call(this, productClass);
         if (inputSource === undefined) {
-            throw new Error("The 'parse' function requires an input document.");
+            throw new Error("The 'enqueue' function requires an input document.");
         }
         const rawResponse = await endpoint.predictAsync({
             inputDoc: inputSource,
@@ -141,7 +142,7 @@ class Client {
     async executeWorkflow(inputSource, workflowId, params = {}) {
         const workflowEndpoint = new workflowEndpoint_1.WorkflowEndpoint(__classPrivateFieldGet(this, _Client_instances, "m", _Client_buildApiSettings).call(this), workflowId);
         if (inputSource === undefined) {
-            throw new Error("The 'parse' function requires an input document.");
+            throw new Error("The 'executeWorkflow' function requires an input document.");
         }
         const rawResponse = await workflowEndpoint.executeWorkflow({
             inputDoc: inputSource,
@@ -210,25 +211,25 @@ class Client {
         recurringTimerOptions: undefined,
     }) {
         const validatedAsyncParams = __classPrivateFieldGet(this, _Client_instances, "m", _Client_setAsyncParams).call(this, asyncParams);
-        const enqueueResponse = await this.enqueue(productClass, inputSource, asyncParams);
+        const enqueueResponse = await this.enqueue(productClass, inputSource, validatedAsyncParams);
         if (enqueueResponse.job.id === undefined || enqueueResponse.job.id.length === 0) {
             throw Error("Enqueueing of the document failed.");
         }
         const queueId = enqueueResponse.job.id;
         logger_1.logger.debug(`Successfully enqueued document with job id: ${queueId}.`);
-        await (0, promises_1.setTimeout)(validatedAsyncParams.initialDelaySec * 1000, undefined, asyncParams.initialTimerOptions);
+        await (0, promises_1.setTimeout)(validatedAsyncParams.initialDelaySec * 1000, undefined, validatedAsyncParams.initialTimerOptions);
         let retryCounter = 1;
         let pollResults;
-        pollResults = await this.parseQueued(productClass, queueId, asyncParams);
+        pollResults = await this.parseQueued(productClass, queueId, validatedAsyncParams);
         while (retryCounter < validatedAsyncParams.maxRetries) {
             logger_1.logger.debug(`Polling server for parsing result with queueId: ${queueId}.
-Attempt n°${retryCounter}/${asyncParams.maxRetries}.
+Attempt n°${retryCounter}/${validatedAsyncParams.maxRetries}.
 Job status: ${pollResults.job.status}.`);
             if (pollResults.job.status === "completed") {
                 break;
             }
-            await (0, promises_1.setTimeout)(validatedAsyncParams.delaySec * 1000, undefined, asyncParams.recurringTimerOptions);
-            pollResults = await this.parseQueued(productClass, queueId, asyncParams);
+            await (0, promises_1.setTimeout)(validatedAsyncParams.delaySec * 1000, undefined, validatedAsyncParams.recurringTimerOptions);
+            pollResults = await this.parseQueued(productClass, queueId, validatedAsyncParams);
             retryCounter++;
         }
         if (pollResults.job.status !== "completed") {
@@ -270,68 +271,6 @@ Job status: ${pollResults.job.status}.`);
         }
         return __classPrivateFieldGet(this, _Client_instances, "m", _Client_buildProductEndpoint).call(this, endpointName, cleanAccountName, cleanEndpointVersion);
     }
-    /**
-     * Load an input document from a local path.
-     * @param inputPath
-     */
-    docFromPath(inputPath) {
-        return new input_1.PathInput({
-            inputPath: inputPath,
-        });
-    }
-    /**
-     * Load an input document from a base64 encoded string.
-     * @param inputString input content, as a string.
-     * @param filename file name.
-     */
-    docFromBase64(inputString, filename) {
-        return new input_1.Base64Input({
-            inputString: inputString,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input document from a `stream.Readable` object.
-     * @param inputStream input content, as a readable stream.
-     * @param filename file name.
-     */
-    docFromStream(inputStream, filename) {
-        return new input_1.StreamInput({
-            inputStream: inputStream,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input document from bytes.
-     * @param inputBytes input content, as a Uint8Array or Buffer.
-     * @param filename file name.
-     */
-    docFromBytes(inputBytes, filename) {
-        return new input_1.BytesInput({
-            inputBytes: inputBytes,
-            filename: filename,
-        });
-    }
-    /**
-     * Load an input document from a URL.
-     * @param url input url. Must be HTTPS.
-     */
-    docFromUrl(url) {
-        return new input_1.UrlInput({
-            url: url,
-        });
-    }
-    /**
-     * Load an input document from a Buffer.
-     * @param buffer input content, as a buffer.
-     * @param filename file name.
-     */
-    docFromBuffer(buffer, filename) {
-        return new input_1.BufferInput({
-            buffer: buffer,
-            filename: filename,
-        });
-    }
 }
 exports.Client = Client;
 _Client_instances = new WeakSet(), _Client_setAsyncParams = function _Client_setAsyncParams(asyncParams) {

package/src/clientV2.d.ts

@@ -0,0 +1,156 @@
+import { LocalInputSource } from "./input";
+import { InferenceResponse, JobResponse } from "./parsing/v2";
+import { MindeeApiV2 } from "./http/mindeeApiV2";
+import { BaseClient } from "./baseClient";
+/**
+ * Parameters for the internal polling loop in {@link ClientV2.enqueueAndGetInference | enqueueAndGetInference()} .
+ *
+ * Default behavior:
+ * - `initialDelaySec` = 2s
+ * - `delaySec` = 1.5s
+ * - `maxRetries` = 80
+ *
+ * Validation rules:
+ * - `initialDelaySec` >= 1
+ * - `delaySec` >= 1
+ * - `maxRetries` >= 2
+ *
+ * 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 = {
+ *   initialDelaySec: 4,
+ *   delaySec: 2,
+ *   maxRetries: 50
+ * };
+ *
+ * const inference = await client.enqueueAndGetInference(inputDoc, params);
+ */
+export interface PollingOptions {
+    initialDelaySec?: number;
+    delaySec?: number;
+    maxRetries?: number;
+    initialTimerOptions?: {
+        ref?: boolean;
+        signal?: AbortSignal;
+    };
+    recurringTimerOptions?: {
+        ref?: boolean;
+        signal?: AbortSignal;
+    };
+}
+/**
+ * Parameters accepted by the asynchronous **inference** v2 endpoint.
+ *
+ * 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 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 = {
+ *   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 interface InferenceParameters {
+    modelId: string;
+    rag?: boolean;
+    alias?: string;
+    webhookIds?: string[];
+    pollingOptions?: PollingOptions;
+    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({
+ *   apiKey: "YOUR_API_KEY",
+ *   throwOnError: true,
+ *   debug: false
+ * });
+ */
+export interface ClientOptions {
+    apiKey?: string;
+    throwOnError?: boolean;
+    debug?: boolean;
+}
+/**
+ * Mindee Client V2 class that centralizes most basic operations.
+ *
+ * @category ClientV2
+ */
+export declare class ClientV2 extends BaseClient {
+    #private;
+    /** Key of the API. */
+    protected mindeeApi: MindeeApiV2;
+    /**
+     * @param {ClientOptions} options options for the initialization of a client.
+     */
+    constructor({ apiKey, throwOnError, debug }?: ClientOptions);
+    /**
+     * Send the document to an asynchronous endpoint and return its ID in the queue.
+     * @param inputSource file to parse.
+     * @param params parameters relating to prediction options.
+     * @category Asynchronous
+     * @returns a `Promise` containing the job (queue) corresponding to a document.
+     */
+    enqueueInference(inputSource: LocalInputSource, params: InferenceParameters): Promise<JobResponse>;
+    /**
+     * Retrieves an inference.
+     *
+     * @param inferenceId id of the queue to poll.
+     * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
+     * @category Asynchronous
+     * @returns a `Promise` containing a `Job`, which also contains a `Document` if the
+     * parsing is complete.
+     */
+    getInference(inferenceId: string): Promise<InferenceResponse>;
+    /**
+     * Get the status of an inference that was previously enqueued.
+     * Can be used for polling.
+     *
+     * @param jobId id of the queue to poll.
+     * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
+     * @category Asynchronous
+     * @returns a `Promise` containing a `Job`, which also contains a `Document` if the
+     * parsing is complete.
+     */
+    getJob(jobId: string): Promise<JobResponse>;
+    /**
+     * Send a document to an endpoint and poll the server until the result is sent or
+     * until the maximum number of tries is reached.
+     *
+     * @param inputDoc document to parse.
+     * @param params parameters relating to prediction options.
+     *
+     * @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.
+     */
+    enqueueAndGetInference(inputDoc: LocalInputSource, params: InferenceParameters): Promise<InferenceResponse>;
+}