mindee 4.36.3 → 5.0.0-alpha2

package/src/clientV2.d.ts

@@ -1,176 +0,0 @@
-import { DataSchema, InputSource } from "./input";
-import { InferenceResponse, JobResponse } from "./parsing/v2";
-import { MindeeApiV2 } from "./http/mindeeApiV2";
-import { StringDict } from "./parsing/common";
-/**
- * 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()`.
- *
- * @category ClientV2
- * @example
- * const params = {
- *   initialDelaySec: 4,
- *   delaySec: 2,
- *   maxRetries: 50
- * };
- *
- * 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;
-    };
-}
-/**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
- *
- * All fields are optional except `modelId`.
- *
- * @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 {
-    /** 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;
-    /**
-     * Dynamic changes to the data schema of the model for this inference.
-     * Not recommended, for specific use only.
-     */
-    dataSchema?: DataSchema | StringDict | string;
-}
-/**
- * Options for the V2 Mindee Client.
- *
- * @category ClientV2
- * @example
- * const client = new MindeeClientV2({
- *   apiKey: "YOUR_API_KEY",
- *   throwOnError: true,
- *   debug: false
- * });
- */
-export interface ClientOptions {
-    /** Your API key for all endpoints. */
-    apiKey?: string;
-    /** Raise an `Error` on errors. */
-    throwOnError?: boolean;
-    /** Log debug messages. */
-    debug?: boolean;
-}
-/**
- * Mindee Client V2 class that centralizes most basic operations.
- *
- * @category ClientV2
- */
-export declare class ClientV2 {
-    #private;
-    /** Mindee API handler. */
-    protected mindeeApi: MindeeApiV2;
-    /**
-     * @param {ClientOptions} options options for the initialization of a client.
-     */
-    constructor({ apiKey, throwOnError, debug }?: ClientOptions);
-    /**
-     * Checks the Data Schema.
-     * @param params Input Inference parameters.
-     */
-    validateDataSchema(params: InferenceParameters): void;
-    /**
-     * Send the document to an asynchronous endpoint and return its ID in the queue.
-     * @param inputSource file or URL to parse.
-     * @param params parameters relating to prediction options.
-     * @category Asynchronous
-     * @returns a `Promise` containing the job (queue) corresponding to a document.
-     */
-    enqueueInference(inputSource: InputSource, 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 inputSource file or URL 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(inputSource: InputSource, params: InferenceParameters): Promise<InferenceResponse>;
-}

package/src/clientV2.js

@@ -1,167 +0,0 @@
-"use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _ClientV2_instances, _ClientV2_setAsyncParams;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClientV2 = void 0;
-const input_1 = require("./input");
-const handler_1 = require("./errors/handler");
-const logger_1 = require("./logger");
-const promises_1 = require("node:timers/promises");
-const mindeeApiV2_1 = require("./http/mindeeApiV2");
-const mindeeError_1 = require("./errors/mindeeError");
-/**
- * Mindee Client V2 class that centralizes most basic operations.
- *
- * @category ClientV2
- */
-class ClientV2 {
-    /**
-     * @param {ClientOptions} options options for the initialization of a client.
-     */
-    constructor({ apiKey, throwOnError, debug } = {
-        apiKey: "",
-        throwOnError: true,
-        debug: false,
-    }) {
-        _ClientV2_instances.add(this);
-        this.mindeeApi = new mindeeApiV2_1.MindeeApiV2(apiKey);
-        handler_1.errorHandler.throwOnError = throwOnError ?? true;
-        logger_1.logger.level =
-            debug ?? process.env.MINDEE_DEBUG
-                ? logger_1.LOG_LEVELS["debug"]
-                : logger_1.LOG_LEVELS["warn"];
-        logger_1.logger.debug("ClientV2 initialized");
-    }
-    /**
-     * Checks the Data Schema.
-     * @param params Input Inference parameters.
-     */
-    validateDataSchema(params) {
-        if (params.dataSchema !== undefined && params.dataSchema !== null) {
-            if (!(params.dataSchema instanceof input_1.DataSchema)) {
-                params.dataSchema = new input_1.DataSchema(params.dataSchema);
-            }
-        }
-    }
-    /**
-     * Send the document to an asynchronous endpoint and return its ID in the queue.
-     * @param inputSource file or URL to parse.
-     * @param params parameters relating to prediction options.
-     * @category Asynchronous
-     * @returns a `Promise` containing the job (queue) corresponding to a document.
-     */
-    async enqueueInference(inputSource, params) {
-        if (inputSource === undefined) {
-            throw new Error("The 'enqueue' function requires an input document.");
-        }
-        this.validateDataSchema(params);
-        await inputSource.init();
-        return await this.mindeeApi.reqPostInferenceEnqueue(inputSource, params);
-    }
-    /**
-     * 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.
-     */
-    async getInference(inferenceId) {
-        return await this.mindeeApi.reqGetInference(inferenceId);
-    }
-    /**
-     * 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.
-     */
-    async getJob(jobId) {
-        return await this.mindeeApi.reqGetJob(jobId);
-    }
-    /**
-     * 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 inputSource file or URL 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.
-     */
-    async enqueueAndGetInference(inputSource, params) {
-        const validatedAsyncParams = __classPrivateFieldGet(this, _ClientV2_instances, "m", _ClientV2_setAsyncParams).call(this, params.pollingOptions);
-        const enqueueResponse = await this.enqueueInference(inputSource, params);
-        if (enqueueResponse.job.id === undefined || enqueueResponse.job.id.length === 0) {
-            logger_1.logger.error(`Failed enqueueing:\n${enqueueResponse.getRawHttp()}`);
-            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, validatedAsyncParams.initialTimerOptions);
-        let retryCounter = 1;
-        let pollResults = await this.getJob(queueId);
-        while (retryCounter < validatedAsyncParams.maxRetries) {
-            if (pollResults.job.status === "Failed") {
-                break;
-            }
-            if (pollResults.job.status === "Processed") {
-                return this.getInference(pollResults.job.id);
-            }
-            logger_1.logger.debug(`Polling server for parsing result with queueId: ${queueId}.
-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);
-            retryCounter++;
-        }
-        const error = pollResults.job.error;
-        if (error) {
-            throw new mindeeError_1.MindeeHttpErrorV2(error);
-        }
-        throw Error("Asynchronous parsing request timed out after " +
-            validatedAsyncParams.delaySec * retryCounter +
-            " seconds");
-    }
-}
-exports.ClientV2 = ClientV2;
-_ClientV2_instances = new WeakSet(), _ClientV2_setAsyncParams = function _ClientV2_setAsyncParams(asyncParams = undefined) {
-    const minDelaySec = 1;
-    const minInitialDelay = 1;
-    const minRetries = 2;
-    let newAsyncParams;
-    if (asyncParams === undefined) {
-        newAsyncParams = {
-            delaySec: 1.5,
-            initialDelaySec: 2,
-            maxRetries: 80
-        };
-    }
-    else {
-        newAsyncParams = { ...asyncParams };
-        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;
-};

package/src/http/apiSettings.d.ts

@@ -1,12 +0,0 @@
-import { BaseSettings, MindeeApiConstructorProps } from "./baseSettings";
-export declare const API_KEY_ENVVAR_NAME: string;
-export declare const API_HOST_ENVVAR_NAME: string;
-export declare const STANDARD_API_OWNER: string;
-export declare const TIMEOUT_DEFAULT: number;
-export declare class ApiSettings extends BaseSettings {
-    apiKey: string;
-    baseHeaders: Record<string, string>;
-    constructor({ apiKey, }: MindeeApiConstructorProps);
-    protected apiKeyFromEnv(): string;
-    protected hostnameFromEnv(): string;
-}

package/src/http/apiSettings.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiSettings = exports.TIMEOUT_DEFAULT = exports.STANDARD_API_OWNER = exports.API_HOST_ENVVAR_NAME = exports.API_KEY_ENVVAR_NAME = void 0;
-/* eslint-disable @typescript-eslint/naming-convention */
-const logger_1 = require("../logger");
-const baseSettings_1 = require("./baseSettings");
-exports.API_KEY_ENVVAR_NAME = "MINDEE_API_KEY";
-exports.API_HOST_ENVVAR_NAME = "MINDEE_API_HOST";
-exports.STANDARD_API_OWNER = "mindee";
-exports.TIMEOUT_DEFAULT = 120;
-const DEFAULT_MINDEE_API_HOST = "api.mindee.net";
-class ApiSettings extends baseSettings_1.BaseSettings {
-    constructor({ apiKey = "", }) {
-        super();
-        if (!apiKey || apiKey.length === 0) {
-            this.apiKey = this.apiKeyFromEnv();
-        }
-        else {
-            this.apiKey = apiKey;
-        }
-        if (!this.apiKey || this.apiKey.length === 0) {
-            throw new Error("Your API key could not be set, check your Client Configuration\n."
-                + `You can set this using the ${exports.API_KEY_ENVVAR_NAME} environment variable.`);
-        }
-        this.baseHeaders = {
-            "User-Agent": this.getUserAgent(),
-            Authorization: `Token ${this.apiKey}`,
-        };
-    }
-    apiKeyFromEnv() {
-        const envVarValue = process.env[exports.API_KEY_ENVVAR_NAME];
-        if (envVarValue) {
-            logger_1.logger.debug(`Set API key from environment: ${exports.API_KEY_ENVVAR_NAME}`);
-            return envVarValue;
-        }
-        return "";
-    }
-    hostnameFromEnv() {
-        const envVarValue = process.env[exports.API_HOST_ENVVAR_NAME];
-        if (envVarValue) {
-            logger_1.logger.debug(`Set the API hostname to ${envVarValue}`);
-            return envVarValue;
-        }
-        return DEFAULT_MINDEE_API_HOST;
-    }
-}
-exports.ApiSettings = ApiSettings;

package/src/http/apiSettingsV2.d.ts

@@ -1,10 +0,0 @@
-import { BaseSettings, MindeeApiConstructorProps } from "./baseSettings";
-export declare const API_V2_KEY_ENVVAR_NAME: string;
-export declare const API_V2_HOST_ENVVAR_NAME: string;
-export declare class ApiSettingsV2 extends BaseSettings {
-    apiKey: string;
-    baseHeaders: Record<string, string>;
-    constructor({ apiKey, }: MindeeApiConstructorProps);
-    protected apiKeyFromEnv(): string;
-    protected hostnameFromEnv(): string;
-}

package/src/http/apiSettingsV2.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiSettingsV2 = exports.API_V2_HOST_ENVVAR_NAME = exports.API_V2_KEY_ENVVAR_NAME = void 0;
-/* eslint-disable @typescript-eslint/naming-convention */
-const logger_1 = require("../logger");
-const baseSettings_1 = require("./baseSettings");
-const mindeeError_1 = require("../errors/mindeeError");
-exports.API_V2_KEY_ENVVAR_NAME = "MINDEE_V2_API_KEY";
-exports.API_V2_HOST_ENVVAR_NAME = "MINDEE_V2_API_HOST";
-const DEFAULT_MINDEE_API_HOST = "api-v2.mindee.net";
-class ApiSettingsV2 extends baseSettings_1.BaseSettings {
-    constructor({ apiKey = "", }) {
-        super();
-        if (!apiKey || apiKey.length === 0) {
-            this.apiKey = this.apiKeyFromEnv();
-        }
-        else {
-            this.apiKey = apiKey;
-        }
-        if (!this.apiKey || this.apiKey.length === 0) {
-            throw new mindeeError_1.MindeeApiV2Error("Your API V2 key could not be set, check your Client Configuration\n."
-                + `You can set this using the ${exports.API_V2_KEY_ENVVAR_NAME} environment variable.`);
-        }
-        this.baseHeaders = {
-            "User-Agent": this.getUserAgent(),
-            Authorization: `${apiKey}`,
-        };
-    }
-    apiKeyFromEnv() {
-        const envVarValue = process.env[exports.API_V2_KEY_ENVVAR_NAME];
-        if (envVarValue) {
-            logger_1.logger.debug(`Set API key from environment: ${exports.API_V2_KEY_ENVVAR_NAME}`);
-            return envVarValue;
-        }
-        return "";
-    }
-    hostnameFromEnv() {
-        const envVarValue = process.env[exports.API_V2_HOST_ENVVAR_NAME];
-        if (envVarValue) {
-            logger_1.logger.debug(`Set the API hostname to ${envVarValue}`);
-            return envVarValue;
-        }
-        return DEFAULT_MINDEE_API_HOST;
-    }
-}
-exports.ApiSettingsV2 = ApiSettingsV2;

package/src/http/baseEndpoint.d.ts

@@ -1,34 +0,0 @@
-import { ApiSettings } from "./apiSettings";
-import { IncomingMessage, ClientRequest } from "http";
-import { RequestOptions } from "https";
-import { InputSource, PageOptions } from "../input";
-export interface EndpointResponse {
-    messageObj: IncomingMessage;
-    data: {
-        [key: string]: any;
-    };
-}
-/**
- * Base endpoint for the Mindee API.
- */
-export declare abstract class BaseEndpoint {
-    /** Settings relating to the API. */
-    settings: ApiSettings;
-    /** Entire root of the URL for API calls. */
-    urlRoot: string;
-    protected constructor(settings: ApiSettings, urlRoot: string);
-    /**
-     * Cuts a document's pages according to the given options.
-     * @param inputDoc input document.
-     * @param pageOptions page cutting options.
-     */
-    static cutDocPages(inputDoc: InputSource, pageOptions: PageOptions): Promise<void>;
-    /**
-     * Reads a response from the API and processes it.
-     * @param options options related to the request itself.
-     * @param resolve the resolved response
-     * @param reject promise rejection reason.
-     * @returns the processed request.
-     */
-    static readResponse(options: RequestOptions, resolve: (value: EndpointResponse | PromiseLike<EndpointResponse>) => void, reject: (reason?: any) => void): ClientRequest;
-}

package/src/http/baseEndpoint.js

@@ -1,77 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseEndpoint = void 0;
-const logger_1 = require("../logger");
-const https_1 = require("https");
-const input_1 = require("../input");
-/**
- * Base endpoint for the Mindee API.
- */
-class BaseEndpoint {
-    constructor(settings, urlRoot) {
-        this.settings = settings;
-        this.urlRoot = urlRoot;
-    }
-    /**
-     * Cuts a document's pages according to the given options.
-     * @param inputDoc input document.
-     * @param pageOptions page cutting options.
-     */
-    static async cutDocPages(inputDoc, pageOptions) {
-        if (inputDoc instanceof input_1.LocalInputSource && inputDoc.isPdf()) {
-            await inputDoc.applyPageOptions(pageOptions);
-        }
-    }
-    /**
-     * Reads a response from the API and processes it.
-     * @param options options related to the request itself.
-     * @param resolve the resolved response
-     * @param reject promise rejection reason.
-     * @returns the processed request.
-     */
-    static readResponse(options, resolve, reject) {
-        logger_1.logger.debug(`${options.method}: https://${options.hostname}${options.path}`);
-        const req = (0, https_1.request)(options, function (res) {
-            // when the encoding is set, data chunks will be strings
-            res.setEncoding("utf-8");
-            let responseBody = "";
-            res.on("data", function (chunk) {
-                logger_1.logger.debug("Receiving data ...");
-                responseBody += chunk;
-            });
-            res.on("end", function () {
-                logger_1.logger.debug("Parsing the response ...");
-                // handle empty responses from server, for example in the case of redirects
-                if (!responseBody) {
-                    responseBody = "{}";
-                }
-                try {
-                    const parsedResponse = JSON.parse(responseBody);
-                    try {
-                        resolve({
-                            messageObj: res,
-                            data: parsedResponse,
-                        });
-                    }
-                    catch (error) {
-                        logger_1.logger.error("Could not construct the return object.");
-                        reject(error);
-                    }
-                }
-                catch {
-                    logger_1.logger.error("Could not parse the return as JSON.");
-                    logger_1.logger.debug(responseBody);
-                    resolve({
-                        messageObj: res,
-                        data: { reconstructedResponse: responseBody },
-                    });
-                }
-            });
-        });
-        req.on("error", (err) => {
-            reject(err);
-        });
-        return req;
-    }
-}
-exports.BaseEndpoint = BaseEndpoint;

package/src/http/endpoint.d.ts

@@ -1,70 +0,0 @@
-import { InputSource } from "../input";
-import { ApiSettings } from "./apiSettings";
-import { BaseEndpoint, EndpointResponse } from "./baseEndpoint";
-import { StringDict } from "../parsing/common";
-import { PredictParams } from "./httpParams";
-/**
- * Endpoint for a product (OTS or Custom).
- */
-export declare class Endpoint extends BaseEndpoint {
-    #private;
-    /** URL of a product. */
-    urlName: string;
-    /** Account owning the product. */
-    owner: string;
-    /** Product's version, as a string. */
-    version: string;
-    constructor(urlName: string, owner: string, version: string, settings: ApiSettings);
-    /**
-     * Changes the url to a workflow ID.
-     * @param workflowId
-     */
-    useWorkflowId(workflowId: string): void;
-    /**
-     * Sends a document to the API and parses out the result.
-     * Throws an error if the server's response contains one.
-     * @param {PredictParams} params parameters relating to prediction options.
-     * @category Synchronous
-     * @returns a `Promise` containing parsing results.
-     */
-    predict(params: PredictParams): Promise<EndpointResponse>;
-    /**
-     * Enqueues a prediction to the API.
-     * Throws an error if the server's response contains one.
-     * @param {PredictParams} params parameters relating to prediction options.
-     * @category Asynchronous
-     * @returns a `Promise` containing queue data.
-     */
-    predictAsync(params: PredictParams): Promise<EndpointResponse>;
-    private extractStatusMessage;
-    /**
-     * Requests the results of a queued document from the API.
-     * Throws an error if the server's response contains one.
-     * @param queueId The document's ID in the queue.
-     * @category Asynchronous
-     * @returns a `Promise` containing the parsed result.
-     */
-    getQueuedDocument(queueId: string): Promise<EndpointResponse>;
-    /**
-     * Send a feedback
-     * @param {string} documentId
-     */
-    getDocument(documentId: string): Promise<EndpointResponse>;
-    /**
-     * Send a feedback
-     * @param {string} documentId - ID of the document to send feedback to.
-     * @param {StringDict} feedback - Feedback object to send.
-     */
-    sendFeedback(documentId: string, feedback: StringDict): Promise<EndpointResponse>;
-    /**
-     * Send a file to a prediction API.
-     * @param input
-     * @param predictUrl
-     * @param includeWords
-     * @param fullText
-     * @param cropper
-     * @param rag
-     * @param workflowId
-     */
-    protected sendFileForPrediction(input: InputSource, predictUrl: string, includeWords?: boolean, fullText?: boolean, cropper?: boolean, rag?: boolean, workflowId?: string | undefined): Promise<EndpointResponse>;
-}