mindee 5.9.0 → 5.10.0

package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2.d.ts

@@ -4,13 +4,21 @@ import { BankAccountDetailsV2Document } from "./bankAccountDetailsV2Document.js"
  * Bank Account Details API version 2 inference prediction.
  */
 export declare class BankAccountDetailsV2 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: BankAccountDetailsV2Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<BankAccountDetailsV2Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2.js

@@ -6,11 +6,17 @@ import { BankAccountDetailsV2Document } from "./bankAccountDetailsV2Document.js"
 export class BankAccountDetailsV2 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "bank_account_details";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "2";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new BankAccountDetailsV2Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2Bban.d.ts

@@ -5,17 +5,29 @@ import { Polygon } from "../../../../geometry/index.js";
  */
 export declare class BankAccountDetailsV2Bban {
     #private;
-    /** The BBAN bank code outputted as a string. */
+    /**
+     * The BBAN bank code outputted as a string.
+     */
     bbanBankCode: string | null;
-    /** The BBAN branch code outputted as a string. */
+    /**
+     * The BBAN branch code outputted as a string.
+     */
     bbanBranchCode: string | null;
-    /** The BBAN key outputted as a string. */
+    /**
+     * The BBAN key outputted as a string.
+     */
     bbanKey: string | null;
-    /** The BBAN Account number outputted as a string. */
+    /**
+     * The BBAN Account number outputted as a string.
+     */
     bbanNumber: 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/fr/bankAccountDetails/bankAccountDetailsV2Bban.js

@@ -11,7 +11,9 @@ import { Polygon } from "../../../../geometry/index.js";
 export class BankAccountDetailsV2Bban {
     constructor({ prediction = {} }) {
         _BankAccountDetailsV2Bban_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/fr/bankAccountDetails/bankAccountDetailsV2Document.d.ts

@@ -5,13 +5,21 @@ import { StringField } from "../../../parsing/standard/index.js";
  * Bank Account Details API version 2.0 document data.
  */
 export declare class BankAccountDetailsV2Document implements Prediction {
-    /** Full extraction of the account holders names. */
+    /**
+     * Full extraction of the account holders names.
+     */
     accountHoldersNames: StringField;
-    /** Full extraction of BBAN, including: branch code, bank code, account and key. */
+    /**
+     * Full extraction of BBAN, including: branch code, bank code, account and key.
+     */
     bban: BankAccountDetailsV2Bban;
-    /** Full extraction of the IBAN number. */
+    /**
+     * Full extraction of the IBAN number.
+     */
     iban: StringField;
-    /** Full extraction of the SWIFT code. */
+    /**
+     * Full extraction of the SWIFT code.
+     */
     swiftCode: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/fr/carteGrise/carteGriseV1.d.ts

@@ -4,13 +4,21 @@ import { CarteGriseV1Document } from "./carteGriseV1Document.js";
  * Carte Grise API version 1 inference prediction.
  */
 export declare class CarteGriseV1 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: CarteGriseV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<CarteGriseV1Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/fr/carteGrise/carteGriseV1.js

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

package/src/v1/product/fr/carteGrise/carteGriseV1Document.d.ts

@@ -4,87 +4,169 @@ import { DateField, StringField } from "../../../parsing/standard/index.js";
  * Carte Grise API version 1.1 document data.
  */
 export declare class CarteGriseV1Document implements Prediction {
-    /** The vehicle's license plate number. */
+    /**
+     * The vehicle's license plate number.
+     */
     a: StringField;
-    /** The vehicle's first release date. */
+    /**
+     * The vehicle's first release date.
+     */
     b: DateField;
-    /** The vehicle owner's full name including maiden name. */
+    /**
+     * The vehicle owner's full name including maiden name.
+     */
     c1: StringField;
-    /** The vehicle owner's address. */
+    /**
+     * The vehicle owner's address.
+     */
     c3: StringField;
-    /** Number of owners of the license certificate. */
+    /**
+     * Number of owners of the license certificate.
+     */
     c41: StringField;
-    /** Mentions about the ownership of the vehicle. */
+    /**
+     * Mentions about the ownership of the vehicle.
+     */
     c4A: StringField;
-    /** The vehicle's brand. */
+    /**
+     * The vehicle's brand.
+     */
     d1: StringField;
-    /** The vehicle's commercial name. */
+    /**
+     * The vehicle's commercial name.
+     */
     d3: StringField;
-    /** The Vehicle Identification Number (VIN). */
+    /**
+     * The Vehicle Identification Number (VIN).
+     */
     e: StringField;
-    /** The vehicle's maximum admissible weight. */
+    /**
+     * The vehicle's maximum admissible weight.
+     */
     f1: StringField;
-    /** The vehicle's maximum admissible weight within the license's state. */
+    /**
+     * The vehicle's maximum admissible weight within the license's state.
+     */
     f2: StringField;
-    /** The vehicle's maximum authorized weight with coupling. */
+    /**
+     * The vehicle's maximum authorized weight with coupling.
+     */
     f3: StringField;
-    /** The document's formula number. */
+    /**
+     * The document's formula number.
+     */
     formulaNumber: StringField;
-    /** The vehicle's weight with coupling if tractor different than category M1. */
+    /**
+     * The vehicle's weight with coupling if tractor different than category M1.
+     */
     g: StringField;
-    /** The vehicle's national empty weight. */
+    /**
+     * The vehicle's national empty weight.
+     */
     g1: StringField;
-    /** The car registration date of the given certificate. */
+    /**
+     * The car registration date of the given certificate.
+     */
     i: DateField;
-    /** The vehicle's category. */
+    /**
+     * The vehicle's category.
+     */
     j: StringField;
-    /** The vehicle's national type. */
+    /**
+     * The vehicle's national type.
+     */
     j1: StringField;
-    /** The vehicle's body type (CE). */
+    /**
+     * The vehicle's body type (CE).
+     */
     j2: StringField;
-    /** The vehicle's body type (National designation). */
+    /**
+     * The vehicle's body type (National designation).
+     */
     j3: StringField;
-    /** Machine Readable Zone, first line. */
+    /**
+     * Machine Readable Zone, first line.
+     */
     mrz1: StringField;
-    /** Machine Readable Zone, second line. */
+    /**
+     * Machine Readable Zone, second line.
+     */
     mrz2: StringField;
-    /** The vehicle's owner first name. */
+    /**
+     * The vehicle's owner first name.
+     */
     ownerFirstName: StringField;
-    /** The vehicle's owner surname. */
+    /**
+     * The vehicle's owner surname.
+     */
     ownerSurname: StringField;
-    /** The vehicle engine's displacement (cm3). */
+    /**
+     * The vehicle engine's displacement (cm3).
+     */
     p1: StringField;
-    /** The vehicle's maximum net power (kW). */
+    /**
+     * The vehicle's maximum net power (kW).
+     */
     p2: StringField;
-    /** The vehicle's fuel type or energy source. */
+    /**
+     * The vehicle's fuel type or energy source.
+     */
     p3: StringField;
-    /** The vehicle's administrative power (fiscal horsepower). */
+    /**
+     * The vehicle's administrative power (fiscal horsepower).
+     */
     p6: StringField;
-    /** The vehicle's power to weight ratio. */
+    /**
+     * The vehicle's power to weight ratio.
+     */
     q: StringField;
-    /** The vehicle's number of seats. */
+    /**
+     * The vehicle's number of seats.
+     */
     s1: StringField;
-    /** The vehicle's number of standing rooms (person). */
+    /**
+     * The vehicle's number of standing rooms (person).
+     */
     s2: StringField;
-    /** The vehicle's sound level (dB). */
+    /**
+     * The vehicle's sound level (dB).
+     */
     u1: StringField;
-    /** The vehicle engine's rotation speed (RPM). */
+    /**
+     * The vehicle engine's rotation speed (RPM).
+     */
     u2: StringField;
-    /** The vehicle's CO2 emission (g/km). */
+    /**
+     * The vehicle's CO2 emission (g/km).
+     */
     v7: StringField;
-    /** Next technical control date. */
+    /**
+     * Next technical control date.
+     */
     x1: StringField;
-    /** Amount of the regional proportional tax of the registration (in euros). */
+    /**
+     * Amount of the regional proportional tax of the registration (in euros).
+     */
     y1: StringField;
-    /** Amount of the additional parafiscal tax of the registration (in euros). */
+    /**
+     * Amount of the additional parafiscal tax of the registration (in euros).
+     */
     y2: StringField;
-    /** Amount of the additional CO2 tax of the registration (in euros). */
+    /**
+     * Amount of the additional CO2 tax of the registration (in euros).
+     */
     y3: StringField;
-    /** Amount of the fee for managing the registration (in euros). */
+    /**
+     * Amount of the fee for managing the registration (in euros).
+     */
     y4: StringField;
-    /** Amount of the fee for delivery of the registration certificate in euros. */
+    /**
+     * Amount of the fee for delivery of the registration certificate in euros.
+     */
     y5: StringField;
-    /** Total amount of registration fee to be paid in euros. */
+    /**
+     * Total amount of registration fee to be paid in euros.
+     */
     y6: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/fr/idCard/idCardV2.d.ts

@@ -5,13 +5,21 @@ import { IdCardV2Page } from "./idCardV2Page.js";
  * Carte Nationale d'Identité API version 2 inference prediction.
  */
 export declare class IdCardV2 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: IdCardV2Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<IdCardV2Page>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/fr/idCard/idCardV2.js

@@ -7,11 +7,17 @@ import { IdCardV2Page } from "./idCardV2Page.js";
 export class IdCardV2 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "idcard_fr";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "2";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new IdCardV2Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {

package/src/v1/product/fr/idCard/idCardV2Document.d.ts

@@ -4,35 +4,65 @@ import { DateField, StringField } from "../../../parsing/standard/index.js";
  * Carte Nationale d'Identité API version 2.0 document data.
  */
 export declare class IdCardV2Document implements Prediction {
-    /** The alternate name of the card holder. */
+    /**
+     * The alternate name of the card holder.
+     */
     alternateName: StringField;
-    /** The name of the issuing authority. */
+    /**
+     * The name of the issuing authority.
+     */
     authority: StringField;
-    /** The date of birth of the card holder. */
+    /**
+     * The date of birth of the card holder.
+     */
     birthDate: DateField;
-    /** The place of birth of the card holder. */
+    /**
+     * The place of birth of the card holder.
+     */
     birthPlace: StringField;
-    /** The card access number (CAN). */
+    /**
+     * The card access number (CAN).
+     */
     cardAccessNumber: StringField;
-    /** The document number. */
+    /**
+     * The document number.
+     */
     documentNumber: StringField;
-    /** The expiry date of the identification card. */
+    /**
+     * The expiry date of the identification card.
+     */
     expiryDate: DateField;
-    /** The gender of the card holder. */
+    /**
+     * The gender of the card holder.
+     */
     gender: StringField;
-    /** The given name(s) of the card holder. */
+    /**
+     * The given name(s) of the card holder.
+     */
     givenNames: StringField[];
-    /** The date of issue of the identification card. */
+    /**
+     * The date of issue of the identification card.
+     */
     issueDate: DateField;
-    /** The Machine Readable Zone, first line. */
+    /**
+     * The Machine Readable Zone, first line.
+     */
     mrz1: StringField;
-    /** The Machine Readable Zone, second line. */
+    /**
+     * The Machine Readable Zone, second line.
+     */
     mrz2: StringField;
-    /** The Machine Readable Zone, third line. */
+    /**
+     * The Machine Readable Zone, third line.
+     */
     mrz3: StringField;
-    /** The nationality of the card holder. */
+    /**
+     * The nationality of the card holder.
+     */
     nationality: StringField;
-    /** The surname of the card holder. */
+    /**
+     * The surname of the card holder.
+     */
     surname: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/fr/idCard/idCardV2Document.js

@@ -5,7 +5,9 @@ import { DateField, StringField } from "../../../parsing/standard/index.js";
  */
 export class IdCardV2Document {
     constructor(rawPrediction, pageId) {
-        /** The given name(s) of the card holder. */
+        /**
+         * The given name(s) of the card holder.
+         */
         this.givenNames = [];
         this.alternateName = new StringField({
             prediction: rawPrediction["alternate_name"],

package/src/v1/product/fr/idCard/idCardV2Page.d.ts

@@ -5,9 +5,13 @@ import { IdCardV2Document } from "./idCardV2Document.js";
  * Carte Nationale d'Identité API version 2.0 page data.
  */
 export declare class IdCardV2Page extends IdCardV2Document {
-    /** The sides of the document which are visible. */
+    /**
+     * The sides of the document which are visible.
+     */
     documentSide: ClassificationField;
-    /** The document type or format. */
+    /**
+     * The document type or format.
+     */
     documentType: ClassificationField;
     constructor(rawPrediction: StringDict, pageId?: number);
     toString(): string;

package/src/v1/product/generated/generatedV1.d.ts

@@ -5,13 +5,21 @@ import { GeneratedV1Page } from "./generatedV1Page.js";
  * Generated API V1 inference results.
  */
 export declare class GeneratedV1 extends Inference {
-    /** The endpoint's name. Note: placeholder for custom APIs. */
+    /**
+     * The endpoint's name. Note: placeholder for custom APIs.
+     */
     endpointName: string;
-    /** The endpoint's version. Note: placeholder for custom APIs. */
+    /**
+     * The endpoint's version. Note: placeholder for custom APIs.
+     */
     endpointVersion: string;
-    /** The document-level prediction. */
+    /**
+     * The document-level prediction.
+     */
     prediction: GeneratedV1Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<GeneratedV1Page>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/generated/generatedV1.js

@@ -7,11 +7,17 @@ import { GeneratedV1Page } from "./generatedV1Page.js";
 export class GeneratedV1 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. Note: placeholder for custom APIs. */
+        /**
+         * The endpoint's name. Note: placeholder for custom APIs.
+         */
         this.endpointName = "custom";
-        /** The endpoint's version. Note: placeholder for custom APIs. */
+        /**
+         * The endpoint's version. Note: placeholder for custom APIs.
+         */
         this.endpointVersion = "1";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new GeneratedV1Document(rawPrediction["prediction"]);
         this.pages = rawPrediction["pages"].length > 0 && Object.keys(rawPrediction["pages"][0]["prediction"]).length > 0 ?

package/src/v1/product/generated/generatedV1Prediction.d.ts

@@ -1,9 +1,13 @@
 import { Prediction } from "../../parsing/common/index.js";
 import { GeneratedListField } from "../../parsing/generated/index.js";
 import { StringField } from "../../parsing/standard/index.js";
-/** Dynamic prediction container for generated v1 products. */
+/**
+ * Dynamic prediction container for generated v1 products.
+ */
 export declare class GeneratedV1Prediction implements Prediction {
-    /** Map of all fields in the document. */
+    /**
+     * Map of all fields in the document.
+     */
     fields: Map<string, any>;
     constructor();
     toString(): string;

package/src/v1/product/generated/generatedV1Prediction.js

@@ -1,7 +1,9 @@
 import { cleanOutString } from "../../parsing/common/index.js";
 import { GeneratedListField, GeneratedObjectField } from "../../parsing/generated/index.js";
 import { StringField } from "../../parsing/standard/index.js";
-/** Dynamic prediction container for generated v1 products. */
+/**
+ * Dynamic prediction container for generated v1 products.
+ */
 export class GeneratedV1Prediction {
     constructor() {
         this.fields = new Map();

package/src/v1/product/internationalId/internationalIdV2.d.ts

@@ -4,13 +4,21 @@ import { InternationalIdV2Document } from "./internationalIdV2Document.js";
  * International ID API version 2 inference prediction.
  */
 export declare class InternationalIdV2 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: InternationalIdV2Document;
-    /** The document's pages. */
+    /**
+     * The document's pages.
+     */
     pages: Page<InternationalIdV2Document>[];
     constructor(rawPrediction: StringDict);
 }

package/src/v1/product/internationalId/internationalIdV2.js

@@ -6,11 +6,17 @@ import { InternationalIdV2Document } from "./internationalIdV2Document.js";
 export class InternationalIdV2 extends Inference {
     constructor(rawPrediction) {
         super(rawPrediction);
-        /** The endpoint's name. */
+        /**
+         * The endpoint's name.
+         */
         this.endpointName = "international_id";
-        /** The endpoint's version. */
+        /**
+         * The endpoint's version.
+         */
         this.endpointVersion = "2";
-        /** The document's pages. */
+        /**
+         * The document's pages.
+         */
         this.pages = [];
         this.prediction = new InternationalIdV2Document(rawPrediction["prediction"]);
         rawPrediction["pages"].forEach((page) => {