› DocAI solutions › Configure fields › Field extraction for configurable document types › Suggested fields › Extract a suggested field

Extract a suggested field

Use the procedure in this topic to add a suggested field to a configurable document type. You cannot add a suggested field to a predefined document type or a test document.

Before you begin

Before you extract a suggested field, verify that the following steps are complete.

Procedure

  1. If the field extraction screen is not already displayed, select Fields.

    The first document type in your solution is displayed in two parts. The document types and their fields are on the left, and the document image for the currently selected document is on the right. Select the required document.

  2. Select the required document.

    Already trained fields are highlighted in green. Available pairs are highlighted in yellow and blue, with yellow for the key and blue for its corresponding value. Moving the pointer over a key indicates its value, and vice versa. If the values are far apart, a line indicates the link when the pointer is moved over the image.

  3. Optional. Select Pause extraction to continue adding new fields.

    When extraction is not paused, each time you add a new field, all fields are sent for extraction. This can be distracting and time-consuming, so pausing extraction for a document until you have added all fields can help.

  4. Select a suggested field pair to extract.

    The Add suggested field window is displayed for the selected field.

    The Selected text field is populated with the value. The Name field is populated with the key from the selected field. Edit these values as required.

  5. Configure the following settings.

    Selected text

    This read-only field is pre-populated with the recognition text of the selected field.

    Viewing the recognition values of a field is helpful when configuring formatters, character lengths, and allowed or restricted characters.

    New or existing

    This setting is read-only and set to New field for the first field in a document.

    Select one of the following values. (Default: New)

    New field:
    Create a unique field.
    Existing field:

    All settings are removed and a list of existing fields is displayed for selection.

    Improve field extraction using existing fields improves the extraction results for this field by providing multiple samples of the same field on different documents.

    Name

    Enter a distinctive and useful name that is displayed if any user actions are configured.

    When a field is created:

    • Any lowercase characters in a field are converted to uppercase.

    • Any non-alphabetic characters or spaces are converted to underscores.

    For example, "Invoice number@1a" is converted to "INVOICE_NUMBER__A." This is the name referenced for scripting rather than the name displayed to users.

    Keywords

    This field is pre-populated with the keyword from the selected suggested field.

    Edit the existing keywords and add additional keywords as needed, separating each keyword with a semicolon.

  6. Select Save.

    The Add suggested field window closes and your field is added to the Fields tab for selected document type.

    Training is performed automatically for the selected document type. If the training circle is orange, add this field to additional documents.

  7. Optional. Add additional suggested fields to the current document.
  8. Once you are done adding suggested fields for the current document, select Resume extraction so that you can ensure the fields you added behave as expected.
  9. Repeat steps 2 to 8 to add suggested fields to other document types.

Next steps

More info