receipt_recognition library
Public API for the receipt_recognition package.
Note: Files under lib/src/** must NOT import this file.
They should import specific internal files instead, e.g.
package:receipt_recognition/src/....
Classes
- CalculatedTotal
- Total calculated from receipt positions rather than directly recognized.
- Confidence
- Weighted confidence score used to evaluate recognition reliability.
- Optimizer
- Interface for receipt optimization components.
- ReceiptLogger
- Centralized logger for receipt recognition.
- ReceiptOptimizer
- Default implementation of receipt optimizer that uses confidence scoring and grouping.
- ReceiptOptions
- Strongly-typed, user-configurable options for the parser with merge helpers.
- ReceiptRecognizer
- Main orchestrator for recognizing receipts from images.
- ReceiptRuntime
- Process-wide runtime that exposes the active options and tuning knobs.
- ReceiptTextProcessor
- Parses OCR text into structured receipt data on a background isolate.
- ReceiptTuning
- Numeric/string tuning knobs for parsing/optimization.
- ReceiptValidationResult
- Validation result for a recognized receipt.
- RecognizedAmount
- Monetary amount recognized from the receipt.
- RecognizedBounds
- Outer bounds and skew angle of the receipt.
- RecognizedCompany
- Company name recognized from a receipt.
-
RecognizedEntity<
T> - Base class for entities recognized from a receipt through OCR.
- RecognizedGroup
- Groups similar receipt positions together to improve recognition accuracy.
- RecognizedPosition
- Line item position on a receipt (product + price).
- RecognizedPrice
- Price recognized from a receipt, with numeric value and confidence score.
- RecognizedProduct
- Product name recognized from a receipt.
- RecognizedPurchaseDate
- Purchase date recognized from a receipt.
- RecognizedReceipt
- Complete recognized receipt (positions, totals, store, date, bounds, entities).
- RecognizedScanProgress
- Progress snapshot of an ongoing receipt scan.
- RecognizedStore
- Store name recognized from a receipt.
- RecognizedTotal
- Total recognized from the receipt.
- RecognizedTotalLabel
- Label for the total (e.g., "Total", "Summe").
- RecognizedUnknown
- Unidentified text line from the receipt.
-
Valuable<
T> - Base class for entities that have a value which can be formatted.
Enums
- MergePolicy
- How user config should interact with built-in defaults.
- Operation
- Operation performed on a recognized position during processing.
- ReceiptCompleteness
- Completeness level of a recognized receipt.
Constants
-
kReceiptDefaultOptions
→ const Map<
String, dynamic> - Built-in default options as a JSON-like map (can be persisted/overridden). Canonicals map to themselves by default. Adjust values if you want alias→canonical.