mindee 5.9.0 → 5.10.0

package/src/v1/product/passport/passportV1Document.d.ts

@@ -4,27 +4,49 @@ import { DateField, StringField } from "../../parsing/standard/index.js";
  * Passport API version 1.1 document data.
  */
 export declare class PassportV1Document implements Prediction {
-    /** The date of birth of the passport holder. */
+    /**
+     * The date of birth of the passport holder.
+     */
     birthDate: DateField;
-    /** The place of birth of the passport holder. */
+    /**
+     * The place of birth of the passport holder.
+     */
     birthPlace: StringField;
-    /** The country's 3 letter code (ISO 3166-1 alpha-3). */
+    /**
+     * The country's 3 letter code (ISO 3166-1 alpha-3).
+     */
     country: StringField;
-    /** The expiry date of the passport. */
+    /**
+     * The expiry date of the passport.
+     */
     expiryDate: DateField;
-    /** The gender of the passport holder. */
+    /**
+     * The gender of the passport holder.
+     */
     gender: StringField;
-    /** The given name(s) of the passport holder. */
+    /**
+     * The given name(s) of the passport holder.
+     */
     givenNames: StringField[];
-    /** The passport's identification number. */
+    /**
+     * The passport's identification number.
+     */
     idNumber: StringField;
-    /** The date the passport was issued. */
+    /**
+     * The date the passport was issued.
+     */
     issuanceDate: DateField;
-    /** 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 surname of the passport holder. */
+    /**
+     * The surname of the passport holder.
+     */
     surname: StringField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/passport/passportV1Document.js

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

package/src/v1/product/receipt/receiptV5.d.ts

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

package/src/v1/product/receipt/receiptV5.js

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

package/src/v1/product/receipt/receiptV5Document.d.ts

@@ -5,39 +5,73 @@ import { AmountField, ClassificationField, CompanyRegistrationField, DateField,
  * Receipt API version 5.4 document data.
  */
 export declare class ReceiptV5Document implements Prediction {
-    /** The purchase category of the receipt. */
+    /**
+     * The purchase category of the receipt.
+     */
     category: ClassificationField;
-    /** The date the purchase was made. */
+    /**
+     * The date the purchase was made.
+     */
     date: DateField;
-    /** The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT. */
+    /**
+     * The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
+     */
     documentType: ClassificationField;
-    /** List of all line items on the receipt. */
+    /**
+     * List of all line items on the receipt.
+     */
     lineItems: ReceiptV5LineItem[];
-    /** The locale of the document. */
+    /**
+     * The locale of the document.
+     */
     locale: LocaleField;
-    /** The receipt number or identifier. */
+    /**
+     * The receipt number or identifier.
+     */
     receiptNumber: StringField;
-    /** The purchase subcategory of the receipt for transport and food. */
+    /**
+     * The purchase subcategory of the receipt for transport and food.
+     */
     subcategory: ClassificationField;
-    /** The address of the supplier or merchant. */
+    /**
+     * The address of the supplier or merchant.
+     */
     supplierAddress: StringField;
-    /** List of company registration numbers associated to the supplier. */
+    /**
+     * List of company registration numbers associated to the supplier.
+     */
     supplierCompanyRegistrations: CompanyRegistrationField[];
-    /** The name of the supplier or merchant. */
+    /**
+     * The name of the supplier or merchant.
+     */
     supplierName: StringField;
-    /** The phone number of the supplier or merchant. */
+    /**
+     * The phone number of the supplier or merchant.
+     */
     supplierPhoneNumber: StringField;
-    /** The list of taxes present on the receipt. */
+    /**
+     * The list of taxes present on the receipt.
+     */
     taxes: Taxes;
-    /** The time the purchase was made. */
+    /**
+     * The time the purchase was made.
+     */
     time: StringField;
-    /** The total amount of tip and gratuity. */
+    /**
+     * The total amount of tip and gratuity.
+     */
     tip: AmountField;
-    /** The total amount paid: includes taxes, discounts, fees, tips, and gratuity. */
+    /**
+     * The total amount paid: includes taxes, discounts, fees, tips, and gratuity.
+     */
     totalAmount: AmountField;
-    /** The net amount paid: does not include taxes, fees, and discounts. */
+    /**
+     * The net amount paid: does not include taxes, fees, and discounts.
+     */
     totalNet: AmountField;
-    /** The sum of all taxes. */
+    /**
+     * The sum of all taxes.
+     */
     totalTax: AmountField;
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

package/src/v1/product/receipt/receiptV5Document.js

@@ -6,9 +6,13 @@ import { AmountField, ClassificationField, CompanyRegistrationField, DateField,
  */
 export class ReceiptV5Document {
     constructor(rawPrediction, pageId) {
-        /** List of all line items on the receipt. */
+        /**
+         * List of all line items on the receipt.
+         */
         this.lineItems = [];
-        /** List of company registration numbers associated to the supplier. */
+        /**
+         * List of company registration numbers associated to the supplier.
+         */
         this.supplierCompanyRegistrations = [];
         this.category = new ClassificationField({
             prediction: rawPrediction["category"],

package/src/v1/product/receipt/receiptV5LineItem.d.ts

@@ -5,17 +5,29 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class ReceiptV5LineItem {
     #private;
-    /** The item description. */
+    /**
+     * The item description.
+     */
     description: string | null;
-    /** The item quantity. */
+    /**
+     * The item quantity.
+     */
     quantity: number | null;
-    /** The item total amount. */
+    /**
+     * The item total amount.
+     */
     totalAmount: number | null;
-    /** The item unit price. */
+    /**
+     * The item unit price.
+     */
     unitPrice: number | 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/receipt/receiptV5LineItem.js

@@ -12,7 +12,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class ReceiptV5LineItem {
     constructor({ prediction = {} }) {
         _ReceiptV5LineItem_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/resumeV1.d.ts

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

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

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

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

@@ -5,17 +5,29 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class ResumeV1Certificate {
     #private;
-    /** The grade obtained for the certificate. */
+    /**
+     * The grade obtained for the certificate.
+     */
     grade: string | null;
-    /** The name of certification. */
+    /**
+     * The name of certification.
+     */
     name: string | null;
-    /** The organization or institution that issued the certificate. */
+    /**
+     * The organization or institution that issued the certificate.
+     */
     provider: string | null;
-    /** The year when a certificate was issued or received. */
+    /**
+     * The year when a certificate was issued or received.
+     */
     year: 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/resumeV1Certificate.js

@@ -12,7 +12,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class ResumeV1Certificate {
     constructor({ prediction = {} }) {
         _ResumeV1Certificate_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/resumeV1Document.d.ts

@@ -9,39 +9,73 @@ import { ClassificationField, StringField } from "../../parsing/standard/index.j
  * Resume API version 1.2 document data.
  */
 export declare class ResumeV1Document implements Prediction {
-    /** The location information of the candidate, including city, state, and country. */
+    /**
+     * The location information of the candidate, including city, state, and country.
+     */
     address: StringField;
-    /** The list of certificates obtained by the candidate. */
+    /**
+     * The list of certificates obtained by the candidate.
+     */
     certificates: ResumeV1Certificate[];
-    /** The ISO 639 code of the language in which the document is written. */
+    /**
+     * The ISO 639 code of the language in which the document is written.
+     */
     documentLanguage: StringField;
-    /** The type of the document sent. */
+    /**
+     * The type of the document sent.
+     */
     documentType: ClassificationField;
-    /** The list of the candidate's educational background. */
+    /**
+     * The list of the candidate's educational background.
+     */
     education: ResumeV1Education[];
-    /** The email address of the candidate. */
+    /**
+     * The email address of the candidate.
+     */
     emailAddress: StringField;
-    /** The candidate's first or given names. */
+    /**
+     * The candidate's first or given names.
+     */
     givenNames: StringField[];
-    /** The list of the candidate's technical abilities and knowledge. */
+    /**
+     * The list of the candidate's technical abilities and knowledge.
+     */
     hardSkills: StringField[];
-    /** The position that the candidate is applying for. */
+    /**
+     * The position that the candidate is applying for.
+     */
     jobApplied: StringField;
-    /** The list of languages that the candidate is proficient in. */
+    /**
+     * The list of languages that the candidate is proficient in.
+     */
     languages: ResumeV1Language[];
-    /** The ISO 3166 code for the country of citizenship of the candidate. */
+    /**
+     * The ISO 3166 code for the country of citizenship of the candidate.
+     */
     nationality: StringField;
-    /** The phone number of the candidate. */
+    /**
+     * The phone number of the candidate.
+     */
     phoneNumber: StringField;
-    /** The candidate's current profession. */
+    /**
+     * The candidate's current profession.
+     */
     profession: StringField;
-    /** The list of the candidate's professional experiences. */
+    /**
+     * The list of the candidate's professional experiences.
+     */
     professionalExperiences: ResumeV1ProfessionalExperience[];
-    /** The list of social network profiles of the candidate. */
+    /**
+     * The list of social network profiles of the candidate.
+     */
     socialNetworksUrls: ResumeV1SocialNetworksUrl[];
-    /** The list of the candidate's interpersonal and communication abilities. */
+    /**
+     * The list of the candidate's interpersonal and communication abilities.
+     */
     softSkills: StringField[];
-    /** The candidate's last names. */
+    /**
+     * The candidate's last names.
+     */
     surnames: StringField[];
     constructor(rawPrediction: StringDict, pageId?: number);
     /**

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

@@ -10,23 +10,41 @@ import { ClassificationField, StringField } from "../../parsing/standard/index.j
  */
 export class ResumeV1Document {
     constructor(rawPrediction, pageId) {
-        /** The list of certificates obtained by the candidate. */
+        /**
+         * The list of certificates obtained by the candidate.
+         */
         this.certificates = [];
-        /** The list of the candidate's educational background. */
+        /**
+         * The list of the candidate's educational background.
+         */
         this.education = [];
-        /** The candidate's first or given names. */
+        /**
+         * The candidate's first or given names.
+         */
         this.givenNames = [];
-        /** The list of the candidate's technical abilities and knowledge. */
+        /**
+         * The list of the candidate's technical abilities and knowledge.
+         */
         this.hardSkills = [];
-        /** The list of languages that the candidate is proficient in. */
+        /**
+         * The list of languages that the candidate is proficient in.
+         */
         this.languages = [];
-        /** The list of the candidate's professional experiences. */
+        /**
+         * The list of the candidate's professional experiences.
+         */
         this.professionalExperiences = [];
-        /** The list of social network profiles of the candidate. */
+        /**
+         * The list of social network profiles of the candidate.
+         */
         this.socialNetworksUrls = [];
-        /** The list of the candidate's interpersonal and communication abilities. */
+        /**
+         * The list of the candidate's interpersonal and communication abilities.
+         */
         this.softSkills = [];
-        /** The candidate's last names. */
+        /**
+         * The candidate's last names.
+         */
         this.surnames = [];
         this.address = new StringField({
             prediction: rawPrediction["address"],

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

@@ -5,23 +5,41 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class ResumeV1Education {
     #private;
-    /** The area of study or specialization. */
+    /**
+     * The area of study or specialization.
+     */
     degreeDomain: string | null;
-    /** The type of degree obtained, such as Bachelor's, Master's, or Doctorate. */
+    /**
+     * The type of degree obtained, such as Bachelor's, Master's, or Doctorate.
+     */
     degreeType: string | null;
-    /** The month when the education program or course was completed. */
+    /**
+     * The month when the education program or course was completed.
+     */
     endMonth: string | null;
-    /** The year when the education program or course was completed. */
+    /**
+     * The year when the education program or course was completed.
+     */
     endYear: string | null;
-    /** The name of the school. */
+    /**
+     * The name of the school.
+     */
     school: string | null;
-    /** The month when the education program or course began. */
+    /**
+     * The month when the education program or course began.
+     */
     startMonth: string | null;
-    /** The year when the education program or course began. */
+    /**
+     * The year when the education program or course 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/resumeV1Education.js

@@ -12,7 +12,9 @@ import { Polygon } from "../../../geometry/index.js";
 export class ResumeV1Education {
     constructor({ prediction = {} }) {
         _ResumeV1Education_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/resumeV1Language.d.ts

@@ -5,13 +5,21 @@ import { Polygon } from "../../../geometry/index.js";
  */
 export declare class ResumeV1Language {
     #private;
-    /** The language's ISO 639 code. */
+    /**
+     * The language's ISO 639 code.
+     */
     language: string | null;
-    /** The candidate's level for the language. */
+    /**
+     * The candidate's level for the language.
+     */
     level: 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/resumeV1Language.js

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