Documentation
Log inGet started

Proof of Address OCR Python

Suggest Edits

The Python OCR SDK supports the Proof of Address API.

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

Quick-Start

from mindee import Client, PredictResponse, product

# Init a new client
mindee_client = Client(api_key="my-api-key")

# Load a file from disk
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.ProofOfAddressV1, input_doc)

# Print a summary of the API result
print(result.document)

# Print the document-level summary
# print(result.document.inference.prediction)

Output (RST):

########
Document
########
:Mindee ID: 5d2361e9-405e-4fc1-8531-f92a3aef0c38
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/proof_of_address v1.1
:Rotation applied: Yes

Prediction
==========
:Locale: en; en; USD;
:Issuer Name: PPL ELECTRIC UTILITIES
:Issuer Company Registrations:
:Issuer Address: 2 NORTH 9TH STREET CPC-GENN1 ALLENTOWN.PA 18101-1175
:Recipient Name:
:Recipient Company Registrations:
:Recipient Address: 123 MAIN ST ANYTOWN,PA 18062
:Dates: 2011-07-27
        2011-07-06
        2011-08-03
        2011-07-27
        2011-06-01
        2011-07-01
        2010-07-01
        2010-08-01
        2011-07-01
        2009-08-01
        2010-07-01
        2011-07-27
:Date of Issue: 2011-07-27

Page Predictions
================

Page 0
------
:Locale: en; en; USD;
:Issuer Name: PPL ELECTRIC UTILITIES
:Issuer Company Registrations:
:Issuer Address: 2 NORTH 9TH STREET CPC-GENN1 ALLENTOWN.PA 18101-1175
:Recipient Name:
:Recipient Company Registrations:
:Recipient Address: 123 MAIN ST ANYTOWN,PA 18062
:Dates: 2011-07-27
        2011-07-06
        2011-08-03
        2011-07-27
        2011-06-01
        2011-07-01
        2010-07-01
        2010-08-01
        2011-07-01
        2009-08-01
        2010-07-01
        2011-07-27
:Date of Issue: 2011-07-27

Field Types

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class.
A typical BaseField object will have the following attributes:

  • value (Union[float, str]): corresponds to the field value. Can be None if no value was extracted.
  • confidence (float): the confidence score of the field prediction.
  • bounding_box ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
  • polygon (List[Point]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.
  • page_id (int): the ID of the page, always None when at document-level.
  • reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

Note: A Point simply refers to a List of two numbers ([float, float]).

Aside from the previous attributes, all basic fields have access to a custom __str__ method that can be used to print their value as a string.

CompanyRegistrationField

Aside from the basic BaseField attributes, the company registration field CompanyRegistrationField also implements the following:

  • type (str): the type of company.

DateField

Aside from the basic BaseField attributes, the date field DateField also implements the following:

  • date_object (Date): an accessible representation of the value as a python object. Can be None.

LocaleField

The locale field LocaleField only implements the value, confidence and page_id base BaseField attributes, but it comes with its own:

  • language (str): ISO 639-1 language code (e.g.: en for English). Can be None.
  • country (str): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: GRB or GB for "Great Britain"). Can be None.
  • currency (str): ISO 4217 code for currencies (e.g.: USD for "US Dollars"). Can be None.

StringField

The text field StringField only has one constraint: its value is an Optional[str].

Attributes

The following fields are extracted for Proof of Address V1:

Date of Issue

date (DateField): The date the document was issued.

print(result.document.inference.prediction.date.value)

Dates

dates (List[DateField]): List of dates found on the document.

for dates_elem in result.document.inference.prediction.dates:
    print(dates_elem.value)

Issuer Address

issuer_address (StringField): The address of the document's issuer.

print(result.document.inference.prediction.issuer_address.value)

Issuer Company Registrations

issuer_company_registration (List[CompanyRegistrationField]): List of company registrations found for the issuer.

for issuer_company_registration_elem in result.document.inference.prediction.issuer_company_registration:
    print(issuer_company_registration_elem.value)

Issuer Name

issuer_name (StringField): The name of the person or company issuing the document.

print(result.document.inference.prediction.issuer_name.value)

Locale

locale (LocaleField): The locale detected on the document.

print(result.document.inference.prediction.locale.value)

Recipient Address

recipient_address (StringField): The address of the recipient.

print(result.document.inference.prediction.recipient_address.value)

Recipient Company Registrations

recipient_company_registration (List[CompanyRegistrationField]): List of company registrations found for the recipient.

for recipient_company_registration_elem in result.document.inference.prediction.recipient_company_registration:
    print(recipient_company_registration_elem.value)

Recipient Name

recipient_name (StringField): The name of the person or company receiving the document.

print(result.document.inference.prediction.recipient_name.value)

Questions?

Join our Slack

Updated 5 months ago