Receipt OCR Ruby

The Ruby OCR SDK supports the receipt API for extracting data from receipts.

Using this sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.

sample receipt

Quick Start

require 'mindee'

# Init a new client, specifying an API key
mindee_client = Mindee::Client.new(api_key: 'my-api-key')

# Send the file
result = mindee_client.doc_from_path('/path/to/the/file.ext').parse(Mindee::Prediction::ReceiptV4)

# Print a summary of the document prediction in RST format
puts result.inference.prediction

Output:

:Locale: en-US; en; US; USD;
:Date: 2014-07-07
:Category: food
:Subcategory: restaurant
:Document type: EXPENSE RECEIPT
:Time: 20:20
:Supplier name: LOGANS
:Taxes: 3.34 TAX
:Total net: 40.48
:Total taxes: 3.34
:Tip: 10.00
:Total amount: 53.8

Fields

Each prediction object contains a set of different fields.
Each Field object contains at a minimum the following attributes:

value (String or Float depending on the field type): corresponds to the field value. Can be nil if no value was extracted.
confidence (Float): the confidence score of the field prediction.
bounding_box (Array< Array< Float > >): contains exactly 4 relative vertices coordinates (points) of a right rectangle containing the field in the document.
polygon (Array< Array< Float > >): contains the relative vertices coordinates (points) of a polygon containing the field in the image.
reconstructed (Boolean): True if the field was reconstructed or computed using other fields.

Attributes

Depending on the field type specified, additional attributes can be extracted in the Receipt object.

Using the above sample, the following are the basic fields that can be extracted:

Orientation
Category
Date
Locale
Supplier Information
Taxes
Time
Totals

Date

Date fields:

contain the date_object attribute, which is a standard Ruby date object
have a value attribute which is the ISO 8601 representation of the date.

The following date fields are available:

date: Date the receipt was issued

puts result.inference.prediction.date.value

Locale

locale (Locale): Locale information.

locale.value (String): Locale with country and language codes.

puts result.inference.prediction.locale

locale.language (String): Language code in ISO 639-1 format as seen on the document.

puts result.inference.prediction.locale.language

locale.currency (String): Currency code in ISO 4217 format as seen on the document.

puts result.inference.prediction.locale.currency

locale.country (String): Country code in ISO 3166-1 alpha-2 format as seen on the document.

puts result.inference.prediction.locale.country

Supplier Information

supplier_name (Field): Supplier name as written in the receipt.

puts result.inference.prediction.supplier_name.value

Taxes

taxes (Array< TaxField >): Contains tax fields as seen on the receipt.

value (Float): The tax amount.

# Show the amount of the first tax
puts result.inference.prediction.taxes[0].value

code (String): The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..).

# Show the code of the first tax
puts result.inference.prediction.taxes[0].code

rate (Float): The tax rate.

# Show the rate of the first tax
puts result.inference.prediction.taxes[0].rate

Time

time: Time of purchase as seen on the receipt
- value (string): Time of purchase with 24 hours formatting (hh:mm).

puts result.inference.prediction.time.value

Totals

total_amount (Field): Total amount including taxes

puts result.inference.prediction.total_amount.value

total_net (Field): Total amount paid excluding taxes

puts result.inference.prediction.total_net.value

total_tax (Field): Total tax value from tax lines

puts result.inference.prediction.total_tax.value

Questions?

Join our Slack