What is an Email Field

The Email field data type enables users to extract emails from their documents with the API Builder. This is done by selecting the Email field when creating and defining your data model.

Set Up an Email Address Field

After you've set up your custom API

  • Go to the define your model page.
  • Set up the email field by choosing Email from the right side menu.
    email model fieldemail model field
  • Enter the Field Name and API Response Key according to the data you want to extract.
    email field name and API response filledemail field name and API response filled

📘

The API Response Key is automatically filled for you but you can change that to something most suitable for you according to your needs.

Additional Parameter

If you have additional context about this specific field and how the information is usually displayed in your documents, you can specify it during the field set up by enabling the checkbox that suits your demand.
email field additional parametersemail field additional parameters

  • Can be handwritten: by checking this, the API will be able to detect handwritten words more accurately. This doesn’t stop the API from detecting non-handwritten words.

Training and Predictions

By specifying the data type as Email, you will enable the API to only consider words and series of words that can be interpreted as an email address as eligible candidates.

This means that, the API will not extract any information in your document that cannot be interpreted as an email address for this specific field.

 

Questions?
Slack Logo IconSlack Logo Icon  Join our Slack


Did this page help you?