Skip to content

The Documents tab

Below you will find the peculiarities of the Documents tab of the project dashboard of extraction projects.
The characteristics of the tab that are common to all project types are described in the article dedicated to the topic.

Detail view's central panel

In the default visualization of the detail view, the third bar from the top in the central panel shows buttons displaying:

  • The number of extractions.
  • The number of annotations.
  • The number of true positives.
  • The number of false positives.
  • The number of false negatives.

The buttons also act as toggle switches: to toggle the highlight of all the extractions, annotations, true positives, etc., select the corresponding button.
You can select one or more of the first two buttons or one or more of the second three, but the two groups are mutually exclusive: if you select a button of one group, any buttons selected in the other group are deselected.

The Classes tab

In list view

In list view, the Classes tab is in in the left panel and lists all project classes.

Classes that have not been annotated or—if an experiment is selected—extracted by the experiment model, are grayed out.

The two numbers next to each class name are, respectively, the number of distinct values that have been extracted by the model experiment and the number of distinct values that have been annotated.

  • To filter the list of classes, type the name of a class or part of it in the Filter classes box and press Enter. The match is case insensitive. Select the X icon inside the box to cancel the filter.
  • To switch to the Resources tab of the project dashboard and show the detail of a class, hover over the class and select Show in resources .
  • To show more information about a class, hover over it and select Show info .
  • To switch to the context view, hover over the class and select Context view .
  • To expand and collapse your groups, select Expand all groups / Collapse all groups .
  • Select the expanding arrow and the collapsing arrow to expand and collapse a specific group.

In some cases, some classes—grouped or ungrouped—may have neither annotations nor extractions.

As mentioned above, these classes are grayed out. When there are groups made entirely of empty classes, the groups are collapsed by default. If a group has at least a single class with annotations, the group is expanded by default.

  • To hide these classes, select Hide empty classes and groups . All empty classes—and groups entirely made of empty classes—will disappear.

    Note

    If a group contains at least a class with annotations, the group itself will not be hidden but only its empty classes.

  • To show empty classes again, select Show empty classes and groups .

To expand the lists of extracted and annotated values for a class, select it or select the chevron icon to the right of the class. To collapse the lists, select Go back .

When you expand a class, you see two lists: Extractions and Annotations. If an experiment is selected, under Extractions you'll find the distinct values that were detected by the experiment model.
Under Annotations are listed the distinct values that were annotated as expected results.

The numbers beside the Extractions and Annotations headings are, respectively, the number of distinct values detected by the experiment model and the number of distinct values that have been annotated in the library.

The number beside each value under Extractions is the number of documents in the current list from which that value was extracted by the experiment model. Similarly, the number beside each value under Annotations is the number of documents in which that value was annotated.

Note

In case of a project with no annotations and no experiments, no information is displayed in the tab.

  • To filter the lists, type a value or the initial part of it in the Filter list box and press Enter. The match is case sensitive. Select the X icon inside the box to cancel the filter.
  • To change the sort order, select the desired option from the drop-down menu at the top right of the list.
  • Double-click an item to insert it in the search bar as criteria for document search.

If a list appears truncated, select Open beside its name to give the list maximum space. Select Close to revert to previous visualization.

In detail view

The Resources tab on the right of the detail view shows the classes and the related annotations and extractions.

In case of a new project with no annotations and experiments, no details are available. In case of annotations and more experiments, details about extracted classes are available for the latest experiment.

Select the drop-down menu—set on All classes by default— to expand a class. When you expand a class, you see two lists: Extractions and Annotations. The information and the actions that can be performed are the same described about the list view when a class is expanded.

To filter the lists based on a specific value, type a value or the initial part of it in the Filter list box and press Enter. The match is case sensitive. Select the X icon inside the box to cancel the filter.

The Resources tab has some other useful tools that are used to annotate.

If there are extraction aggregations, two more sub-tabs are added:

  • Classes
  • Groups

The Classes sub-tab shows the default view with all classes including those belonging to groups.

The Groups sub-tab shows all project groups with their classes.

Select the drop-down menu—set on All groups by default— to filter the group list.

Annotation controls

In extraction projects, both the list view and detail view of the Documents tab have numerous controls for annotating classes and sections.

Segments

Segments are block of text identified by specific rules in Studio projects.
Segments are part of the output of experiments based on CPK models imported from Studio. When detected, they are listed under the Tokens tab, which is inside the left panel in list view and inside the right panel in detail view.

Sections

In the detail view and its variants you can toggle and untoggle document sections.

To toggle sections in your document, select Toggle sections on the toolbar beside the document name. The only section you see in the document before annotating the others is the one marked as standard section in the Resources tab.

To untoggle sections, select Toggle sections .

See the dedicated page to learn how to annotate sections.

Extraction aggregations

The aggregation of extraction results is available in case of:

  • An extraction project based on an imported CPK.
  • A group with at least two extracted classes in a document.

This feature is available only in immersive view and aggregates extraction experiment results.

To toggle the aggregation while in immersive view, select Toggle aggregations on the toolbar. To untoggle the aggregation, select Toggle aggregations .

This is what you see when the button above is not selected.

This is what you see when the button above is selected.

As you can see, only true and false positives are visible when the aggregation is activated.

Use the Filter list bar to look for classes.

Note

The toolbar beside the Filter list bar is already described in the annotation section.