> For the complete documentation index, see [llms.txt](https://docs.mindee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mindee.com/v1/integration/ruby-sdk/localized-products/ruby-us-us-mail-ocr.md). # US US Mail The Ruby Client Library supports the [US Mail API](https://platform.mindee.com/mindee/us_mail). ## 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](https://github.com/mindee/client-lib-test-data/blob/main/v1/products/us_mail/default_sample.jpg), we are going to illustrate how to extract the data that we want using the SDK.
US Mail Sample
### Sample Code ```rb # # Install the Ruby client library by running: # gem install mindee # require 'mindee' # Init a new client mindee_client = Mindee::Client.new(api_key: 'my-api-key') # Load a file from disk input_source = mindee_client.source_from_path('/path/to/the/file.ext') # Parse the file result = mindee_client.parse( input_source, Mindee::Product::US::UsMail::UsMailV3 ) # Print a full summary of the parsed data in RST format puts result.document # Print the document-level parsed data # puts result.document.inference.prediction ``` ### Sample Output (rST) ```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 ``` ## Standard Fields These fields are generic and used in several products. ### Basic Field Each prediction object contains a set of fields that inherit from the generic `Field` class. A typical `Field` object will have the following attributes: * **value** (`String`, `Float`, `Integer`, `bool`): corresponds to the field value. Can be `nil` if no value was extracted. * **confidence** (Float, nil): the confidence score of the field prediction. * **bounding\_box** (`Mindee::Geometry::Quadrilateral`, `nil`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document. * **polygon** (`Mindee::Geometry::Polygon`, `nil`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image. * **page\_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level. * **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it). Aside from the previous attributes, all basic fields have access to a `to_s` method that can be used to print their value as a string. ### String Field The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`). ## Specific Fields 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. * `postal_code` (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. 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. * `is_address_change` (bool): Indicates if the recipient's address is a change of address. * `postal_code` (String): The postal code of the recipient's address. * `private_mailbox_number` (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. ## Attributes The following fields are extracted for US Mail V3: ### Return to Sender **is\_return\_to\_sender** ([BooleanField](#boolean-field)): Whether the mailing is marked as return to sender. ```rb puts result.document.inference.prediction.is_return_to_sender.value ``` ### Recipient Addresses **recipient\_addresses** (Array<[UsMailV3RecipientAddress](#recipient-addresses-field)>): The addresses of the recipients. ```rb result.document.inference.prediction.recipient_addresses do |recipient_addresses_elem| puts recipient_addresses_elem.value end ``` ### Recipient Names **recipient\_names** (Array<[StringField](#string-field)>): The names of the recipients. ```rb result.document.inference.prediction.recipient_names do |recipient_names_elem| puts recipient_names_elem.value end ``` ### Sender Address **sender\_address** ([UsMailV3SenderAddress](#sender-address-field)): The address of the sender. ```rb puts result.document.inference.prediction.sender_address.value ``` ### Sender Name **sender\_name** ([StringField](#string-field)): The name of the sender. ```rb puts result.document.inference.prediction.sender_name.value ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.mindee.com/v1/integration/ruby-sdk/localized-products/ruby-us-us-mail-ocr.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.