Sign in
Projects

Update project details

Update the details of a specific project.

patch/api/projects/{id}/

Path parameters

idinteger required

Query parameters

members_limitinteger

Maximum number of members to return

Request body

agreement_methodology'consensus' | 'pairwise'
  • consensus - Consensus
  • pairwise - Pairwise Averaging
agreement_thresholdstring decimal nullable

Agreement threshold

annotation_limit_countinteger nullable

Limit by number of tasks

annotation_limit_percentstring decimal nullable

Limit by percentage of tasks

annotator_evaluation_continuous_tasksinteger

Continuous Evaluation: Required tasks

annotator_evaluation_enabledboolean

Evaluate all annotators against ground truth

annotator_evaluation_minimum_scorestring decimal nullable

Score required to pass evaluation

annotator_evaluation_minimum_tasksinteger nullable

Number of tasks for evaluation

annotator_evaluation_onboarding_tasksinteger

Onboarding Evaluation: Required tasks

colorstring nullable

Color

comment_classification_configstring
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.

custom_interface_codestring nullable
custom_interface_compiledstring nullable
{"stackTrail":"components:schemas:PatchedLseProjectUpdateRequest:properties:custom_interface_params","oasType":"schema","type":"unknown","nullable":true}
custom_scriptstring

Plugins

custom_task_lock_ttlinteger nullable

Task reservation time. TTL in seconds (UI displays and edits this value in minutes).

descriptionstring nullable

Description

enable_empty_annotationboolean

Allow empty annotations

evaluate_predictions_automaticallyboolean

Retrieve and display predictions when loading a task

expert_instructionstring nullable

Instructions

{"stackTrail":"components:schemas:PatchedLseProjectUpdateRequest:properties:input_schema","oasType":"schema","type":"unknown","nullable":true}
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

Labeling Configuration

max_additional_annotators_assignableinteger nullable

Maximum additional annotators

maximum_annotationsinteger

Annotations per task

min_annotations_to_start_traininginteger

Minimum number of completed tasks after which model training is started

model_versionstring nullable

Machine learning model version

organizationinteger nullable
{"stackTrail":"components:schemas:PatchedLseProjectUpdateRequest:properties:output_schema","oasType":"schema","type":"unknown","nullable":true}
overlap_cohort_percentageinteger

Annotations per task coverage

pause_on_failed_annotator_evaluationboolean nullable

Pause annotator on failed evaluation

pinned_atstring date-time nullable

Pinned date and time

require_comment_on_skipboolean

Require comment to skip

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 Data Manager to Annotators

show_collab_predictionsboolean

Use predictions to pre-label Tasks

show_ground_truth_firstboolean

Onboarding mode (true): show ground truth tasks first in the labeling stream

show_instructionboolean

Show instructions before labeling

show_overlap_firstboolean

Show tasks with overlap first

show_skip_buttonboolean

Allow skipping tasks

show_unused_data_columns_to_annotatorsboolean nullable

Show only columns used in labeling configuration to Annotators. API uses inverse field semantics here: set false to show only used columns, set true to show all task.data columns.

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
source_interface_idinteger nullable
source_interface_versioninteger nullable

Stable version ID of the saved interface snapshot used by this project.

strict_task_overlapboolean

Enforce strict overlap limit

task_data_loginstring nullable

Login

task_data_passwordstring nullable

Password

titlestring nullable

Project Name

use_custom_interfaceboolean
workspaceinteger

Workspace

Response

agreement_methodology'consensus' | 'pairwise'
  • consensus - Consensus
  • pairwise - Pairwise Averaging
agreement_thresholdstring decimal nullable

Agreement threshold

annotation_limit_countinteger nullable

Limit by number of tasks

annotation_limit_percentstring decimal nullable

Limit by percentage of tasks

annotator_evaluation_continuous_tasksinteger

Continuous Evaluation: Required tasks

annotator_evaluation_enabledboolean

Evaluate all annotators against ground truth

annotator_evaluation_minimum_scorestring decimal nullable

Score required to pass evaluation

annotator_evaluation_minimum_tasksinteger nullable

Number of tasks for evaluation

annotator_evaluation_onboarding_tasksinteger

Onboarding Evaluation: Required tasks

colorstring nullable

Color

comment_classification_configstring
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
custom_interface_codestring nullable
custom_interface_compiledstring nullable
{"stackTrail":"components:schemas:LseProjectUpdate:properties:custom_interface_params","oasType":"schema","type":"unknown","nullable":true}
custom_scriptstring

Plugins

custom_task_lock_ttlinteger nullable

Task reservation time. TTL in seconds (UI displays and edits this value in minutes).

descriptionstring nullable

Description

enable_empty_annotationboolean

Allow empty annotations

evaluate_predictions_automaticallyboolean

Retrieve and display predictions when loading a task

expert_instructionstring nullable

Instructions

finished_task_numberinteger required

Finished tasks

ground_truth_numberinteger required

Honeypot annotation number in project

idinteger required
{"stackTrail":"components:schemas:LseProjectUpdate:properties:input_schema","oasType":"schema","type":"unknown","nullable":true}
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

Labeling Configuration

max_additional_annotators_assignableinteger nullable

Maximum additional annotators

maximum_annotationsinteger

Annotations per task

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
{"stackTrail":"components:schemas:LseProjectUpdate:properties:output_schema","oasType":"schema","type":"unknown","nullable":true}
overlap_cohort_percentageinteger

Annotations per task coverage

parsed_label_configobject required

JSON-formatted labeling configuration

pause_on_failed_annotator_evaluationboolean nullable

Pause annotator on failed evaluation

pinned_atstring date-time nullable

Pinned date and time

promptsstring required
queue_doneinteger required
queue_totalinteger required
require_comment_on_skipboolean

Require comment to skip

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 Data Manager to Annotators

show_collab_predictionsboolean

Use predictions to pre-label Tasks

show_ground_truth_firstboolean

Onboarding mode (true): show ground truth tasks first in the labeling stream

show_instructionboolean

Show instructions before labeling

show_overlap_firstboolean

Show tasks with overlap first

show_skip_buttonboolean

Allow skipping tasks

show_unused_data_columns_to_annotatorsboolean nullable

Show only columns used in labeling configuration to Annotators. API uses inverse field semantics here: set false to show only used columns, set true to show all task.data columns.

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

source_interface_idinteger nullable
source_interface_versioninteger nullable

Stable version ID of the saved interface snapshot used by this project.

start_training_on_annotation_updateboolean required

Start model training after any annotations are submitted or updated

statestring required
strict_task_overlapboolean

Enforce strict overlap limit

task_data_loginstring nullable

Login

task_data_passwordstring nullable

Password

task_numberinteger required

Total task number in project

titlestring nullable

Project Name

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.

use_custom_interfaceboolean
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

workspaceinteger required

Workspace

workspace_titlestring required

Changes