Task
A Task represents an individual unit of work done by a contributor.
{
"task_id": "task_abc123",
"project": "project_abc123",
"batch": "batch_abc123",
"status": "completed",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"metadata": {},
"threads": [
...omitted...
]
}
{
"task_id": "task_abc123",
"project": "project_abc123",
"batch": "batch_abc123",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"metadata": {},
"threads": [
{
"id": "thread_abc123",
"turns": [
{
"id": "turn_abc123",
"messages": [
{
"role": "system",
"content": {
"text": "<string>",
"reference_texts": [
{
"content": "<string>",
"category": "<string>",
"url": "<string>"
}
],
"attachments": [
{
"content": "aSDinaTvuI8gbWludGxpZnk=",
"mime_type": "text/plain",
"scale_url": "<string>",
"url": "<string>"
}
]
},
"source_id": "source_abc123",
"model_parameters": {
"model": "my-model-123",
"temperature": 0.9,
"max_completion_tokens": 1000
},
"annotations": [
{
"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
]
]
}
]
}
],
"annotations": [
{
"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
]
]
}
]
}
],
"annotations": [
{
"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
]
]
}
]
}
],
"errors": [
{
"type": "UNSUPPORTED_LANGUAGE",
"message": "The specified language or locale is not supported"
}
]
}The work to be done is defined in the Task parameters. For example, a single Task might ask a contributor to have a conversation with a chat model and label all of the responses from the model. These labels are called Annotations.
Scale API offers following endpoints to download tasks:
Check out the Retrieve a Task docs on how to get a single task by its identifiers.
Check out the Get Multiple Tasks docs to learn more about how to download multiple tasks by different parameters like project, batch, status, or completion date.
Check out the Download tasks in a delivery docs to download tasks in a specific delivery.
{
"task_id": "task_abc123",
"project": "project_abc123",
"batch": "batch_abc123",
"status": "completed",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"metadata": {},
"threads": [
...omitted...
]
}
Represents a single task
Unique identifier for the task.
Current status of the task.
pending, completed, canceled, error UTC timestamp when the task was created.
UTC timestamp when the task was completed.
Task metadata defined during task creation.
Threads associated with the task. Tasks that do not have a status of completed will have an empty threads array.
Represents a thread of messages in a task.
Unique identifier for the thread.
Turns within the thread.
A unique identifier for the turn.
A list of messages associated with this turn.
The role of the sender in the conversation (e.g., user, assistant).
system, user, assistant, function The content of the message, including text and any attachments.
The ID of the source system or user that sent the message.
Annotations specific to this message.
Represents a generic annotation.
Unique identifier for the annotation.
Key for the annotation.
The type of the value and the possible_values, if they exist.
Title of the annotation.
Further details about the question.
String representation of the possible options.
A string representation of the annotation.
Integer type annotation value.
The possible values for this annotation.
Integer type annotation value.
The name of the model that generated the message.
The temperature of the model that generated the message.
The maximum number of tokens the model can generate.
Annotations applied to the entire turn.
Represents a generic annotation.
Unique identifier for the annotation.
Key for the annotation.
The type of the value and the possible_values, if they exist.
Title of the annotation.
Further details about the question.
String representation of the possible options.
A string representation of the annotation.
Unique identifier for an annotation.
Integer type annotation value.
The possible values for this annotation.
Integer type annotation value.
Annotations for the entire thread.
Represents a generic annotation.
Unique identifier for the annotation.
Key for the annotation.
The type of the value and the possible_values, if they exist.
Title of the annotation.
Further details about the question.
String representation of the possible options.
A string representation of the annotation.
Unique identifier for an annotation.
Integer type annotation value.
The possible values for this annotation.
Integer type annotation value.
Errors associated with the task. Available when the task status is error
Details of the error on the task. Available when the task status is error
{
"task_id": "task_abc123",
"project": "project_abc123",
"batch": "batch_abc123",
"status": "completed",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"metadata": {},
"threads": [
...omitted...
]
}
{
"task_id": "task_abc123",
"project": "project_abc123",
"batch": "batch_abc123",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"metadata": {},
"threads": [
{
"id": "thread_abc123",
"turns": [
{
"id": "turn_abc123",
"messages": [
{
"role": "system",
"content": {
"text": "<string>",
"reference_texts": [
{
"content": "<string>",
"category": "<string>",
"url": "<string>"
}
],
"attachments": [
{
"content": "aSDinaTvuI8gbWludGxpZnk=",
"mime_type": "text/plain",
"scale_url": "<string>",
"url": "<string>"
}
]
},
"source_id": "source_abc123",
"model_parameters": {
"model": "my-model-123",
"temperature": 0.9,
"max_completion_tokens": 1000
},
"annotations": [
{
"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
]
]
}
]
}
],
"annotations": [
{
"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
]
]
}
]
}
],
"annotations": [
{
"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
]
]
}
]
}
],
"errors": [
{
"type": "UNSUPPORTED_LANGUAGE",
"message": "The specified language or locale is not supported"
}
]
}