API Reference

AI Task Builder

View as Markdown

AI Task Builder is an innovative tool designed to streamline the process of creating data annotation tasks that integrate seamlessly with the Prolific participant pool.

  • Key Features:
    • Multiple choice and free text annotation inputs
    • Seamless integration with Prolific Taskflow and the Prolific participant pool

Example of the AI Task Builder API workflow:

1

Create a batch: Initiate your data collection project.

2

Create a dataset: Set up the data structure for your batch.

3

Upload your data: Request presigned URLs for your files, then upload the data directly to S3 using the presigned URLs.

4

Monitor dataset status: Wait for the dataset to be ready before proceeding.

5

Create instructions: Define the guidelines for your annotation tasks.

6

Set up the batch: Configure the batch with necessary details.

7

Monitor batch status: Ensure the batch is ready attaching to a study.

8

Create a study: Create a study that references your configured AI Task Builder batch. See the example request to further illustrate this step.

9

Publish the study: Publish the study to distribute tasks to annotators.

10

Wait for task completion: Allow time for annotators to complete the assigned tasks.

11

Fetch responses: Retrieve the completed annotations for your batch.

Example request to publish an AI Task Builder study:

1{
2  "name": "AI Response Evaluation Task",
3  "internal_name": "Internal Task Batch Name",
4  "description": "<h1>Instructions for Selecting the Best Response</h1><p>Your task is to annotate the data.</p>",
5  "prolific_id_option": "not_required",
6  "total_available_places": 3,
7  "estimated_completion_time": 6,
8  "maximum_allowed_time": 15,
9  "reward": 120,
10  "filters": [
11    {
12      "filter_id": "participant_group_allowlist",
13      "selected_values": [
14        "123458388bd36ffaae123456"
15      ]
16    }
17  ],
18  "study_labels": [
19    "ai_annotation"
20  ],
21  "data_collection_method": "DC_TOOL",
22  "data_collection_id": "{{TASK_BUILDER_BATCH_ID}}",
23}

This flow guides you through the entire process of setting up a data collection project, from batch creation to retrieving annotated data, using the AI Task Builder API:

Task Builder API Flow Diagram

By using AI Task Builder, you agree to our AI Task Builder Terms.