mindee 5.9.0 → 5.10.0

package/src/v1/product/resume/resumeV1ProfessionalExperience.d.ts

@@ -5,27 +5,49 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class ResumeV1ProfessionalExperience {
     #private;
-    /** The type of contract for the professional experience. */
+    /**
+     * The type of contract for the professional experience.
+     */
     contractType: string | null;
-    /** The specific department or division within the company. */
+    /**
+     * The specific department or division within the company.
+     */
     department: string | null;
-    /** The description of the professional experience as written in the document. */
+    /**
+     * The description of the professional experience as written in the document.
+     */
     description: string | null;
-    /** The name of the company or organization. */
+    /**
+     * The name of the company or organization.
+     */
     employer: string | null;
-    /** The month when the professional experience ended. */
+    /**
+     * The month when the professional experience ended.
+     */
     endMonth: string | null;
-    /** The year when the professional experience ended. */
+    /**
+     * The year when the professional experience ended.
+     */
     endYear: string | null;
-    /** The position or job title held by the candidate. */
+    /**
+     * The position or job title held by the candidate.
+     */
     role: string | null;
-    /** The month when the professional experience began. */
+    /**
+     * The month when the professional experience began.
+     */
     startMonth: string | null;
-    /** The year when the professional experience began. */
+    /**
+     * The year when the professional experience began.
+     */
     startYear: string | null;
-    /** Confidence score */
+    /**
+     * Confidence score
+     */
     confidence: number;
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId: number;
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/resume/resumeV1ProfessionalExperience.js

@@ -12,7 +12,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class ResumeV1ProfessionalExperience {
     constructor({ prediction = {} }) {
         _ResumeV1ProfessionalExperience_instances.add(this);
-        /** Confidence score */
+        /**
+         * Confidence score
+         */
         this.confidence = 0.0;
         /**
          * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/resume/resumeV1SocialNetworksUrl.d.ts

@@ -5,13 +5,21 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class ResumeV1SocialNetworksUrl {
     #private;
-    /** The name of the social network. */
+    /**
+     * The name of the social network.
+     */
     name: string | null;
-    /** The URL of the social network. */
+    /**
+     * The URL of the social network.
+     */
     url: string | null;
-    /** Confidence score */
+    /**
+     * Confidence score
+     */
     confidence: number;
-    /** The document page on which the information was found. */
+    /**
+     * The document page on which the information was found.
+     */
     pageId: number;
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/resume/resumeV1SocialNetworksUrl.js

@@ -12,7 +12,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class ResumeV1SocialNetworksUrl {
     constructor({ prediction = {} }) {
         _ResumeV1SocialNetworksUrl_instances.add(this);
-        /** Confidence score */
+        /**
+         * Confidence score
+         */
         this.confidence = 0.0;
         /**
          * Contains the relative vertices coordinates (points) of a polygon containing

package/src/v1/product/us/bankCheck/bankCheckV1.d.ts

@@ -5,13 +5,21 @@ import { BankCheckV1Page } from "./bankCheckV1Page.js";
  * Bank Check API version 1 inference prediction.
  */
 export declare class BankCheckV1 extends Inference {
-    /** The endpoint's name. */
+    /**
+     * The endpoint's name.
+     */
     endpointName: string;
-    /** The endpoint's version. */
+    /**
+     * The endpoint's version.
+     */
     endpointVersion: string;
-    /** The document-level prediction. */
+    /**
+     * The document-level prediction.
+     */
     prediction: BankCheckV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<BankCheckV1Page>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/us/bankCheck/bankCheckV1.js

@@ -7,11 +7,17 @@ import { BankCheckV1Page } from "./bankCheckV1Page.js";
 export class BankCheckV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "bank_check";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new BankCheckV1Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/us/bankCheck/bankCheckV1Document.d.ts

@@ -4,17 +4,29 @@ import { AmountField, DateField, StringField } from "../../../parsing/standard/i
  * Bank Check API version 1.1 document data.
  */
 export declare class BankCheckV1Document implements Prediction {
-    /** The check payer's account number. */
+    /**
+     * The check payer's account number.
+     */
     accountNumber: StringField;
-    /** The amount of the check. */
+    /**
+     * The amount of the check.
+     */
     amount: AmountField;
-    /** The issuer's check number. */
+    /**
+     * The issuer's check number.
+     */
     checkNumber: StringField;
-    /** The date the check was issued. */
+    /**
+     * The date the check was issued.
+     */
     date: DateField;
-    /** List of the check's payees (recipients). */
+    /**
+     * List of the check's payees (recipients).
+     */
     payees: StringField[];
-    /** The check issuer's routing number. */
+    /**
+     * The check issuer's routing number.
+     */
     routingNumber: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/us/bankCheck/bankCheckV1Document.js

@@ -5,7 +5,9 @@ import { AmountField, DateField, StringField, } from "../../../parsing/standard/
  */
 export class BankCheckV1Document {
     constructor(rawPrediction, pageId) {
-        /** List of the check's payees (recipients). */
+        /**
+         * List of the check's payees (recipients).
+         */
         this.payees = [];
         this.accountNumber = new StringField({
             prediction: rawPrediction["account_number"],

package/src/v1/product/us/bankCheck/bankCheckV1Page.d.ts

@@ -5,9 +5,13 @@ import { BankCheckV1Document } from "./bankCheckV1Document.js";
  * Bank Check API version 1.1 page data.
  */
 export declare class BankCheckV1Page extends BankCheckV1Document {
-    /** The position of the check on the document. */
+    /**
+     * The position of the check on the document.
+     */
     checkPosition: PositionField;
-    /** List of signature positions */
+    /**
+     * List of signature positions
+     */
     signaturesPositions: PositionField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     toString(): string;

package/src/v1/product/us/bankCheck/bankCheckV1Page.js

@@ -7,7 +7,9 @@ import { BankCheckV1Document } from "./bankCheckV1Document.js";
 export class BankCheckV1Page extends BankCheckV1Document {
     constructor(rawPrediction, pageId) {
         super(rawPrediction, pageId);
-        /** List of signature positions */
+        /**
+         * List of signature positions
+         */
         this.signaturesPositions = [];
         this.checkPosition = new PositionField({
             prediction: rawPrediction["check_position"],

package/src/v2/cli.js

@@ -1,5 +1,5 @@
 import { Command } from "commander";
-import * as console from "console";
+import * as console from "node:console";
 import { Client, PathInput, UrlInput } from "../index.js";
 import { Classification, Crop, Extraction, Ocr, Split, } from "./product/index.js";
 const program = new Command();

package/src/v2/client.d.ts

@@ -17,11 +17,17 @@ import { LocalInputSource } from "../input/index.js";
  * });
  */
 export interface ClientOptions {
-    /** Your API key for all endpoints. */
+    /**
+     * Your API key for all endpoints.
+     */
     apiKey?: string;
-    /** Log debug messages. */
+    /**
+     * Log debug messages.
+     */
     debug?: boolean;
-    /** Custom Dispatcher instance for the HTTP requests. */
+    /**
+     * Custom Dispatcher instance for the HTTP requests.
+     */
     dispatcher?: Dispatcher;
 }
 /**

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

@@ -1,8 +1,14 @@
-/** Optional timer settings used by polling delays. */
+/**
+ * Optional timer settings used by polling delays.
+ */
 export interface TimerOptions {
-    /** Whether the timer should keep the event loop active. */
+    /**
+     * Whether the timer should keep the event loop active.
+     */
     ref?: boolean;
-    /** Optional signal used to abort timer waits. */
+    /**
+     * Optional signal used to abort timer waits.
+     */
     signal?: AbortSignal;
 }
 export interface PollingOptionsConstructor {
@@ -43,19 +49,33 @@ export interface PollingOptionsConstructor {
  * ```
  */
 export declare class PollingOptions {
-    /** Number of seconds to wait *before the first poll*. */
+    /**
+     * Number of seconds to wait *before the first poll*.
+     */
     initialDelaySec: number;
-    /** Interval in seconds between two consecutive polls. */
+    /**
+     * Interval in seconds between two consecutive polls.
+     */
     delaySec: number;
-    /** Maximum number of polling attempts (including the first one). */
+    /**
+     * Maximum number of polling attempts (including the first one).
+     */
     maxRetries: number;
-    /** Options passed to the initial `setTimeout()`. */
+    /**
+     * Options passed to the initial `setTimeout()`.
+     */
     initialTimerOptions?: TimerOptions;
-    /** Options passed to every recurring `setTimeout()`. */
+    /**
+     * Options passed to every recurring `setTimeout()`.
+     */
     recurringTimerOptions?: TimerOptions;
     constructor(params?: PollingOptionsConstructor);
-    /** Validates polling options against minimum accepted values. */
+    /**
+     * Validates polling options against minimum accepted values.
+     */
     validateSettings(): void;
-    /** Returns a compact string representation of the polling options. */
+    /**
+     * Returns a compact string representation of the polling options.
+     */
     toString(): string;
 }

package/src/v2/clientOptions/pollingOptions.js

@@ -65,7 +65,9 @@ export class PollingOptions {
         this.validateSettings();
         logger.debug(`Polling options initialized: ${this.toString()}`);
     }
-    /** Validates polling options against minimum accepted values. */
+    /**
+     * Validates polling options against minimum accepted values.
+     */
     validateSettings() {
         if (this.delaySec < minDelaySec) {
             throw new MindeeConfigurationError(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
@@ -77,7 +79,9 @@ export class PollingOptions {
             throw new MindeeConfigurationError(`Cannot set retry to less than ${minRetries}.`);
         }
     }
-    /** Returns a compact string representation of the polling options. */
+    /**
+     * Returns a compact string representation of the polling options.
+     */
     toString() {
         return `{ initialDelaySec: ${this.initialDelaySec}, delaySec: ${this.delaySec}, maxRetries: ${this.maxRetries} }`;
     }

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

@@ -1,5 +1,5 @@
-import { ApiSettings } from "./apiSettings.js";
 import { Dispatcher } from "undici";
+import { ApiSettings } from "./apiSettings.js";
 import { BaseProductParameters } from "../index.js";
 import { BaseSearchParameters, BaseAnnotationParameters, BaseRagDocumentUploadParameters } from "../clientOptions/index.js";
 import { JobResponse } from "../parsing/index.js";

package/src/v2/http/mindeeApiV2.js

@@ -4,8 +4,8 @@ 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_paramsToFormData, _MindeeApiV2_processResponse;
-import { ApiSettings } from "./apiSettings.js";
 import { FormData } from "undici";
+import { ApiSettings } from "./apiSettings.js";
 import { ErrorResponse, JobResponse, } from "../parsing/index.js";
 import { sendRequestAndReadResponse } from "../../http/apiCore.js";
 import { LocalInputSource } from "../../input/index.js";

package/src/v2/parsing/error/errorDetails.d.ts

@@ -1,5 +1,7 @@
 import { ErrorItem } from "./errorItem.js";
-/** Structured error payload returned by v2 APIs. */
+/**
+ * Structured error payload returned by v2 APIs.
+ */
 export interface ErrorDetails {
     /**
      * The HTTP status code returned by the server.

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

@@ -2,7 +2,9 @@ import { StringDict } from "../../../parsing/index.js";
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
 import { InferenceJob } from "./inferenceJob.js";
-/** Shared metadata container for v2 inference payloads. */
+/**
+ * Shared metadata container for v2 inference payloads.
+ */
 export declare abstract class BaseInference {
     /**
      * Model info for the inference.
@@ -21,6 +23,8 @@ export declare abstract class BaseInference {
      */
     id: string;
     protected constructor(serverResponse: StringDict);
-    /** Returns a printable representation of inference metadata. */
+    /**
+     * Returns a printable representation of inference metadata.
+     */
     toString(): string;
 }

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

@@ -1,7 +1,9 @@
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
 import { InferenceJob } from "./inferenceJob.js";
-/** Shared metadata container for v2 inference payloads. */
+/**
+ * Shared metadata container for v2 inference payloads.
+ */
 export class BaseInference {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
@@ -9,7 +11,9 @@ export class BaseInference {
         this.model = new InferenceModel(serverResponse["model"]);
         this.file = new InferenceFile(serverResponse["file"]);
     }
-    /** Returns a printable representation of inference metadata. */
+    /**
+     * Returns a printable representation of inference metadata.
+     */
     toString() {
         return ("Inference\n" +
             "#########\n" +

package/src/v2/parsing/inference/field/baseField.d.ts

@@ -2,11 +2,17 @@ import { FieldConfidence } from "./fieldConfidence.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { FieldLocation } from "./fieldLocation.js";
 export declare abstract class BaseField {
-    /** Indentation level used when rendering field text output. */
+    /**
+     * Indentation level used when rendering field text output.
+     */
     protected _indentLevel: number;
-    /** Confidence level associated with this field. */
+    /**
+     * Confidence level associated with this field.
+     */
     confidence: FieldConfidence | undefined;
-    /** Optional list of source locations for this field. */
+    /**
+     * Optional list of source locations for this field.
+     */
     locations: Array<FieldLocation> | undefined;
     protected constructor(rawResponse: StringDict, indentLevel?: number);
 }

package/src/v2/parsing/inference/field/fieldConfidence.d.ts

@@ -2,13 +2,21 @@
  * Confidence level of a field as returned by the V2 API.
  */
 export declare enum FieldConfidence {
-    /** Maximum confidence level. */
+    /**
+     * Maximum confidence level.
+     */
     Certain = "Certain",
-    /** High confidence level. */
+    /**
+     * High confidence level.
+     */
     High = "High",
-    /** Medium confidence level. */
+    /**
+     * Medium confidence level.
+     */
     Medium = "Medium",
-    /** Low confidence level. */
+    /**
+     * Low confidence level.
+     */
     Low = "Low"
 }
 export declare namespace FieldConfidence {

package/src/v2/parsing/inference/field/fieldConfidence.js

@@ -4,13 +4,21 @@
  */
 export var FieldConfidence;
 (function (FieldConfidence) {
-    /** Maximum confidence level. */
+    /**
+     * Maximum confidence level.
+     */
     FieldConfidence["Certain"] = "Certain";
-    /** High confidence level. */
+    /**
+     * High confidence level.
+     */
     FieldConfidence["High"] = "High";
-    /** Medium confidence level. */
+    /**
+     * Medium confidence level.
+     */
     FieldConfidence["Medium"] = "Medium";
-    /** Low confidence level. */
+    /**
+     * Low confidence level.
+     */
     FieldConfidence["Low"] = "Low";
 })(FieldConfidence || (FieldConfidence = {}));
 // eslint-disable-next-line @typescript-eslint/no-namespace

package/src/v2/parsing/inference/field/fieldLocation.d.ts

@@ -4,11 +4,17 @@ import { StringDict } from "../../../../parsing/stringDict.js";
  * A field's location on the document.
  */
 export declare class FieldLocation {
-    /** Position information as a list of points in clockwise order. */
+    /**
+     * Position information as a list of points in clockwise order.
+     */
     readonly polygon: Polygon;
-    /** 0-based page index of where the polygon is located. */
+    /**
+     * 0-based page index of where the polygon is located.
+     */
     readonly page: any;
     constructor(serverResponse: StringDict);
-    /** Returns a readable location string. */
+    /**
+     * Returns a readable location string.
+     */
     toString(): string;
 }

package/src/v2/parsing/inference/field/fieldLocation.js

@@ -7,7 +7,9 @@ export class FieldLocation {
         this.polygon = new Polygon(...serverResponse["polygon"]);
         this.page = serverResponse["page"];
     }
-    /** Returns a readable location string. */
+    /**
+     * Returns a readable location string.
+     */
     toString() {
         return `${this.polygon} on page ${this.page}`;
     }

package/src/v2/parsing/inference/field/inferenceFields.d.ts

@@ -2,9 +2,13 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import type { ListField } from "./listField.js";
 import type { ObjectField } from "./objectField.js";
 import type { SimpleField } from "./simpleField.js";
-/** Typed map of extraction fields returned by the API. */
+/**
+ * Typed map of extraction fields returned by the API.
+ */
 export declare class InferenceFields extends Map<string, SimpleField | ObjectField | ListField> {
-    /** Indentation level used when rendering text output. */
+    /**
+     * Indentation level used when rendering text output.
+     */
     protected _indentLevel: number;
     constructor(serverResponse: StringDict, indentLevel?: number);
     /**

package/src/v2/parsing/inference/field/inferenceFields.js

@@ -1,5 +1,7 @@
 import { createField } from "./fieldFactory.js";
-/** Typed map of extraction fields returned by the API. */
+/**
+ * Typed map of extraction fields returned by the API.
+ */
 export class InferenceFields extends Map {
     constructor(serverResponse, indentLevel = 0) {
         super(Object.entries(serverResponse).map(([key, value]) => {

package/src/v2/parsing/inference/field/listField.d.ts

@@ -2,7 +2,9 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import { BaseField } from "./baseField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
-/** List-valued inference field. */
+/**
+ * List-valued inference field.
+ */
 export declare class ListField extends BaseField {
     /**
      * Items contained in the list.
@@ -17,6 +19,8 @@ export declare class ListField extends BaseField {
      * SimpleField items from the list.
      */
     get objectItems(): Array<ObjectField>;
-    /** Returns a readable representation of list items. */
+    /**
+     * Returns a readable representation of list items.
+     */
     toString(): string;
 }

package/src/v2/parsing/inference/field/listField.js

@@ -3,7 +3,9 @@ import { BaseField } from "./baseField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
 import { createField } from "./fieldFactory.js";
-/** List-valued inference field. */
+/**
+ * List-valued inference field.
+ */
 export class ListField extends BaseField {
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
@@ -44,7 +46,9 @@ export class ListField extends BaseField {
         }
         return result;
     }
-    /** Returns a readable representation of list items. */
+    /**
+     * Returns a readable representation of list items.
+     */
     toString() {
         if (!this.items || this.items.length === 0) {
             return "\n";

package/src/v2/parsing/inference/field/objectField.d.ts

@@ -3,9 +3,13 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import { BaseField } from "./baseField.js";
 import type { SimpleField } from "./simpleField.js";
 import type { ListField } from "./listField.js";
-/** Object-valued inference field. */
+/**
+ * Object-valued inference field.
+ */
 export declare class ObjectField extends BaseField {
-    /** Nested fields carried by this object. */
+    /**
+     * Nested fields carried by this object.
+     */
     readonly fields: InferenceFields;
     constructor(serverResponse: StringDict, indentLevel?: number);
     /**

package/src/v2/parsing/inference/field/objectField.js

@@ -1,6 +1,8 @@
 import { InferenceFields } from "./inferenceFields.js";
 import { BaseField } from "./baseField.js";
-/** Object-valued inference field. */
+/**
+ * Object-valued inference field.
+ */
 export class ObjectField extends BaseField {
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);

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

@@ -1,5 +1,7 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
-/** Metadata about the RAG operation. */
+/**
+ * Metadata about the RAG operation.
+ */
 export declare class RagMetadata {
     /**
      * The UUID of the matched document used during the RAG operation.

package/src/v2/parsing/inference/field/ragMetadata.js

@@ -1,4 +1,6 @@
-/** Metadata about the RAG operation. */
+/**
+ * Metadata about the RAG operation.
+ */
 export class RagMetadata {
     constructor(serverResponse) {
         this.retrievedDocumentId = serverResponse["retrieved_document_id"] ?? undefined;