Overview

Description

The Element step is used to annotate elements (textual and images) in the document and apply specific effects on them.

The Element step is the most general of all annotation steps and is recommended to be used only by advanced users. For most cases, one of the element step’s pre-configured template steps are better suited. These template steps are:

The Element step supports effects that can be used to:

tag annotated elements
exclude annotated elements
group or ungroup elements to correct their representation in the structure

Annotations can be generated through

manual annotation Annotation Steps | Create Annotation
auto-labeling Annotation Steps | Auto Labeling
local annotation predictions (assisted labeling) Annotation Steps | Assisted Labeling
global annotation predictions Annotation Steps | Run Analysis
imported pre-existing structure Annotation Steps | Importing Annotations

Prerequisites

This feature is available to users in the role of ADMINistrators Workflow managers Case handlers

Settings and Options

The settings dialog of the element step offers configurations on

the selection mode for the annotations,
effects the annotations have on the annotated text and its context,
model types that are used for machine-generate annotations.

The settings dialog of the Element step

Name	Possible Values	Description	Default

Name	Possible Values	Description	Default
Selection Mode	`Paragraphs/Lines`, `Words`, `Words Block`, `Words and Images`, `Path and Images`	Specify the smallest unit that can be selected using the annotations of this step. If the selection mode is set to `Paragraphs/Lines`, paragraphs and lines can be annotated `Words`, individual words can be annotated `Words Block`, blocks of words can be annotated that are grouped together `Words and Images`, individual words or images can be annotated `Path and Images`, path elements and images can be annotated	`Paragraphs/Lines`
Effect Type	`Tag`, `Header`, `Split`, `Remove`, `Figure`, `Group`, `To Paragraph`, Deprecated in V35 `Hyphens Resolution`	Specify the effect to apply to the annotated element(s). `Tag`, adds a custom tag to the annotated element(s) in the export `Header`, marks the annotated element(s) as a title of a section `Split`, extracts the annotated element(s) from its surrounding structural parent element and places it right before it `Remove`, removes the annotated element `Figure`, creates a figure out of the annotated area `Group`, groups the annotated element(s) into one structural element `To Paragraph`, combines the annotated element(s) into a single paragraph and extracts it from its surrounding structural parent Deprecated in V35 `Hyphens Resolution`, adds a custom tag to the annotated element(s), resolves hyphenation and pulls the elements into a single paragraph	`Header`
Level	`Numeric between 1 and 9`	If the effect type is Header, define the header level.	`1`
Annotation Remainders v33	`Split into Before & After Groups` `Merge into Single Group`	Specify what effect is applied on the remainder of the annotation. With Split into Before & After Groups the non-annotated part of the paragraph is kept as a paragraph before the annotation and a paragraph after the annotation. With the other option, the two non-annotated parts are merged into a single paragraph.	`Split into Before & After Groups`
Existing Occurence Behavior	`Always Keep` `Dissolve on Overlap with Annotation` `Always Dissolve`	Defines how the annotations of this step interact with preexisting items of the same kind. Elements of this type might already preexist generated through other steps such as another caption step, OCR Steps or for certain file types even on import. Select `Always Keep`, if all preexisting caption annotations should be kept and create the sections of the document alongside the annotation of the caption step `Dissolve on Overlap with Annotation`, to keep preexisting caption annotations except for those that overlap with annotations of this caption step `Always Dissolve`, to discard all preexisting caption and only keeps the annotations of this caption step.	`Always Keep`
Local Model	`None` `Text Based` `Text Based (Word Blocks)`	Define the model type that is used for the assisted labeling. The assisted labeling produces machine-generated annotation suggestions (in blue) based on the current manual and verified annotations. It is only based on annotations of the currently viewed document. The assisted labeling suggestions are updated with every change on the annotations. Select between the available model types or choose “None” to disable the assisted labeling.	`Text Based`
Shared Model	`None` `Text Based`	Define the model type that is used for the shared model. The shared model produces machine-generated annotation suggestions (in orange) based on trained Analysis Model for this analysis. The shared model suggestions are generated when the analysis is run (more details here Analysis Model ) Select between the available model types.	`Text Based`
Effects applied to annotated part	`Text Aggregation` `Reading Order`	Refer to https://acodis.atlassian.net/wiki/spaces/DOC/pages/877789186	`(None)`
Effects applied to parents of annotated parts	`Text Aggregation` `Reading Order`	Refer to https://acodis.atlassian.net/wiki/spaces/DOC/pages/877789186	`(None)`

How to use

Getting Started

To use the element step, follow these steps:

Open a document in the https://acodis.atlassian.net/wiki/spaces/DOC/pages/867500034
Click on Add to include the element step in your analysis.
Locate the step under the NEW column or the EXISTING column if you have this step created already.
If necessary, adjust the configuration settings via the contextual menu (right-click > Settings).
Start creating annotations by either of or any combination of
1. Generate annotations from document, to create annotations from existing annotations of the same kindAnnotation Steps | Importing Annotations
2. Run Analysis to create predictions of annotations from the defined model (if one has already been created, refer to Analysis Model and https://acodis.atlassian.net/wiki/spaces/DOC/pages/867500034) Annotation Steps | Run Analysis
3. Manually annotate the elements Annotation Steps | Create Annotation
4. Generate annotations through assisted labeling, to let the local model suggest annotations based on the existing annotations on this document Annotation Steps | Assisted Labeling
Select the elements or export preview, to view the effect of the annotations https://acodis.atlassian.net/wiki/spaces/DOC/pages/867500034/Analysis+Document+Viewer#Previews
Mark fully annotated pages as verified

Usage example

Refer to any of the template steps mentioned in https://acodis.atlassian.net/wiki/spaces/DOC/pages/edit-v2/879263822#Description

Sub-Pages

For any questions you can contact our support team.