Annotation

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

Schema ID: http://schemas.digitallinguistics.io/Annotation-2.2.0.json

Type: object

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.

Required Properties

  • annotationType

Properties

The following properties are defined for this object:

  • Type: type

    Type: string

    Read-only: true

    Description

    The type of object. Must be set to Annotation.

    This item must have the following value:

    "Annotation"

  • Annotation Type: annotationType

    Type: string

    Description

    The type of Annotation

    Allowed Values

    • "timespan"
    • "timestamp"

  • Notes: notes

    Type: array

    Description

    A collection of notes for this Annotation

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Note: notes

    Type: object

    Description

    A Note about this Annotation

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Note.json

  • Tags: tags

    Type: object

    Description

    A set of tags for this Annotation

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Tags.json

Additional Properties

Any additional properties must adhere to the following schema:

This schema imposes no restrictions. All values are valid.

This item must also validate against all of the following schemas:

  • This item must also validate against at least one of the following schemas:

    • Required Properties

      • notes

    • Required Properties

      • tags

  • This item must also validate against exactly 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

      The following properties are defined for this object:

      • Timestamp: ts

        Type: number

        Description

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

        Minimum: 0

    • Timespan Annotation: 1

      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

      The following properties are defined for this object:

      • Start Time: startTime

        Type: number

        Description

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

        Minimum: 0

      • End Time: endTime

        Type: number

        Description

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

        Minimum: 0.001

Examples

The following are example values for this schema:

  • {
  "type": "Annotation",
  "annotationType": "timespan",
  "startTime": 1,
  "endTime": 2,
  "tags": {
    "creakyVoice": true
  }
}
  • {
  "type": "Annotation",
  "annotationType": "timestamp",
  "ts": 1.234,
  "notes": [
    {
      "text": "Speaker points to listener here."
    }
  ]
}
  • {
  "type": "Annotation",
  "annotationType": "timestamp",
  "notes": [
    {
      "text": "Points to door."
    }
  ],
  "tags": {
    "gestureType": "point"
  },
  "ts": 12.345
}
  • {
  "type": "Annotation",
  "annotationType": "timespan",
  "endTime": 67.871,
  "notes": [
    {
      "text": "Speaker 2 was not present for this part of the text."
    }
  ],
  "startTime": 12.345,
  "tags": {
    "intonationContour": "sharpRise"
  }
}