annotator_evaluation_enabledboolean
Enable annotator evaluation for the project
config_has_control_tagsboolean required
Flag to detect is project ready for labeling
config_suitable_for_bulk_annotationboolean required
Flag to detect is project ready for bulk annotation
control_weightsobject nullable
Dict of weights for each control tag in metric calculation. Keys are control tag names from the labeling config. At least one tag must have a non-zero overall weight.
created_atstring date-time required
descriptionstring nullable
enable_empty_annotationboolean
Allow annotators to submit empty annotations
evaluate_predictions_automaticallyboolean
Retrieve and display predictions when loading a task
expert_instructionstring nullable
Labeling instructions in HTML format
finished_task_numberinteger required
ground_truth_numberinteger required
Honeypot annotation number in project
is_draftboolean
Whether or not the project is in the middle of being created
is_publishedboolean
Whether or not the project is published to annotators
label_configstring nullable
Label config in XML format. See more about it in documentation
maximum_annotationsinteger
Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)
min_annotations_to_start_traininginteger
Minimum number of completed tasks after which model training is started
model_versionstring nullable
Machine learning model version
num_tasks_with_annotationsinteger required
Tasks with annotations count
organizationinteger nullable
overlap_cohort_percentageinteger
parsed_label_configobject required
JSON-formatted labeling configuration
pinned_atstring date-time nullable
queue_doneinteger required
queue_totalinteger required
reveal_preannotations_interactivelyboolean
Reveal pre-annotations interactively
sampling'Sequential sampling' | 'Uniform sampling' | 'Uncertainty sampling'
- Sequential sampling - Tasks are ordered by Data manager ordering
- Uniform sampling - Tasks are chosen randomly
- Uncertainty sampling - Tasks are chosen according to model uncertainty scores (active learning mode)
show_annotation_historyboolean
Show annotation history to annotator
show_collab_predictionsboolean
If set, the annotator can view model predictions
show_ground_truth_firstboolean
Onboarding mode (true): show ground truth tasks first in the labeling stream
show_instructionboolean
Show instructions to the annotator before they start
show_overlap_firstboolean
show_skip_buttonboolean
Show a skip button in interface and allow annotators to skip the task
skip_queue'REQUEUE_FOR_ME' | 'REQUEUE_FOR_OTHERS' | 'IGNORE_SKIPPED'
- REQUEUE_FOR_ME - Requeue for me
- REQUEUE_FOR_OTHERS - Requeue for others
- IGNORE_SKIPPED - Ignore skipped
skipped_annotations_numberinteger required
Skipped by collaborators annotation number in project
start_training_on_annotation_updateboolean required
Start model training after any annotations are submitted or updated
task_data_loginstring nullable
Task data credentials: login
task_data_passwordstring nullable
Task data credentials: password
task_numberinteger required
Total task number in project
titlestring nullable
Project name. Must be between 3 and 50 characters long.
total_annotations_numberinteger required
Total annotations number in project including skipped_annotations_number and ground_truth_number.
total_predictions_numberinteger required
Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
useful_annotation_numberinteger required
Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number