Item & Annotation Description Migration
  • 07 Mar 2023
  • Dark
    Light
  • PDF

Item & Annotation Description Migration

  • Dark
    Light
  • PDF

Article summary

Your action is required by August 8th, 2022, to ensure continuous work with item.description and annotation.description follows the upcoming change:

What is changing?

Starting from Aug 8th, Item.description will be made available as root property of the item, and can no longer be set as an annotation (under the item annotations JSON) nor added to the item system metadata.

Likewise, Annotation description will become a root property of the annotation (Annotation.description) and be removed from the annotation system metadata.

How are you affected?

  1. Migration - All existing "item description" will be transferred to the root property (item.description), and will no longer appear in the annotations JSON or in the items' system metadata.
    Same for Annotation.description.

  2. SDK - As soon as the changes take effect, you must upgrade to the latest SDK version to be able to create or update items/annotations description via SDK. Using older versions for such actions, won't be available (you may get an error).

  3. Dataset browser filter - To filter out items with a desctiprion, you will have to use the new filters "Described"/"Not-described" under the "Item status" section.
    item.description won't be counted under the "Annotated"/"Not Annotated" filters any longer.

  4. Image Captioning - In order to use item description for labelling purposes, we recommend using the classification tool and adding a description (note) over the annotation.