mindee 3.5.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,6 +1,6 @@
 import { InputSource } from "../inputs";
-import { Response, Endpoint, predictResponse } from "../api";
-import { Document, FinancialDocumentV1, CustomV1, DocumentSig } from "./index";
+import { Response, Endpoint, EndpointResponse, AsyncPredictResponse } from "../api";
+import { Document, FinancialDocumentV0, CustomV1, DocumentSig } from "./index";
 import { PageOptions } from "../inputs";
 interface CustomDocConstructor {
     endpointName: string;
@@ -13,22 +13,30 @@ 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> {
     constructor({ endpointName, accountName, version, apiKey, }: CustomDocConstructor);
 }
-export declare class FinancialDocV1Config extends DocumentConfig<FinancialDocumentV1> {
+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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FinancialDocV1Config = exports.CustomDocConfig = exports.DocumentConfig = void 0;
+exports.FinancialDocV0Config = exports.CustomDocConfig = exports.DocumentConfig = void 0;
 const api_1 = require("../api");
 const index_1 = require("./index");
 const handler_1 = require("../errors/handler");
@@ -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`);
             }
         });
@@ -65,13 +96,13 @@ class CustomDocConfig extends DocumentConfig {
     }
 }
 exports.CustomDocConfig = CustomDocConfig;
-class FinancialDocV1Config extends DocumentConfig {
+class FinancialDocV0Config extends DocumentConfig {
     constructor(apiKey) {
         const endpoints = [
             new api_1.StandardEndpoint("invoices", "3", apiKey),
             new api_1.StandardEndpoint("expense_receipts", "3", apiKey),
         ];
-        super(index_1.FinancialDocumentV1, endpoints);
+        super(index_1.FinancialDocumentV0, endpoints);
     }
     async predictRequest(inputDoc, includeWords, cropping) {
         let endpoint;
@@ -84,4 +115,4 @@ class FinancialDocV1Config extends DocumentConfig {
         return await endpoint.predictReqPost(inputDoc, includeWords, cropping);
     }
 }
-exports.FinancialDocV1Config = FinancialDocV1Config;
+exports.FinancialDocV0Config = FinancialDocV0Config;

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/financialDocument/financialDocumentV0.d.ts

@@ -0,0 +1,28 @@
+import { Document, DocumentConstructorProps } from "../document";
+import { TaxField, TextField, Amount, Locale, DateField as Date, CompanyRegistration } from "../../fields";
+/**
+ * @deprecated You should use FinancialDocumentV1 instead.
+ */
+export declare class FinancialDocumentV0 extends Document {
+    #private;
+    pageId: number | undefined;
+    locale: Locale;
+    totalIncl: Amount;
+    date: Date;
+    dueDate: Date;
+    category: TextField;
+    time: TextField;
+    taxes: TaxField[];
+    totalTax: Amount;
+    totalExcl: Amount;
+    supplier: TextField;
+    supplierAddress: TextField;
+    invoiceNumber: TextField;
+    companyRegistration: CompanyRegistration[];
+    customerName: TextField;
+    customerAddress: TextField;
+    paymentDetails: TextField[];
+    customerCompanyRegistration: CompanyRegistration[];
+    constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
+    toString(): string;
+}

package/src/documents/financialDocument/financialDocumentV0.js

@@ -0,0 +1,140 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _FinancialDocumentV0_instances, _FinancialDocumentV0_initFromApiPrediction, _FinancialDocumentV0_checklist, _FinancialDocumentV0_taxesMatchTotalIncl;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FinancialDocumentV0 = void 0;
+const document_1 = require("../document");
+const invoiceV3_1 = require("../invoice/invoiceV3");
+const receiptV3_1 = require("../receipt/receiptV3");
+const fields_1 = require("../../fields");
+/**
+ * @deprecated You should use FinancialDocumentV1 instead.
+ */
+class FinancialDocumentV0 extends document_1.Document {
+    constructor({ prediction, orientation = undefined, extras = undefined, inputSource = undefined, fullText = undefined, pageId = undefined, }) {
+        super({
+            inputSource: inputSource,
+            pageId: pageId,
+            orientation: orientation,
+            fullText: fullText,
+            extras: extras,
+        });
+        _FinancialDocumentV0_instances.add(this);
+        this.taxes = [];
+        this.companyRegistration = [];
+        this.paymentDetails = [];
+        this.customerCompanyRegistration = [];
+        __classPrivateFieldGet(this, _FinancialDocumentV0_instances, "m", _FinancialDocumentV0_initFromApiPrediction).call(this, prediction, inputSource, pageId, orientation, extras);
+        __classPrivateFieldGet(this, _FinancialDocumentV0_instances, "m", _FinancialDocumentV0_checklist).call(this);
+    }
+    toString() {
+        const outStr = `-----Financial document-----
+Filename: ${this.filename}
+Total amount: ${this.totalIncl.value}
+Date: ${this.date.value}
+Supplier: ${this.supplier.value}
+Total taxes: ${this.totalTax.value}
+----------------------
+`;
+        return FinancialDocumentV0.cleanOutString(outStr);
+    }
+}
+exports.FinancialDocumentV0 = FinancialDocumentV0;
+_FinancialDocumentV0_instances = new WeakSet(), _FinancialDocumentV0_initFromApiPrediction = function _FinancialDocumentV0_initFromApiPrediction(prediction, inputFile, pageNumber, orientation, extras) {
+    if (Object.keys(prediction).includes("invoice_number")) {
+        const invoice = new invoiceV3_1.InvoiceV3({
+            prediction: prediction,
+            inputSource: inputFile,
+            pageId: pageNumber,
+            orientation: orientation,
+            extras: extras,
+        });
+        this.locale = invoice.locale;
+        this.totalIncl = invoice.totalIncl;
+        this.totalExcl = invoice.totalExcl;
+        this.date = invoice.date;
+        this.invoiceNumber = invoice.invoiceNumber;
+        this.dueDate = invoice.dueDate;
+        this.taxes = invoice.taxes;
+        this.supplier = invoice.supplier;
+        this.supplierAddress = invoice.supplierAddress;
+        this.paymentDetails = invoice.paymentDetails;
+        this.companyRegistration = invoice.customerCompanyRegistration;
+        this.orientation = invoice.orientation;
+        this.totalTax = invoice.totalTax;
+        this.time = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.customerName = invoice.customerName;
+        this.customerAddress = invoice.customerAddress;
+        this.customerCompanyRegistration = invoice.customerCompanyRegistration;
+    }
+    else {
+        const receipt = new receiptV3_1.ReceiptV3({
+            prediction: prediction,
+            inputSource: inputFile,
+            pageId: pageNumber,
+            orientation: orientation,
+            extras: extras,
+        });
+        this.orientation = receipt.orientation;
+        this.date = receipt.date;
+        this.dueDate = receipt.date;
+        this.taxes = receipt.taxes;
+        this.locale = receipt.locale;
+        this.totalIncl = receipt.totalIncl;
+        this.totalExcl = receipt.totalExcl;
+        this.supplier = receipt.merchantName;
+        this.supplierAddress = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.time = receipt.time;
+        this.totalTax = receipt.totalTax;
+        this.invoiceNumber = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.customerName = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+        this.customerAddress = new fields_1.TextField({
+            prediction: { value: undefined, confidence: 0.0 },
+        });
+    }
+}, _FinancialDocumentV0_checklist = function _FinancialDocumentV0_checklist() {
+    this.checklist = {
+        taxesMatchTotalIncl: __classPrivateFieldGet(this, _FinancialDocumentV0_instances, "m", _FinancialDocumentV0_taxesMatchTotalIncl).call(this),
+    };
+}, _FinancialDocumentV0_taxesMatchTotalIncl = function _FinancialDocumentV0_taxesMatchTotalIncl() {
+    // Check taxes and total include exist
+    if (this.taxes.length === 0 || this.totalIncl.value === undefined)
+        return false;
+    // Reconstruct totalIncl from taxes
+    let totalVat = 0;
+    let reconstructedTotal = 0;
+    this.taxes.forEach((tax) => {
+        if (tax.value === undefined || !tax.rate)
+            return false;
+        totalVat += tax.value;
+        reconstructedTotal += tax.value + (100 * tax.value) / tax.rate;
+    });
+    // Sanity check
+    if (totalVat <= 0)
+        return false;
+    // Crate epsilon
+    const eps = 1 / (100 * totalVat);
+    if (this.totalIncl.value * (1 - eps) - 0.02 <= reconstructedTotal &&
+        reconstructedTotal <= this.totalIncl.value * (1 + eps) + 0.02) {
+        this.taxes = this.taxes.map((tax) => ({
+            ...tax,
+            confidence: 1.0,
+        }));
+        this.totalTax.confidence = 1.0;
+        this.totalIncl.confidence = 1.0;
+        return true;
+    }
+    return false;
+};

package/src/documents/financialDocument/financialDocumentV1.d.ts

@@ -1,25 +1,54 @@
 import { Document, DocumentConstructorProps } from "../document";
-import { TaxField, TextField, Amount, Locale, DateField as Date, CompanyRegistration } from "../../fields";
+import { TaxField, PaymentDetails, Locale, Amount, TextField, DateField, CompanyRegistration, BaseField } from "../../fields";
+import { InvoiceLineItem } from "../invoice/invoiceLineItem";
+/**
+ * Financial Document.
+ */
 export declare class FinancialDocumentV1 extends Document {
-    #private;
-    pageId: number | undefined;
+    /** Locale information. */
     locale: Locale;
-    totalIncl: Amount;
-    date: Date;
-    dueDate: Date;
-    category: TextField;
-    time: TextField;
-    taxes: TaxField[];
-    totalTax: Amount;
-    totalExcl: Amount;
-    supplier: TextField;
+    /** The nature of the document. */
+    documentType: BaseField;
+    /** List of Reference numbers including PO number. */
+    referenceNumbers: TextField[];
+    /** The creation date of the invoice or the purchase date. */
+    date: DateField;
+    /** The due date of the invoice. */
+    dueDate: DateField;
+    /** The supplier name. */
+    supplierName: TextField;
+    /** The supplier address. */
     supplierAddress: TextField;
+    /** The payment information. */
+    supplierPaymentDetails: PaymentDetails[];
+    /** The supplier company registration information. */
+    supplierCompanyRegistrations: CompanyRegistration[];
+    /** The invoice number. */
     invoiceNumber: TextField;
-    companyRegistration: CompanyRegistration[];
+    /** The name of the customer. */
     customerName: TextField;
+    /** The address of the customer. */
     customerAddress: TextField;
-    paymentDetails: TextField[];
-    customerCompanyRegistration: CompanyRegistration[];
+    /** The company registration information for the customer. */
+    customerCompanyRegistrations: CompanyRegistration[];
+    /** The list of the taxes. */
+    taxes: TaxField[];
+    /** Line items details. */
+    lineItems: InvoiceLineItem[];
+    /** The receipt category among predefined classes. */
+    category: TextField;
+    /** The receipt sub-category among predefined classes. */
+    subCategory: TextField;
+    /** Time as seen on the receipt in HH:MM format. */
+    time: TextField;
+    /** Total amount of tip and gratuity. */
+    tip: Amount;
+    /** total spent including taxes, discounts, fees, tips, and gratuity. */
+    totalAmount: Amount;
+    /** Total amount of the purchase excluding taxes. */
+    totalNet: Amount;
+    /** Total tax amount of the purchase. */
+    totalTax: Amount;
     constructor({ prediction, orientation, extras, inputSource, fullText, pageId, }: DocumentConstructorProps);
     toString(): string;
 }