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.

​
id
string
required

Unique identifier for the annotation.

Example:

"an_abc123efg456"

​
key
string
required

Key for the annotation.

Example:

"formatting"

​
type
string
required

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

​
title
string

Title of the annotation.

Example:

"Response Formatting"

​
description
string

Further details about the question.

Example:

"Does the response contain issues with formatting?"

​
labels
string[]

String representation of the possible options.

A string representation of the annotation.

Example:
["Major Issues", "Minor Issues", "No Issues"]
​
metadata
object
​
value
integer

Integer type annotation value.

Example:

3

​
possible_values
integer[]

The possible values for this annotation.

Integer type annotation value.