Skip to content

Annotate target extractions

Annotating the target extractions for a test document means indicating the expected extraction results for that document.

There are two areas of the Studio IDE where you can annotate target extractions:

  • The editor
  • The Extraction tool window

It is then possible to manage—modify or delete—the annotations using the Annotation tool window.

Set the list of fields to choose from

In the editor you use the context menu to annotate extractions.
The context menu allows you to directly choose the field from a list or have a dialog in which you can specify any field.

Determine which fields appear in the list by checking them in the Templates panel of the Classes tool window.

Extractions that have already been annotated are displayed in the list, but with gray ink, and cannot be selected.

To these categories, Studio adds other suggestions based on the results of analysis and user activities.

Annotate in the editor

In the editor you can annotate expected extraction results for the current test document.

  1. Select the portion of text that you expect to be extracted then right-click and choose Annotate Extraction > "XXXX" as YYYY.ZZZZ to annotate an extraction of value XXXX for the ZZZZ field of YYYY template.

Or:

  1. Select the portion of text that you expect to be extracted then right-click and choose Annotate Extraction > Annotate...
  2. Choose the template from the Template drop-down list.
  3. Choose the field from the Field drop-down list.
  4. If you want, you can change the expected extraction value by changing the Value field.
  5. Select OK.

Annotate in the Extraction tool window

Annotating in the Extraction tool window is useful because you can easily indicate if the extraction results you already obtained for a test document are correct or not.

First select Toggle Annotations on the left panel toolbar to display the annotation toolbar, then use the annotation toolbar controls at the bottom of the left panel.

  1. Select the extraction you want to annotate from the list of results.
  2. If you want, in the Annotate: list you can select another template-field couple and a different extraction value in the field alongside.
  3. In the annotation toolbar choose Annotate.

Info

A single extraction can imply multiple hits. By annotating an extraction result, therefore, you create as many annotations as there are hits, one annotation for each hit.