Add optional notes

Allow useful context without forcing labelers to write an explanation for every record.

What the labeler sees

Captured from this recipe’s downloadable configuration and sample data. Select image to enlarge.

Try this example: download the complete configuration and sample CSV. Open the configuration in MLabel, then load the CSV.

View the complete configuration

{
  "$schema": "https://mlabel.vlad.gg/mlabel.schema.json",
  "version": 2,
  "network": {
    "updateChecks": false,
  },
  "input": {
    "fields": [
      {
        "name": "id",
        "type": "text",
        "display": "Record ID",
      },
      {
        "name": "comment",
        "type": "text",
        "display": {
          "title": "Customer comment",
          "titlePosition": "above",
        },
      },
    ],
  },
  "output": {
    "fields": [
      {
        "name": "id",
        "type": "text",
        "fill": {
          "kind": "copy",
        },
      },
      {
        "name": "verdict",
        "type": "enum",
        "widget": "radio",
        "display": "Review decision",
        "choices": [
          {
            "name": "pass",
            "display": "Pass",
          },
          {
            "name": "fail",
            "display": "Fail",
          },
        ],
      },
      {
        "name": "notes",
        "type": "text",
        "widget": "textarea",
        "required": false,
        "maxLength": 500,
        "display": {
          "title": "Notes",
          "description": "Add context when it will help the next reviewer.",
        },
      },
    ],
  },
}

View the sample CSV

id,comment
r001,The parcel arrived late and the box was torn.

Configure it

Use a text field with widget: "textarea". required: false lets labelers leave it blank; maxLength: 500 limits any answer they do enter.

Use the description for a short instruction about when a note is helpful. Put longer guidance in display.help.

The relevant setting is in output.fields.2. The download above includes the surrounding configuration.

{
  "name": "notes",
  "type": "text",
  "widget": "textarea",
  "required": false,
  "maxLength": 500,
  "display": {
    "title": "Notes",
    "description": "Add context when it will help the next reviewer.",
  },
}

Try it and check the result

Select Pass and export with Notes empty: the record should be complete and its notes cell blank. In another run, enter a note and confirm it appears in the output.

Optional means empty is allowed, not that any value is valid. More than 500 characters produces an error and prevents that record from entering the finished output until corrected.

Browse all illustrated recipes →