Skip to content

Latest commit

 

History

History
68 lines (52 loc) · 2.67 KB

File metadata and controls

68 lines (52 loc) · 2.67 KB

Receipt Intelligence

This context describes purchase evidence and the normalized commercial facts extracted from it for price analysis.

Language

Digital Receipt: A merchant-issued proof of purchase accessible through a URL, containing transaction metadata and purchased line items. Avoid: Digital recipe, recipe

Receipt Image: A user-supplied photograph or scan of a completed purchase receipt, containing visual purchase evidence rather than a merchant-hosted URL. Avoid: Digital Receipt, receipt upload

Verified Receipt Image: A Receipt Image whose readable visual evidence supports extraction of its transaction, total, and line-item facts. Avoid: Plausible receipt photo, assumed receipt

Receipt Image Total: The final paid amount and currency read from a Receipt Image when the image supports the total but not a complete set of purchasable line items. Avoid: Reconciled Receipt, complete cart

Verified Digital Receipt: A Digital Receipt whose accessible evidence establishes that it is merchant-issued purchase evidence and supports extraction of its transaction, total, and line-item facts. Avoid: Plausible receipt page, assumed receipt

Normalized Receipt: A platform-independent, schema-validated representation of a Digital Receipt or Verified Receipt Image's merchant, transaction totals, and ordered line items. Avoid: Model-generated CSV, unvalidated model output

Reconciled Receipt: A Normalized Receipt whose line totals and applied adjustments match its stated receipt total within the configured currency tolerance. Avoid: Plausible receipt, unchecked extraction

Receipt Document: The versioned, API-ready JSON representation of a Reconciled Receipt, written by the POC only beneath its dedicated git-ignored local output directory and intended to become a future API response body. Avoid: CSV export, model response

Receipt Image Total Document: An API response that represents a Receipt Image Total and explicitly warns that it does not contain a complete cart. Avoid: Receipt Document, normalized receipt

Receipt Evidence: The sanitized merchant, transaction, product, and total information derived from a Digital Receipt and permitted to leave the local capture boundary. Avoid: Raw HTML, full page source

API Client Regeneration

The API client is auto-generated using openapi-python-client. It lives in src/supermarket-api-client. If the API specification (openapi/supermarkets_openapi.json) changes, you can regenerate the entire package from the root of the project using:

uvx openapi-python-client generate --path openapi/supermarkets_openapi.json --meta uv --output-path src/supermarket-api-client --overwrite