Annotation

Annotations exist within a Task and are the end-result from contributors. An Annotation includes a unique identifier for the annotation, a human-readable key, the value of the annotation, all possible values for the annotation, and any other information provided to the contributor (question title, description, etc).

Represents a generic annotation.

string

required

Unique identifier for the annotation.

key

string

required

Key for the annotation.

type

string

required

The type of the value and the possible_values, if they exist.

title

string

Title of the annotation.

description

string

Further details about the question.

labels

string[]

String representation of the possible options.

A string representation of the annotation.

metadata

object

value

integer

Integer type annotation value.

possible_values

integer[]

The possible values for this annotation.

Integer type annotation value.

Message Expanding Entities

{
  "id": "an_abc123efg456",
  "key": "formatting",
  "type": "<string>",
  "title": "Response Formatting",
  "description": "Does the response contain issues with formatting?",
  "labels": [
    "Major Issues",
    "Minor Issues",
    "No Issues"
  ],
  "metadata": {
    "criteria": "overall_quality"
  },
  "value": 3,
  "possible_values": [
    [
      1,
      2,
      3
    ]
  ]
}

Get Started

API Reference

Project Archetypes

Endpoints