Annotation

Validate against: http://json-schema.org/schema#

Description

An annotation on a text. Annotations are useful for indicating properties of a text which are anchored in time, or which cross the boundaries of linguistic objects like utterances and words. Examples uses might include: annotating a period of time when a speaker is whispering; annotating a stretch of the text as being a particular episode in the text; annotating the text for turns or prosodic units. Annotations should generally be used as a last resort. Whenever possible, data should be attached to linguistic objects, and represented as attributes of those linguistic entities. For example, it would be bad practice to use a timespan annotation to indicate the start and end times of a word. Instead, you should add the custom properties startTime and endTime to each Word object. Each annotation must have either a notes or a tags property specified, in order to describe the annotation.

Type: object

Validates Against (allOf)

This schema must validate against all of the following schemas:

  • Validates Against (anyOf)

    This schema must validate against at least one of the following schemas:

    • Required Properties

      • notes
    • Required Properties

      • tags
  • Validates Against (oneOf)

    This schema must validate against one and only one of the following schemas:

    • Timestamp Annotation

      Description

      A timespan annotation is an annotation which spans a duration of time. This is particularly useful for annotating non-linguistic features of the text which are happening in the background.

      Required Properties

      • ts

      Properties

      • Timestamp

        Description

        The point in time that the annotation is about, formated in seconds and millseconds (SS.MMM)

        Type: number

    • Timespan Annotation

      Description

      A timestamp annotation is an annotation at a single point in time in a text. It should be used for data that do not have a duration, or to attach generic notes with observations at specific points in time.

      Required Properties

      • startTime
      • endTime

      Properties

      • Start Time

        Description

        The time that the annotation starts, formated in seconds and milliseconds (SS.MMM)

        Type: number

      • End Time

        Description

        The time that the annotation ends, formatted in seconds and milliseconds (SS.MMM)

        Type: number

        Minimum: 0.001

Required Properties

  • annotationType

Additional properties: true

Properties

  • Type: "type"

    Description

    The type of object. Must be set to Annotation.

    Type: string

  • Annotation Type: "annotationType"

    Description

    The type of Annotation

    Type: string

    Allowed Values (enum)

    • "timespan"
    • "timestamp"
  • Notes: "notes"

    Description

    A collection of notes for this Annotation

    Type: array

    Unique items: true

    Items

    Note

    Description

    A Note about this Annotation

    Must be an instance of the Note schema.

  • Tags: "tags"

    Description

    A set of tags for this Annotation

    Must be an instance of the Tags schema.