mindee 5.9.0 → 5.10.0

package/src/v1/parsing/common/apiRequest.d.ts

@@ -5,15 +5,25 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category API Response
  */
 export declare class ApiRequest {
-    /**  An object detailing the error. */
+    /**
+     * An object detailing the error.
+     */
     error: StringDict;
-    /** Target of the request. */
+    /**
+     * Target of the request.
+     */
     resources: string[];
-    /** Status of the request. Either "failure" or "success". */
+    /**
+     * Status of the request. Either "failure" or "success".
+     */
     status: "failure" | "success";
-    /** HTTP status code */
+    /**
+     * HTTP status code
+     */
     statusCode: number;
-    /** URL of the request. */
+    /**
+     * URL of the request.
+     */
     url: string;
     constructor(serverResponse: StringDict);
 }

package/src/v1/parsing/common/apiResponse.d.ts

@@ -5,9 +5,13 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category API Response
  */
 export declare abstract class ApiResponse {
-    /** Initial request sent to the API. */
+    /**
+     * Initial request sent to the API.
+     */
     apiRequest: ApiRequest;
-    /** Raw text representation of the API's response. */
+    /**
+     * Raw text representation of the API's response.
+     */
     private readonly rawHttp;
     /**
      * @param serverResponse JSON response from the server.

package/src/v1/parsing/common/asyncPredictResponse.d.ts

@@ -8,17 +8,29 @@ import { Document } from "./document.js";
  * @category Asynchronous
  */
 export declare class Job {
-    /** Timestamp noting the enqueueing of a document. */
+    /**
+     * Timestamp noting the enqueueing of a document.
+     */
     issuedAt: Date;
-    /** Timestamp noting the availability of a prediction for an enqueued document. */
+    /**
+     * Timestamp noting the availability of a prediction for an enqueued document.
+     */
     availableAt?: Date;
-    /** Information about an error that occurred during the job processing. */
+    /**
+     * Information about an error that occurred during the job processing.
+     */
     error?: StringDict;
-    /** ID of the job. */
+    /**
+     * ID of the job.
+     */
     id: string;
-    /** Status of the job. */
+    /**
+     * Status of the job.
+     */
     status?: "waiting" | "processing" | "completed" | "failed";
-    /** The time taken to process the job, in milliseconds. */
+    /**
+     * The time taken to process the job, in milliseconds.
+     */
     milliSecsTaken?: number;
     constructor(jsonResponse: StringDict);
 }
@@ -33,7 +45,9 @@ export declare function datetimeWithTimezone(date: string): Date;
  * @category Asynchronous
  */
 export declare class AsyncPredictResponse<T extends Inference> extends ApiResponse {
-    /** Job for a queue. */
+    /**
+     * Job for a queue.
+     */
     job: Job;
     /** Prediction for an asynchronous request. Will not be available so long as the job is not
      * `completed`.

package/src/v1/parsing/common/document.d.ts

@@ -7,17 +7,29 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @typeParam T an extension of an `Inference`. Mandatory in order to properly create an inference.
  */
 export declare class Document<T extends Inference> {
-    /** File name as sent back by the server. */
+    /**
+     * File name as sent back by the server.
+     */
     filename: string;
-    /** Result of the base inference. */
+    /**
+     * Result of the base inference.
+     */
     inference: T;
-    /** ID of the document as sent back by the server. */
+    /**
+     * ID of the document as sent back by the server.
+     */
     id: string;
-    /** Potential `Extras` fields sent back along the prediction. */
+    /**
+     * Potential `Extras` fields sent back along the prediction.
+     */
     extras?: Extras;
-    /** Raw-text response for `allWords` parsing. */
+    /**
+     * Raw-text response for `allWords` parsing.
+     */
     ocr?: Ocr;
-    /** Page number as sent back by the API. */
+    /**
+     * Page number as sent back by the API.
+     */
     nPages: number;
     /**
      *

package/src/v1/parsing/common/document.js

@@ -50,9 +50,9 @@ export class Document {
 ${this.inference?.toString()}`;
     }
     injectFullTextOcr(rawPrediction) {
-        if (rawPrediction["inference"]["pages"].length < 1 ||
+        if (rawPrediction["inference"]["pages"].length === 0 ||
             !("extras" in rawPrediction["inference"]["pages"][0]) ||
-            rawPrediction["inference"]["pages"][0]["extras"].length < 1 ||
+            rawPrediction["inference"]["pages"][0]["extras"].length === 0 ||
             !("full_text_ocr" in rawPrediction["inference"]["pages"][0]["extras"]) ||
             !rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"] ||
             !("content" in rawPrediction["inference"]["pages"][0]["extras"]["full_text_ocr"]) ||

package/src/v1/parsing/common/execution.d.ts

@@ -8,31 +8,57 @@ import { ExecutionPriority } from "./executionPriority.js";
  * @category Workflow
  */
 export declare class Execution<T extends Inference> {
-    /** Identifier for the batch to which the execution belongs. */
+    /**
+     * Identifier for the batch to which the execution belongs.
+     */
     batchName: string;
-    /** The time at which the execution started. */
+    /**
+     * The time at which the execution started.
+     */
     createdAt: Date | null;
-    /** File representation within a workflow execution. */
+    /**
+     * File representation within a workflow execution.
+     */
     file: ExecutionFile;
-    /** Identifier for the execution. */
+    /**
+     * Identifier for the execution.
+     */
     id: string;
-    /** Deserialized inference object. */
+    /**
+     * Deserialized inference object.
+     */
     inference: T | null;
-    /** Priority of the execution. */
+    /**
+     * Priority of the execution.
+     */
     priority: ExecutionPriority | null;
-    /** The time at which the file was tagged as reviewed. */
+    /**
+     * The time at which the file was tagged as reviewed.
+     */
     reviewedAt: Date | null;
-    /** The time at which the file was uploaded to a workflow. */
+    /**
+     * The time at which the file was uploaded to a workflow.
+     */
     availableAt: Date | null;
-    /** Reviewed fields and values. */
+    /**
+     * Reviewed fields and values.
+     */
     reviewedPrediction: GeneratedV1Document | null;
-    /** Execution Status. */
+    /**
+     * Execution Status.
+     */
     status: string;
-    /** Execution type. */
+    /**
+     * Execution type.
+     */
     type: string | null;
-    /** The time at which the file was uploaded to a workflow. */
+    /**
+     * The time at which the file was uploaded to a workflow.
+     */
     uploadedAt: Date | null;
-    /** Identifier for the workflow. */
+    /**
+     * Identifier for the workflow.
+     */
     workflowId: string;
     constructor(inferenceClass: new (serverResponse: StringDict) => T, jsonResponse: StringDict);
 }

package/src/v1/parsing/common/executionFile.d.ts

@@ -4,9 +4,13 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category Workflow
  */
 export declare class ExecutionFile {
-    /** File name. */
+    /**
+     * File name.
+     */
     name: string | null;
-    /** Optional alias for the fil. */
+    /**
+     * Optional alias for the file.
+     */
     alias: string | null;
     constructor(jsonResponse: StringDict);
 }

package/src/v1/parsing/common/executionPriority.d.ts

@@ -1,9 +1,17 @@
-/** Execution priority levels available for workflow requests. */
+/**
+ * Execution priority levels available for workflow requests.
+ */
 export declare enum ExecutionPriority {
-    /** Low-priority background processing. */
+    /**
+     * Low-priority background processing.
+     */
     low = "low",
-    /** Standard processing priority. */
+    /**
+     * Standard processing priority.
+     */
     medium = "medium",
-    /** High-priority processing. */
+    /**
+     * High-priority processing.
+     */
     high = "high"
 }

package/src/v1/parsing/common/executionPriority.js

@@ -1,10 +1,18 @@
-/** Execution priority levels available for workflow requests. */
+/**
+ * Execution priority levels available for workflow requests.
+ */
 export var ExecutionPriority;
 (function (ExecutionPriority) {
-    /** Low-priority background processing. */
+    /**
+     * Low-priority background processing.
+     */
     ExecutionPriority["low"] = "low";
-    /** Standard processing priority. */
+    /**
+     * Standard processing priority.
+     */
     ExecutionPriority["medium"] = "medium";
-    /** High-priority processing. */
+    /**
+     * High-priority processing.
+     */
     ExecutionPriority["high"] = "high";
 })(ExecutionPriority || (ExecutionPriority = {}));

package/src/v1/parsing/common/extras/cropperExtra.d.ts

@@ -1,9 +1,13 @@
-import { PositionField } from "../../standard/position.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
+import { PositionField } from "../../standard/position.js";
 import { ExtraField } from "./extras.js";
-/** Cropper extra payload returned by compatible APIs. */
+/**
+ * Cropper extra payload returned by compatible APIs.
+ */
 export declare class CropperExtra extends ExtraField {
-    /** Cropped regions detected on the page. */
+    /**
+     * Cropped regions detected on the page.
+     */
     cropping: PositionField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/parsing/common/extras/cropperExtra.js

@@ -1,12 +1,15 @@
 import { PositionField } from "../../standard/position.js";
-// eslint-disable-next-line no-restricted-imports
 import { cleanOutString } from "../summaryHelper.js";
 import { ExtraField } from "./extras.js";
-/** Cropper extra payload returned by compatible APIs. */
+/**
+ * Cropper extra payload returned by compatible APIs.
+ */
 export class CropperExtra extends ExtraField {
     constructor(rawPrediction, pageId) {
         super();
-        /** Cropped regions detected on the page. */
+        /**
+         * Cropped regions detected on the page.
+         */
         this.cropping = [];
         if (rawPrediction["cropping"] !== undefined) {
             rawPrediction["cropping"].forEach((crop) => {

package/src/v1/parsing/common/extras/extras.d.ts

@@ -1,12 +1,18 @@
-/** Base class for optional extras attached to predictions. */
+/**
+ * Base class for optional extras attached to predictions.
+ */
 export declare abstract class ExtraField {
 }
 interface ExtraDict<T extends ExtraField> {
     [key: string]: T | (() => string);
 }
-/** Dictionary-like container for extra fields. */
+/**
+ * Dictionary-like container for extra fields.
+ */
 export declare class Extras<ExtraT extends ExtraField = ExtraField> implements ExtraDict<ExtraT> {
-    /** Dynamic map of extra values keyed by extra name. */
+    /**
+     * Dynamic map of extra values keyed by extra name.
+     */
     [key: string]: ExtraT | (() => string);
     constructor(fields: Record<string, ExtraT>);
     /**

package/src/v1/parsing/common/extras/extras.js

@@ -1,7 +1,11 @@
-/** Base class for optional extras attached to predictions. */
+/**
+ * Base class for optional extras attached to predictions.
+ */
 export class ExtraField {
 }
-/** Dictionary-like container for extra fields. */
+/**
+ * Dictionary-like container for extra fields.
+ */
 export class Extras {
     constructor(fields) {
         if (Object.keys(fields).length > 0) {

package/src/v1/parsing/common/extras/fullTextOcrExtra.d.ts

@@ -1,10 +1,16 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { ExtraField } from "./extras.js";
-/** Full-text OCR extra payload returned by compatible APIs. */
+/**
+ * Full-text OCR extra payload returned by compatible APIs.
+ */
 export declare class FullTextOcrExtra extends ExtraField {
-    /** Concatenated OCR content. */
+    /**
+     * Concatenated OCR content.
+     */
     content?: string;
-    /** OCR language hints associated with the content. */
+    /**
+     * OCR language hints associated with the content.
+     */
     languages?: string;
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/extras/fullTextOcrExtra.js

@@ -1,5 +1,7 @@
 import { ExtraField } from "./extras.js";
-/** Full-text OCR extra payload returned by compatible APIs. */
+/**
+ * Full-text OCR extra payload returned by compatible APIs.
+ */
 export class FullTextOcrExtra extends ExtraField {
     constructor(rawPrediction) {
         super();

package/src/v1/parsing/common/extras/ragExtra.d.ts

@@ -1,6 +1,8 @@
 import { ExtraField } from "./extras.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
-/** RAG extra payload returned by compatible APIs. */
+/**
+ * RAG extra payload returned by compatible APIs.
+ */
 export declare class RAGExtra extends ExtraField {
     /**
      * ID reference of the document matched by the Retrieval-Augmented Generation.

package/src/v1/parsing/common/extras/ragExtra.js

@@ -1,5 +1,7 @@
 import { ExtraField } from "./extras.js";
-/** RAG extra payload returned by compatible APIs. */
+/**
+ * RAG extra payload returned by compatible APIs.
+ */
 export class RAGExtra extends ExtraField {
     constructor(rawPrediction) {
         super();

package/src/v1/parsing/common/feedback/feedbackResponse.d.ts

@@ -6,7 +6,9 @@ import { StringDict } from "../../../../parsing/stringDict.js";
  * @category Synchronous
  */
 export declare class FeedbackResponse extends ApiResponse {
-    /** A document feedback response. */
+    /**
+     * A document feedback response.
+     */
     feedback: StringDict;
     /**
      * @param serverResponse JSON response from the server.

package/src/v1/parsing/common/feedback/feedbackResponse.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line no-restricted-imports
 import { ApiResponse } from "../apiResponse.js";
 /**
  * Wrapper for feedback response.

package/src/v1/parsing/common/inference.d.ts

@@ -12,25 +12,41 @@ import { Extras } from "./extras/index.js";
  * if a document's pages have specific implementation.
  */
 export declare abstract class Inference<DocT extends Prediction = Prediction, PageT extends DocT = DocT> {
-    /** A boolean denoting whether a given inference result was rotated. */
+    /**
+     * A boolean denoting whether a given inference result was rotated.
+     */
     isRotationApplied?: boolean;
-    /** Name and version of a given product. */
+    /**
+     * Name and version of a given product.
+     */
     product: Product;
-    /** Wrapper for a document's pages prediction. */
+    /**
+     * Wrapper for a document's pages prediction.
+     */
     pages: Page<PageT>[];
-    /** A document's top-level `Prediction`. */
+    /**
+     * A document's top-level `Prediction`.
+     */
     prediction: DocT;
-    /** Extraneous fields relating to specific tools for some APIs. */
+    /**
+     * Extraneous fields relating to specific tools for some APIs.
+     */
     extras?: Extras;
-    /** Name of a document's endpoint. Has a default value for OTS APIs. */
+    /**
+     * Name of a document's endpoint. Has a default value for OTS APIs.
+     */
     endpointName?: string;
-    /** A document's version. Has a default value for OTS APIs. */
+    /**
+     * A document's version. Has a default value for OTS APIs.
+     */
     endpointVersion?: string;
     constructor(rawPrediction: StringDict);
     /**
      * Default string representation.
      */
-    /** Returns a human-readable representation of the inference payload. */
+    /**
+     * Returns a human-readable representation of the inference payload.
+     */
     toString(): string;
     /**
      * Takes in an input string and replaces line breaks with `\n`.

package/src/v1/parsing/common/inference.js

@@ -10,7 +10,9 @@ import { MindeeConfigurationError } from "../../../errors/index.js";
  */
 export class Inference {
     constructor(rawPrediction) {
-        /** Wrapper for a document's pages prediction. */
+        /**
+         * Wrapper for a document's pages prediction.
+         */
         this.pages = [];
         this.isRotationApplied = rawPrediction?.is_rotation_applied ?? undefined;
         this.product = rawPrediction?.product;
@@ -36,7 +38,9 @@ export class Inference {
     /**
      * Default string representation.
      */
-    /** Returns a human-readable representation of the inference payload. */
+    /**
+     * Returns a human-readable representation of the inference payload.
+     */
     toString() {
         let pages = "";
         if (this.pages.toString().length > 0) {

package/src/v1/parsing/common/mvisionV1.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { OcrPage } from "./ocrPage.js";
 export declare class MvisionV1 {
-    /** List of words found on the page. */
+    /**
+     * List of words found on the page.
+     */
     pages: OcrPage[];
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/mvisionV1.js

@@ -1,7 +1,9 @@
 import { OcrPage } from "./ocrPage.js";
 export class MvisionV1 {
     constructor(rawPrediction) {
-        /** List of words found on the page. */
+        /**
+         * List of words found on the page.
+         */
         this.pages = [];
         rawPrediction["pages"].map((page) => {
             this.pages.push(new OcrPage(page));

package/src/v1/parsing/common/ocr.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { MvisionV1 } from "./mvisionV1.js";
 export declare class Ocr {
-    /** Default Mindee OCR */
+    /**
+     * Default Mindee OCR
+     */
     mVisionV1: MvisionV1;
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/ocrPage.d.ts

@@ -2,9 +2,13 @@ import { Word } from "../standard/index.js";
 import { StringDict } from "../../../parsing/stringDict.js";
 export declare class OcrPage {
     #private;
-    /** Flat list of all words read */
+    /**
+     * Flat list of all words read
+     */
     allWords: Word[];
-    /** List of words by which line they are on */
+    /**
+     * List of words by which line they are on
+     */
     allLines: Word[][];
     constructor(rawPrediction: StringDict);
     /**

package/src/v1/parsing/common/ocrPage.js

@@ -9,9 +9,13 @@ import { Word } from "../standard/index.js";
 export class OcrPage {
     constructor(rawPrediction) {
         _OcrPage_instances.add(this);
-        /** Flat list of all words read */
+        /**
+         * Flat list of all words read
+         */
         this.allWords = [];
-        /** List of words by which line they are on */
+        /**
+         * List of words by which line they are on
+         */
         this.allLines = [];
         const allWords = [];
         if (rawPrediction["all_words"]) {

package/src/v1/parsing/common/orientation.d.ts

@@ -6,9 +6,13 @@ interface OrientationFieldConstructor extends BaseFieldConstructor {
  * The clockwise rotation to apply (in degrees) to make the image upright.
  */
 export declare class OrientationField extends BaseField {
-    /** Degrees of the rotation. */
+    /**
+     * Degrees of the rotation.
+     */
     value: number;
-    /** Page id. */
+    /**
+     * Page id.
+     */
     pageId: number;
     /**
      * @param {OrientationFieldConstructor} constructor Constructor parameters.

package/src/v1/parsing/common/page.d.ts

@@ -8,13 +8,21 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @typeParam T an extension of an `Prediction`. Mandatory in order to properly create a page-level prediction.
  */
 export declare class Page<T extends Prediction> {
-    /** The page's index (identifier). */
+    /**
+     * The page's index (identifier).
+     */
     id: number;
-    /** The page's orientation */
+    /**
+     * The page's orientation
+     */
     orientation?: OrientationField;
-    /** A page-level prediction. Can either be specific to pages or identical to the document prediction. */
+    /**
+     * A page-level prediction. Can either be specific to pages or identical to the document prediction.
+     */
     prediction: T;
-    /** Potential `Extras` fields sent back along with the prediction. */
+    /**
+     * Potential `Extras` fields sent back along with the prediction.
+     */
     extras?: Extras;
     /**
      * @param predictionType constructor signature for an inference.

package/src/v1/parsing/common/predictResponse.d.ts

@@ -8,7 +8,9 @@ import { StringDict } from "../../../parsing/stringDict.js";
  * @category Synchronous
  */
 export declare class PredictResponse<T extends Inference> extends ApiResponse {
-    /** A document prediction response. */
+    /**
+     * A document prediction response.
+     */
     document: Document<T>;
     /**
      *

package/src/v1/parsing/common/prediction.d.ts

@@ -1,3 +1,5 @@
-/** Marker base type for v1 prediction payload models. */
+/**
+ * Marker base type for v1 prediction payload models.
+ */
 export declare class Prediction {
 }

package/src/v1/parsing/common/prediction.js

@@ -1,3 +1,5 @@
-/** Marker base type for v1 prediction payload models. */
+/**
+ * Marker base type for v1 prediction payload models.
+ */
 export class Prediction {
 }

package/src/v1/parsing/generated/generatedList.d.ts

@@ -9,9 +9,13 @@ export interface GeneratedListFieldConstructor {
  * A list of values or objects, used in generated APIs.
  */
 export declare class GeneratedListField {
-    /** Id of the page the object was found on. */
+    /**
+     * Id of the page the object was found on.
+     */
     pageId?: number;
-    /** List of word values. */
+    /**
+     * List of word values.
+     */
     values: Array<GeneratedObjectField | StringField>;
     constructor({ prediction, pageId, }: GeneratedListFieldConstructor);
     /**