mindee 3.6.0 → 3.7.0

package/src/documents/custom/lineitems.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLineItems = exports.LineItems = exports.Line = void 0;
+const handler_1 = require("../../errors/handler");
+const errors_1 = require("../../errors");
+const geometry_1 = require("../../geometry");
+const fields_1 = require("./fields");
+const math_1 = require("../../math");
+class Line {
+    constructor(rowNumber, heightTolerance) {
+        this.rowNumber = rowNumber;
+        this.bbox = [1, 1, 0, 0];
+        this.fields = new Map();
+        this.heightTolerance = heightTolerance;
+    }
+    /**
+     * Extends the current bbox of the line with the bbox.
+     */
+    extendWithBbox(bbox) {
+        this.bbox = (0, geometry_1.mergeBbox)(this.bbox, bbox);
+    }
+    /**
+     * Extends the current bbox of the line with the polygon.
+     */
+    extendWith(polygon) {
+        this.bbox = (0, geometry_1.mergeBbox)(this.bbox, (0, geometry_1.getBbox)(polygon));
+    }
+    /**
+     * Check if the bbox fits the current line.
+     */
+    contains(bbox) {
+        return (0, math_1.precisionEquals)(this.bbox[1], bbox[1], this.heightTolerance);
+    }
+    updateField(name, fieldValue) {
+        if (!this.fields.has(name)) {
+            this.fields.set(name, fieldValue);
+        }
+        else {
+            const existingField = this.fields.get(name);
+            if (existingField === undefined) {
+                handler_1.errorHandler.throw(new errors_1.MindeeError(`The field '${name}' should exist but was not found.`));
+                return;
+            }
+            const mergedContent = existingField?.content === undefined
+                ? fieldValue.content
+                : existingField.content + " " + fieldValue.content;
+            const mergedBbox = (0, geometry_1.getBBoxForPolygons)([
+                existingField.polygon,
+                fieldValue.polygon,
+            ]);
+            this.fields.set(name, new fields_1.ListFieldValue({
+                content: mergedContent,
+                confidence: existingField.confidence * fieldValue.confidence,
+                polygon: (0, geometry_1.getBoundingBoxFromBBox)(mergedBbox),
+            }));
+        }
+    }
+}
+exports.Line = Line;
+class LineItems {
+    constructor(lines) {
+        this.rows = [];
+        this.rows = lines;
+    }
+}
+exports.LineItems = LineItems;
+function getLineItems(anchorNames, heigthLineTolerance, fieldNamesTargeted, fields) {
+    const fieldsToTransformIntoLines = new Map([...fields].filter(([k]) => fieldNamesTargeted.includes(k)));
+    const anchorName = findBestAnchor(anchorNames, fieldsToTransformIntoLines);
+    const lineItemsPrepared = prepare(anchorName, fieldsToTransformIntoLines, heigthLineTolerance);
+    lineItemsPrepared.rows.forEach((currentLine) => {
+        fieldsToTransformIntoLines.forEach((field, fieldName) => {
+            field.values.forEach((listFieldValue) => {
+                const minYCurrentValue = (0, geometry_1.getMinMaxY)(listFieldValue.polygon).min;
+                if (minYCurrentValue < currentLine.bbox[3] &&
+                    minYCurrentValue >= currentLine.bbox[1]) {
+                    currentLine.updateField(fieldName, listFieldValue);
+                }
+            });
+        });
+    });
+    return lineItemsPrepared;
+}
+exports.getLineItems = getLineItems;
+function findBestAnchor(possibleAnchorNames, fields) {
+    let anchorName = "";
+    let anchorRows = 0;
+    possibleAnchorNames.forEach((fieldName) => {
+        const fieldValues = fields.get(fieldName)?.values;
+        if (fieldValues !== undefined && fieldValues.length > anchorRows) {
+            anchorRows = fieldValues.length;
+            anchorName = fieldName;
+        }
+    });
+    if (anchorName === "") {
+        handler_1.errorHandler.throw(new errors_1.MindeeError("No anchor was found."));
+    }
+    return anchorName;
+}
+function prepare(anchorName, fields, heigthLineTolerance) {
+    const lineItemsPrepared = [];
+    const anchorField = fields.get(anchorName);
+    if (anchorField === undefined || anchorField.values.length === 0) {
+        handler_1.errorHandler.throw(new errors_1.MindeeError("No lines have been detected."));
+    }
+    let currentLineNumber = 1;
+    let currentLine = new Line(currentLineNumber, heigthLineTolerance);
+    let currentValue = anchorField.values[0];
+    currentLine.extendWith(currentValue.polygon);
+    if (anchorField !== undefined) {
+        for (let index = 1; index < anchorField.values.length; index++) {
+            currentValue = anchorField.values[index];
+            const currentFieldBbox = (0, geometry_1.getBbox)(currentValue.polygon);
+            if (!currentLine.contains(currentFieldBbox)) {
+                lineItemsPrepared.push(currentLine);
+                currentLineNumber++;
+                currentLine = new Line(currentLineNumber, heigthLineTolerance);
+            }
+            currentLine.extendWithBbox(currentFieldBbox);
+        }
+        if (lineItemsPrepared.filter((line) => line.rowNumber === currentLineNumber)
+            .length === 0) {
+            lineItemsPrepared.push(currentLine);
+        }
+    }
+    return new LineItems(lineItemsPrepared);
+}

package/src/documents/document.d.ts

@@ -1,7 +1,7 @@
 import { InputSource } from "../inputs";
 import { PositionField, FullText, OrientationField, StringDict } from "../fields";
 export type DocumentSig<DocType extends Document> = {
-    new ({ prediction, orientation, extras, inputSource, pageId, fullText, documentType, }: DocumentConstructorProps): DocType;
+    new ({ prediction, orientation, extras, pageId, fullText, documentType, inputSource, }: DocumentConstructorProps): DocType;
 };
 export interface DocumentConstructorProps extends BaseDocumentConstructorProps {
     /** JSON parsed prediction from HTTP response */

package/src/documents/documentConfig.d.ts

@@ -1,5 +1,5 @@
 import { InputSource } from "../inputs";
-import { Response, Endpoint, predictResponse } from "../api";
+import { Response, Endpoint, EndpointResponse, AsyncPredictResponse } from "../api";
 import { Document, FinancialDocumentV0, CustomV1, DocumentSig } from "./index";
 import { PageOptions } from "../inputs";
 interface CustomDocConstructor {
@@ -13,15 +13,23 @@ export declare class DocumentConfig<DocType extends Document> {
     readonly endpoints: Array<Endpoint>;
     readonly documentClass: DocumentSig<DocType>;
     constructor(documentClass: DocumentSig<DocType>, endpoints: Array<Endpoint>, documentType?: string);
-    protected predictRequest(inputDoc: InputSource, includeWords: boolean, cropping: boolean): Promise<predictResponse>;
-    buildResult(inputFile: InputSource, response: predictResponse): Response<DocType>;
     predict(params: {
         inputDoc: InputSource;
         includeWords: boolean;
         pageOptions?: PageOptions;
         cropper: boolean;
     }): Promise<Response<DocType>>;
+    asyncPredict(params: {
+        inputDoc: InputSource;
+        includeWords: boolean;
+        pageOptions?: PageOptions;
+        cropper: boolean;
+    }): Promise<AsyncPredictResponse<DocType>>;
+    getQueuedDocument(queuId: string): Promise<AsyncPredictResponse<DocType>>;
     cutDocPages(inputDoc: InputSource, pageOptions: PageOptions): Promise<void>;
+    protected predictRequest(inputDoc: InputSource, includeWords: boolean, cropping: boolean): Promise<EndpointResponse>;
+    protected handleError(response: EndpointResponse, statusCode?: number): void;
+    protected buildResult(response: EndpointResponse, inputFile?: InputSource): Response<DocType>;
     protected checkApiKeys(): void;
 }
 export declare class CustomDocConfig extends DocumentConfig<CustomV1> {
@@ -29,6 +37,6 @@ export declare class CustomDocConfig extends DocumentConfig<CustomV1> {
 }
 export declare class FinancialDocV0Config extends DocumentConfig<FinancialDocumentV0> {
     constructor(apiKey: string);
-    protected predictRequest(inputDoc: InputSource, includeWords: boolean, cropping: boolean): Promise<predictResponse>;
+    protected predictRequest(inputDoc: InputSource, includeWords: boolean, cropping: boolean): Promise<EndpointResponse>;
 }
 export {};

package/src/documents/documentConfig.js

@@ -10,28 +10,6 @@ class DocumentConfig {
         this.endpoints = endpoints;
         this.documentClass = documentClass;
     }
-    async predictRequest(inputDoc, includeWords, cropping) {
-        return await this.endpoints[0].predictReqPost(inputDoc, includeWords, cropping);
-    }
-    buildResult(inputFile, response) {
-        const statusCode = response.messageObj.statusCode;
-        if (statusCode === undefined || statusCode > 201) {
-            const errorMessage = JSON.stringify(response.data, null, 2);
-            handler_1.errorHandler.throw(new Error(`${this.endpoints[0].urlName} API ${statusCode} HTTP error: ${errorMessage}`));
-            return new api_1.Response(this.documentClass, {
-                httpResponse: response,
-                documentType: this.documentType,
-                input: inputFile,
-                error: true,
-            });
-        }
-        return new api_1.Response(this.documentClass, {
-            httpResponse: response,
-            documentType: this.documentType,
-            input: inputFile,
-            error: false,
-        });
-    }
     async predict(params) {
         this.checkApiKeys();
         await params.inputDoc.init();
@@ -39,17 +17,70 @@ class DocumentConfig {
             await this.cutDocPages(params.inputDoc, params.pageOptions);
         }
         const response = await this.predictRequest(params.inputDoc, params.includeWords, params.cropper);
-        return this.buildResult(params.inputDoc, response);
+        return this.buildResult(response, params.inputDoc);
+    }
+    async asyncPredict(params) {
+        this.checkApiKeys();
+        await params.inputDoc.init();
+        if (params.pageOptions !== undefined) {
+            await this.cutDocPages(params.inputDoc, params.pageOptions);
+        }
+        const response = await this.endpoints[0].predictAsyncReqPost(params.inputDoc, params.includeWords, params.cropper);
+        const statusCode = response.messageObj.statusCode;
+        if (statusCode === undefined || statusCode >= 202) {
+            this.handleError(response, statusCode);
+        }
+        return new api_1.AsyncPredictResponse(response.data);
+    }
+    async getQueuedDocument(queuId) {
+        this.checkApiKeys();
+        const queueResponse = await this.endpoints[0].documentQueueReqGet(queuId);
+        const queueStatusCode = queueResponse.messageObj.statusCode;
+        if (queueStatusCode === undefined ||
+            queueStatusCode < 200 ||
+            queueStatusCode > 302) {
+            this.handleError(queueResponse, queueStatusCode);
+        }
+        if (queueStatusCode === 302 &&
+            queueResponse.messageObj.headers.location !== undefined) {
+            const docId = queueResponse.messageObj.headers.location.split("/").pop();
+            if (docId !== undefined) {
+                const docResponse = await this.endpoints[0].documentGetReq(docId);
+                const document = this.buildResult(docResponse);
+                return new api_1.AsyncPredictResponse(docResponse.data, document);
+            }
+        }
+        return new api_1.AsyncPredictResponse(queueResponse.data);
     }
     async cutDocPages(inputDoc, pageOptions) {
         if (inputDoc.isPdf()) {
             await inputDoc.cutPdf(pageOptions);
         }
     }
+    // this is only a separate function because of financial docs
+    async predictRequest(inputDoc, includeWords, cropping) {
+        return await this.endpoints[0].predictReqPost(inputDoc, includeWords, cropping);
+    }
+    handleError(response, statusCode) {
+        const errorMessage = JSON.stringify(response.data, null, 2);
+        handler_1.errorHandler.throw(new Error(`${this.endpoints[0].urlName} API ${statusCode} HTTP error: ${errorMessage}`));
+    }
+    buildResult(response, inputFile) {
+        const statusCode = response.messageObj.statusCode;
+        if (statusCode === undefined || statusCode > 201) {
+            this.handleError(response, statusCode);
+        }
+        return new api_1.Response(this.documentClass, {
+            httpResponse: response,
+            documentType: this.documentType,
+            error: false,
+            input: inputFile,
+        });
+    }
     checkApiKeys() {
         this.endpoints.forEach((endpoint) => {
             if (!endpoint.apiKey) {
-                throw new Error(`Missing API key for '${this.documentType}', check your Client configuration.
+                throw new Error(`Missing API key for '${endpoint.urlName} ${endpoint.version}', check your Client configuration.
 You can set this using the '${api_1.API_KEY_ENVVAR_NAME}' environment variable.\n`);
             }
         });

package/src/documents/eu/licensePlate/licensePlateV1.js

@@ -19,9 +19,11 @@ class LicensePlateV1 extends document_1.Document {
         })));
     }
     toString() {
-        const outStr = `----- EU License plate V1 -----
+        const outStr = `----- EU License Plate V1 -----
 Filename: ${this.filename}
-License plates: ${this.licensePlates.map((plate) => plate.value).join(", ")}
+License Plates: ${this.licensePlates
+            .map((plate) => plate.value)
+            .join("\n                ")}
 ----------------------
 `;
         return LicensePlateV1.cleanOutString(outStr);

package/src/documents/fr/bankAccountDetails/bankAccountDetailsV1.js

@@ -27,9 +27,10 @@ class BankAccountDetailsV1 extends document_1.Document {
     }
     toString() {
         const outStr = `----- FR Bank Account Details V1 -----
+Filename: ${this.filename}
 IBAN: ${this.iban}
-Account holder name: ${this.accountHolderName}
-SWIFT: ${this.swift}
+Account Holder's Name: ${this.accountHolderName}
+SWIFT Code: ${this.swift}
 ----------------------
 `;
         return BankAccountDetailsV1.cleanOutString(outStr);

package/src/documents/fr/carteVitale/carteVitaleV1.js

@@ -33,10 +33,10 @@ class CarteVitaleV1 extends document_1.Document {
     toString() {
         const outStr = `----- FR Carte Vitale V1 -----
 Filename: ${this.filename}
-Given names: ${this.givenNames.map((name) => name.value).join(" ")}
+Given Name(s): ${this.givenNames.map((name) => name.value).join(" ")}
 Surname: ${this.surname}
 Social Security Number: ${this.socialSecurity}
-Issuance date: ${this.issuanceDate}
+Issuance Date: ${this.issuanceDate}
 ----------------------
 `;
         return CarteVitaleV1.cleanOutString(outStr);

package/src/documents/fr/idCard/idCardV1.js

@@ -58,19 +58,19 @@ class IdCardV1 extends document_1.Document {
         })));
     }
     toString() {
-        const outStr = `----- FR ID Card V1 -----
+        const outStr = `----- FR Carte Nationale d'Identité V1 -----
 Filename: ${this.filename}
-Document side: ${this.documentSide}
-Authority: ${this.authority}
-Given names: ${this.givenNames.map((name) => name.value).join(" ")}
+Document Side: ${this.documentSide}
+Identity Number: ${this.idNumber}
+Given Name(s): ${this.givenNames.map((name) => name.value).join(" ")}
 Surname: ${this.surname}
+Date of Birth: ${this.birthDate}
+Place of Birth: ${this.birthPlace}
+Expiry Date: ${this.expiryDate}
+Issuing Authority: ${this.authority}
 Gender: ${this.gender}
-ID Number: ${this.idNumber}
-Birth date: ${this.birthDate}
-Birth place: ${this.birthPlace}
-Expiry date: ${this.expiryDate}
-MRZ 1: ${this.mrz1}
-MRZ 2: ${this.mrz2}
+MRZ Line 1: ${this.mrz1}
+MRZ Line 2: ${this.mrz2}
 ----------------------
 `;
         return IdCardV1.cleanOutString(outStr);

package/src/documents/index.d.ts

@@ -7,10 +7,11 @@ export { PassportV1 } from "./passport/passportV1";
 export { FinancialDocumentV0 } from "./financialDocument/financialDocumentV0";
 export { FinancialDocumentV1 } from "./financialDocument/financialDocumentV1";
 export { CustomV1 } from "./custom/customV1";
+export { getLineItems } from "./custom/lineitems";
 export { CropperV1 } from "./cropper/cropperV1";
 export { MindeeVisionV1 } from "./mindeeVision/mindeeVisionV1";
 export { ProofOfAddressV1 } from "./proofOfAddress/proofOfAddressV1";
-export { ShippingContainerV1 } from "./shipping_container/shippingContainerV1";
+export { ShippingContainerV1 } from "./shippingContainer/shippingContainerV1";
 export { Document, DocumentConstructorProps, DocumentSig } from "./document";
 export * as fr from "./fr";
 export * as us from "./us";

package/src/documents/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.CropperV1 = exports.CustomV1 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = void 0;
+exports.eu = exports.us = exports.fr = exports.Document = exports.ShippingContainerV1 = exports.ProofOfAddressV1 = exports.MindeeVisionV1 = exports.CropperV1 = exports.getLineItems = exports.CustomV1 = exports.FinancialDocumentV1 = exports.FinancialDocumentV0 = exports.PassportV1 = exports.ReceiptV4 = exports.ReceiptV3 = exports.PageGroup = exports.InvoiceSplitterV1 = exports.InvoiceV4 = exports.InvoiceV3 = void 0;
 var invoiceV3_1 = require("./invoice/invoiceV3");
 Object.defineProperty(exports, "InvoiceV3", { enumerable: true, get: function () { return invoiceV3_1.InvoiceV3; } });
 var invoiceV4_1 = require("./invoice/invoiceV4");
@@ -43,13 +43,15 @@ var financialDocumentV1_1 = require("./financialDocument/financialDocumentV1");
 Object.defineProperty(exports, "FinancialDocumentV1", { enumerable: true, get: function () { return financialDocumentV1_1.FinancialDocumentV1; } });
 var customV1_1 = require("./custom/customV1");
 Object.defineProperty(exports, "CustomV1", { enumerable: true, get: function () { return customV1_1.CustomV1; } });
+var lineitems_1 = require("./custom/lineitems");
+Object.defineProperty(exports, "getLineItems", { enumerable: true, get: function () { return lineitems_1.getLineItems; } });
 var cropperV1_1 = require("./cropper/cropperV1");
 Object.defineProperty(exports, "CropperV1", { enumerable: true, get: function () { return cropperV1_1.CropperV1; } });
 var mindeeVisionV1_1 = require("./mindeeVision/mindeeVisionV1");
 Object.defineProperty(exports, "MindeeVisionV1", { enumerable: true, get: function () { return mindeeVisionV1_1.MindeeVisionV1; } });
 var proofOfAddressV1_1 = require("./proofOfAddress/proofOfAddressV1");
 Object.defineProperty(exports, "ProofOfAddressV1", { enumerable: true, get: function () { return proofOfAddressV1_1.ProofOfAddressV1; } });
-var shippingContainerV1_1 = require("./shipping_container/shippingContainerV1");
+var shippingContainerV1_1 = require("./shippingContainer/shippingContainerV1");
 Object.defineProperty(exports, "ShippingContainerV1", { enumerable: true, get: function () { return shippingContainerV1_1.ShippingContainerV1; } });
 var document_1 = require("./document");
 Object.defineProperty(exports, "Document", { enumerable: true, get: function () { return document_1.Document; } });

package/src/documents/invoice/invoiceV4.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration, BaseField } from "../../fields";
+import { ClassificationField, TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration } from "../../fields";
 import { InvoiceLineItem } from "./invoiceLineItem";
 /** Invoice V4 */
 export declare class InvoiceV4 extends Document {
@@ -7,7 +7,7 @@ export declare class InvoiceV4 extends Document {
     /** Locale information. */
     locale: Locale;
     /** The nature of the invoice. */
-    documentType: BaseField;
+    documentType: ClassificationField;
     /** List of Reference numbers including PO number. */
     referenceNumbers: TextField[];
     /** The total amount with tax included. */

package/src/documents/invoice/invoiceV4.js

@@ -39,7 +39,7 @@ class InvoiceV4 extends document_1.Document {
             prediction: prediction.locale,
             valueKey: "language",
         });
-        this.documentType = new fields_1.BaseField({
+        this.documentType = new fields_1.ClassificationField({
             prediction: prediction.document_type,
             valueKey: "value",
         });

package/src/documents/invoiceSplitter/invoiceSplitterV1.d.ts

@@ -1,9 +1,9 @@
 import { Document, DocumentConstructorProps } from "../document";
+import { StringDict } from "../../fields";
 export declare class PageGroup {
     pageIndexes: number[];
-    constructor(prediction: {
-        [index: string]: number[];
-    });
+    confidence: number;
+    constructor(prediction: StringDict);
     toString(): string;
 }
 export declare class InvoiceSplitterV1 extends Document {

package/src/documents/invoiceSplitter/invoiceSplitterV1.js

@@ -6,6 +6,7 @@ class PageGroup {
     constructor(prediction) {
         this.pageIndexes = [];
         this.pageIndexes = prediction.page_indexes;
+        this.confidence = prediction.confidence;
     }
     toString() {
         return `page indexes: ${this.pageIndexes.join(", ")}`;

package/src/documents/proofOfAddress/proofOfAddressV1.js

@@ -19,7 +19,6 @@ class ProofOfAddressV1 extends document_1.Document {
         this.recipientCompanyRegistration = [];
         this.locale = new fields_1.Locale({
             prediction: prediction.locale,
-            valueKey: "language",
         });
         this.issuanceDate = new fields_1.DateField({
             prediction: prediction.date,
@@ -58,18 +57,18 @@ class ProofOfAddressV1 extends document_1.Document {
         const outStr = `----- Proof of Address V1 -----
 Filename: ${this.filename}
 Locale: ${this.locale}
-Issuer name: ${this.issuerName}
-Issuer Address: ${this.issuerAddress}
+Issuer Name: ${this.issuerName}
 Issuer Company Registrations: ${this.issuerCompanyRegistration
             .map((icr) => icr.value)
             .join(", ")}
-Recipient name: ${this.recipientName}
-Recipient Address: ${this.recipientAddress}
+Issuer Address: ${this.issuerAddress}
+Recipient Name: ${this.recipientName}
 Recipient Company Registrations: ${this.recipientCompanyRegistration
             .map((rcr) => rcr.value)
             .join(", ")}
-Issuance Date: ${this.issuanceDate}
+Recipient Address: ${this.recipientAddress}
 Dates: ${this.dates.map((rcr) => rcr.value).join("\n       ")}
+Date of Issue: ${this.issuanceDate}
 ----------------------
 `;
         return ProofOfAddressV1.cleanOutString(outStr);

package/src/documents/receipt/receiptV3.d.ts

@@ -1,5 +1,5 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { TaxField, TextField, Amount, Locale, DateField } from "../../fields";
+import { ClassificationField, TaxField, TextField, Amount, Locale, DateField } from "../../fields";
 export declare class ReceiptV3 extends Document {
     #private;
     /** Total amount with the tax amount of the purchase. */
@@ -9,7 +9,7 @@ export declare class ReceiptV3 extends Document {
     /** The purchase date. */
     date: DateField;
     /** The type of purchase. */
-    category: TextField;
+    category: ClassificationField;
     /** Merchant's name as seen on the receipt. */
     merchantName: TextField;
     /** Time as seen on the receipt in HH:MM format. */

package/src/documents/receipt/receiptV3.js

@@ -67,9 +67,8 @@ _ReceiptV3_instances = new WeakSet(), _ReceiptV3_initFromApiPrediction = functio
         prediction: apiPrediction.date,
         pageId: pageId,
     });
-    this.category = new fields_1.TextField({
+    this.category = new fields_1.ClassificationField({
         prediction: apiPrediction.category,
-        pageId: pageId,
     });
     this.merchantName = new fields_1.TextField({
         prediction: apiPrediction.supplier,

package/src/documents/receipt/receiptV4.d.ts

@@ -1,14 +1,14 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { Amount, DateField, TextField, Locale, TaxField } from "../../fields";
+import { ClassificationField, Amount, DateField, TextField, Locale, TaxField } from "../../fields";
 export declare class ReceiptV4 extends Document {
     /** Where the purchase was made, the language, and the currency. */
     locale: Locale;
     /** The purchase date. */
     date: DateField;
     /** The receipt category among predefined classes. */
-    category: TextField;
+    category: ClassificationField;
     /** The receipt sub-category among predefined classes. */
-    subCategory: TextField;
+    subCategory: ClassificationField;
     /** Whether the document is an expense receipt or a credit card receipt. */
     documentType: TextField;
     /** The name of the supplier or merchant, as seen on the receipt. */

package/src/documents/receipt/receiptV4.js

@@ -41,13 +41,11 @@ class ReceiptV4 extends document_1.Document {
             prediction: prediction.date,
             pageId: pageId,
         });
-        this.category = new fields_1.TextField({
+        this.category = new fields_1.ClassificationField({
             prediction: prediction.category,
-            pageId: pageId,
         });
-        this.subCategory = new fields_1.TextField({
+        this.subCategory = new fields_1.ClassificationField({
             prediction: prediction.subcategory,
-            pageId: pageId,
         });
         this.documentType = new fields_1.TextField({
             prediction: prediction.document_type,

package/src/documents/{shipping_container → shippingContainer}/shippingContainerV1.js

@@ -28,8 +28,8 @@ class ShippingContainerV1 extends document_1.Document {
         const outStr = `----- Shipping Container V1 -----
 Filename: ${this.filename}
 Owner: ${this.owner}
-Serial number: ${this.serialNumber}
-Size and type: ${this.sizeType}
+Serial Number: ${this.serialNumber}
+Size and Type: ${this.sizeType}
 ----------------------
 `;
         return ShippingContainerV1.cleanOutString(outStr);

package/src/fields/classification.d.ts

@@ -0,0 +1,8 @@
+import { BaseField, BaseFieldConstructor } from "./base";
+export declare class ClassificationField extends BaseField {
+    /** The confidence score of the prediction. */
+    confidence: number;
+    /** The classification. */
+    value?: string;
+    constructor({ prediction, valueKey, reconstructed, }: BaseFieldConstructor);
+}

package/src/fields/classification.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassificationField = void 0;
+const base_1 = require("./base");
+class ClassificationField extends base_1.BaseField {
+    constructor({ prediction, valueKey = "value", reconstructed = false, }) {
+        super({ prediction, valueKey, reconstructed });
+        this.confidence = prediction.confidence ? prediction.confidence : 0.0;
+    }
+}
+exports.ClassificationField = ClassificationField;

package/src/fields/field.d.ts

@@ -1,5 +1,5 @@
 import { StringDict, BaseField } from "./base";
-import { Polygon } from "../geometry";
+import { Polygon, BoundingBox } from "../geometry";
 export interface FieldConstructor {
     prediction: StringDict;
     valueKey?: string;
@@ -11,7 +11,7 @@ export declare class Field extends BaseField {
      * Contains exactly 4 relative vertices coordinates (points) of a right
      * rectangle containing the field in the document.
      */
-    bbox: Polygon;
+    boundingBox: BoundingBox;
     /**
      * Contains the relative vertices coordinates (points) of a polygon containing
      * the field in the document.

package/src/fields/field.js

@@ -13,11 +13,6 @@ class Field extends base_1.BaseField {
      */
     constructor({ prediction, valueKey = "value", reconstructed = false, pageId, }) {
         super({ prediction, valueKey, reconstructed });
-        /**
-         * Contains exactly 4 relative vertices coordinates (points) of a right
-         * rectangle containing the field in the document.
-         */
-        this.bbox = [];
         /**
          * Contains the relative vertices coordinates (points) of a polygon containing
          * the field in the document.
@@ -27,8 +22,8 @@ class Field extends base_1.BaseField {
         this.confidence = prediction.confidence ? prediction.confidence : 0.0;
         if (prediction.polygon) {
             this.polygon = prediction.polygon;
-            this.bbox = (0, geometry_1.getBboxAsPolygon)(prediction.polygon);
         }
+        this.boundingBox = (0, geometry_1.getBoundingBox)(this.polygon);
     }
     /**
     @param {Field[]} array1 - first Array of Fields

package/src/fields/index.d.ts

@@ -1,3 +1,4 @@
+export { ClassificationField } from "./classification";
 export { TaxField } from "./tax";
 export { PaymentDetails } from "./paymentDetails";
 export { OrientationField } from "./orientation";

package/src/fields/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextField = exports.PositionField = exports.CompanyRegistration = exports.FullText = exports.BaseField = exports.DateField = exports.Amount = exports.Locale = exports.OrientationField = exports.PaymentDetails = exports.TaxField = void 0;
+exports.TextField = exports.PositionField = exports.CompanyRegistration = exports.FullText = exports.BaseField = exports.DateField = exports.Amount = exports.Locale = exports.OrientationField = exports.PaymentDetails = exports.TaxField = exports.ClassificationField = void 0;
+var classification_1 = require("./classification");
+Object.defineProperty(exports, "ClassificationField", { enumerable: true, get: function () { return classification_1.ClassificationField; } });
 var tax_1 = require("./tax");
 Object.defineProperty(exports, "TaxField", { enumerable: true, get: function () { return tax_1.TaxField; } });
 var paymentDetails_1 = require("./paymentDetails");