Projects View¶

Projects filter¶

The projects filter allows you to filter out the columns that are rendered as part of the Project list details.

Project list details¶

The project list details provide the following information about the available projects:

• Label (name): The name assigned to the project by the user during its creation

• Status: Whether it is active or archived

• Created at: When was the project created

• Created by: Name of the user who created it

• Modified at: When was the project modified

• Modified by: Name of the user who last modified the project

• Actions:

  • Edit: Edit the name of the project
  • Configure: Configure the project settings
  • Manage schema: Manage the project schema
  • Archive/Activate: Archive (make it read-only) or activate the project (make it editable)

Pagination bar¶

The pagination bar is used to specify the number of projects shown per page on the Projects view page, as well as to navigate to the previous/next page.

Create project¶

New projects are created through the Create project button in the Projects view. Clicking it opens a form where you need to input the name of the project. The rest of the data is filled out automatically.

Manage schema¶

The Manage schema view is accessed either under Actions ‣ Manage schema (the cog icon) for the respective project in the Projects view, or from the Manage schema button in the Corpora View.

There are four main classes within the annotation schema, which can be extended with child classes in order to configure the types of concepts, annotations, and relations that are relevant to your specific use case:

• Concept: Subclasses that inherit and extend this class represent the types of entities in the reference dataset. The search configurations for these are edited from here.
• Document: Subclasses that inherit and extend this class represent the types of documents the user can upload and annotate within the corpora.
• DocumentAnnotation: Subclasses that inherit and extend this class represent document-level annotations, which can potentially refer to an instance of the Concept classes, as well as have various other user-defined features.
• InlineAnnotation: Subclasses that inherit and extend this class represent inline-level annotations, which can potentially refer to an instance of the Concept class, as well as have various other user-defined features.

These are the default main classes, which can be extended with child classes. To view the child classes, click on the parent class.

There are four actions that can be performed here, accessible via the respective icons:

• Extend: Extend a parent class with a new child class that inherits the parent
• Edit: Edit a child class
• Delete: Delete a child class
• Open preview: View the details of the class in read-only mode

Furthermore, each concept or annotation class must be properly configured according to the context of the respective use case. This can be done either at the time of creation of this class via the Extend class button, or after creation via the Edit class button.

To illustrate the above, let’s create a new DocumentAnnotation. To do so, click the Extend class button in the DocumentAnnotation parent class row.

Class details¶

Here, we need to configure the Class ID.

Class fields¶

Here, you can define annotation features such as the field Name, an optional Description of what it represents, and its Range (default is “string”).

Note

The Range can be a string, an integer, a date, as well as a Concept (in case the use case requires entity linking), or even another Annotation when the use case involves relations consisting of multiple annotations.

In the above example, we have defined a “confidence” feature that specifies how confident the user or the text mining API service is for this annotation, as well as a “relevance” field specifying how relevant that annotation is to the document. Lastly, we have defined a Range of Location concept, since we want to be able to link entities from the reference dataset to annotations of the type Country.

Furthermore, via the toggle buttons present in this screen, each of the fields can be set as:

• Required: Specifies that each annotation of the respective type must have a value for this attribute, i.e., the user cannot create such an annotation in the Document view without inputting a value.
• Editable: Specifies if the field is read-only or data can be input.
• Multi-valued: Specifies if there can be more than one value assigned to the respective field. In the above example, the Wikidata field can optionally accept more than one Person concept as an input.

You can see the settings for each field by the icons next to its name – Required, Editable, and Multi-valued.

Class preview configuration¶

The class preview configuration specifies which of the fields’ values will be visualized as part of the annotation visualization within the Document View.

In the above example, only the Label and the score of the linked concept of type Location will be visualized within the Document view.

The Default sort field is used to specify the field based on which the sorting will be initially executed within the Document view. Sorting based on additional fields is possible later within the Document view - all of the annotation and concept fields selected within the Class preview configuration are later available as sorting options within the Document view.

Hint

The order in which the field values are visualized depends on their ordering within this view. For example, for an annotation that has a relevance of “0.9” and a linked concept with label “New York”, the visualization would be “0.9, New York”. The order can be specified by rearranging the fields with the up/down arrows so that it becomes “New York, 0.9”. Furthermore, the annotation will be sorted based on the content of the Label field for the linked Concept.

Note

The fields in the Class preview configuration depend on the fields from the parent Annotation class, as well as any fields that we have defined in the child class. In the above example, if “confidence” is removed from the Class fields panel, it would not be present within the Class preview configuration panel.

Warning

Although the sorting feature is available for all types of annotations, within the Document view itself, it is relevant for Document-level annotations only.

Configure project¶

The Configure project view is accessed through the Configure project settings button in the Actions column. This configuration is relevant in case you have Concepts and are interested in Entity Linking. This view allows for configuring the instance IRIs so that they can be turned into URLs within the Document View and can easily be accessed in their native environment.

Once opened, you can create a new integration with an external service by clicking the Create New button. This will open a configuration dialog:

Next up, we need to provide a Name for the configuration. The URL is an optional parameter, relevant in case the IRI could not be treated directly as a link as is.

Once saved, the configurations are listed in the Configure project view: