Annotating custom fields

In this tutorial, we explain how to add new fields an annotation app build with the data widget factory (demoed with the Quaero dataset in the previous tutorial):

In the current Quaero example, entities are nested inside each note (notes[i]["entities"]). You control which attributes appear in the UI by:

Extending the imported data structure.
Listing these attributes in widget fields (infer_fields(...) or manual form fields).

Check out the Table component documentation for more details about supported field types.

Load the data

For example, add a note-level source field and an entity-level negation field.

 notes.append(
     {
         "note_id": str(doc._.note_id),
         "note_text": doc.text,
+        "source": "quaero",  # (1)!
         "note_kind": "interesting" if idx % 2 == 0 else "very interesting",
         "seen": False,
         "entities": [
             {
                 "id": f"#{uuid.uuid4()}",
                 "text": str(e),
                 "begin": e.start_char,
                 "end": e.end_char,
                 "label": e.label_,
                 "concept": e._.cui,
+                "negation": False,  # (2)!
             }
             for e in sorted(doc.spans["entities"])
         ],
     }
 )

You can set this from metadata, a file path, or an upstream pipeline.
Replace with e._.negation if your EDS-NLP pipeline populates it (for example with nlp.add_pipe("eds.negation")).

Show these fields

Update renderers in the Build the views and define their interactions section to include these attributes. For booleans such as negation, Metanno infers a boolean field type and renders a checkbox/toggle editor.

- visible_keys=["note_id", "seen", "note_text", "note_kind"],
+ visible_keys=["note_id", "seen", "note_text", "note_kind", "source"],
...
- editable_keys=["seen", "note_kind"],
+ editable_keys=["seen", "note_kind", "source"],
...
+ categorical_keys=["note_kind", "source"],

 fields=[
     {"key": "note_id", "kind": "text"},
     {
         "key": "note_kind",
         "kind": "radio",
         "editable": True,
         "options": ["interesting", "very interesting"],
         "filterable": True,
     },
     {"key": "seen", "kind": "boolean", "editable": True},
+    {"key": "source", "kind": "text", "editable": True},
 ]

- visible_keys=["id", "text", "label", "concept"],
+ visible_keys=["id", "text", "label", "concept", "negation"],
...
- editable_keys=["label", "concept"],
+ editable_keys=["label", "concept", "negation"],

- visible_keys=["label", "concept"],
+ visible_keys=["label", "concept", "negation"],
...
- editable_keys=["label", "concept"],
+ editable_keys=["label", "concept", "negation"],

Dropdown input

Add new keys to categorical_keys if they should use a dropdown editor/filter (for example concept, label, or a custom string category like source).