US US Mail

US US Mail

The Java SDK supports the Mindee V1 US Mail API.

Product Specifications

Specification	Details
Endpoint Name	us_mail
Recommended Version	v3.0
Supports Polling/Webhooks	✔️ Yes
Support Synchronous HTTP Calls	❌ No
Geography	🇺🇸 United States

Quick-Start

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

Sample Code

import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.parsing.common.AsyncPredictResponse;
import com.mindee.product.us.usmail.UsMailV3;
import java.io.File;
import java.io.IOException;

public class SimpleMindeeClient {

  public static void main(String[] args) throws IOException, InterruptedException {
    String apiKey = "my-api-key";
    String filePath = "/path/to/the/file.ext";

    // Init a new client
    MindeeClient mindeeClient = new MindeeClient(apiKey);

    // Load a file from disk
    LocalInputSource inputSource = new LocalInputSource(new File(filePath));

    // Parse the file asynchronously
    AsyncPredictResponse<UsMailV3> response = mindeeClient.enqueueAndParse(
        UsMailV3.class,
        inputSource
    );

    // Print a summary of the response
    System.out.println(response.toString());

    // Print a summary of the predictions
//  System.out.println(response.getDocumentObj().toString());

    // Print the document-level predictions
//    System.out.println(response.getDocumentObj().getInference().getPrediction().toString());

    // Print the page-level predictions
//    response.getDocumentObj().getInference().getPages().forEach(
//        page -> System.out.println(page.toString())
//    );
  }

}

Sample Output (rST)

########
Document
########
:Mindee ID: f9c36f59-977d-4ddc-9f2d-31c294c456ac
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/us_mail v3.0
:Rotation applied: Yes

Prediction
==========
:Sender Name: company zed
:Sender Address:
  :City: Dallas
  :Complete Address: 54321 Elm Street, Dallas, Texas 54321
  :Postal Code: 54321
  :State: TX
  :Street: 54321 Elm Street
:Recipient Names: Jane Doe
:Recipient Addresses:
  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
  | City            | Complete Address                    | Is Address Change | Postal Code | Private Mailbox Number | State | Street                    | Unit            |
  +=================+=====================================+===================+=============+========================+=======+===========================+=================+
  | Detroit         | 1234 Market Street PMB 4321, Det... | False             | 12345       | 4321                   | MI    | 1234 Market Street        |                 |
  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+-----------------+
:Return to Sender: False

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:

• confidence (Double): the confidence score of the field prediction.

• boundingBox (Polygon): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.

• polygon (Polygon): contains the relative vertices coordinates (polygon extends List<Point>) of a polygon containing the field in the image.

• pageId (Integer): the ID of the page, always null when at document-level.

A Point simply refers to a List of Double.

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

StringField

The text field StringField extends BaseField, but also implements:

• value (String): corresponds to the field value.

• rawValue (String): corresponds to the raw value as it appears on the document.

BooleanField

The boolean field BooleanField extends BaseField, but also implements:

• value (Boolean): corresponds to the value of the field.

Specific Fields

Fields which are specific to this product; they are not used in any other product.

Recipient Addresses Field

The addresses of the recipients.

A UsMailV3RecipientAddress implements the following attributes:

• city (String): The city of the recipient's address.

• complete (String): The complete address of the recipient.

• isAddressChange (Boolean): Indicates if the recipient's address is a change of address.

• postalCode (String): The postal code of the recipient's address.

• privateMailboxNumber (String): The private mailbox number of the recipient's address.

• state (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.

• street (String): The street of the recipient's address.

• unit (String): The unit number of the recipient's address. Fields which are specific to this product; they are not used in any other product.

Sender Address Field

The address of the sender.

A UsMailV3SenderAddress implements the following attributes:

• city (String): The city of the sender's address.

• complete (String): The complete address of the sender.

• postalCode (String): The postal code of the sender's address.

• state (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.

• street (String): The street of the sender's address.

Attributes

The following fields are extracted for US Mail V3:

Return to Sender

isReturnToSender: Whether the mailing is marked as return to sender.

System.out.println(
  result.getDocument().getInference().getPrediction().getIsReturnToSender().value
);

Recipient Addresses

recipientAddresses(List<UsMailV3RecipientAddress>): The addresses of the recipients.

for (recipientAddressesElem : result.getDocument().getInference().getPrediction().getRecipientAddresses())
{
    System.out.println(recipientAddressesElem.value);
}

Recipient Names

recipientNames: The names of the recipients.

for (recipientNamesElem : result.getDocument().getInference().getPrediction().getRecipientNames())
{
    System.out.println(recipientNamesElem.value);
}

Sender Address

senderAddress(UsMailV3SenderAddress): The address of the sender.

System.out.println(
  result.getDocument().getInference().getPrediction().getSenderAddress().value
);

Sender Name

senderName: The name of the sender.

System.out.println(
  result.getDocument().getInference().getPrediction().getSenderName().value
);