Skip to main content

​
ConsensusAnnotationStage Objects

class ConsensusAnnotationStage(WorkflowStageBase)

​
stage_type

The Annotate stage in a Consensus Project.

​
get_tasks

def get_tasks(
        *,
        assignee: Union[List[str], str, None] = None,
        data_hash: Union[List[UUID], UUID, List[str], str, None] = None,
        dataset_hash: Union[List[UUID], UUID, List[str], str, None] = None,
        data_title: Optional[str] = None) -> Iterable[ConsensusAnnotationTask]
Retrieves tasks for the ConsensusAnnotationStage. Parameters
  • assignee (Union[List[str], str, None]): A list of user emails or a single user email to filter tasks by assignee.
  • data_hash (Union[List[UUID], UUID, List[str], str, None]): A list of data unit UUIDs or a single data unit UUID to filter tasks by data hash.
  • dataset_hash (Union[List[UUID], UUID, List[str], str, None]): A list of dataset UUIDs or a single dataset UUID to filter tasks by dataset hash.
  • data_title (Optional[str]): A string to filter tasks by data title.
Returns An iterable of ConsensusAnnotationTask instances with the following information:
  • uuid: Unique identifier for the task.
  • created_at: Time and date the task was created.
  • updated_at: Time and date the task was last edited.
  • data_hash: Unique identifier for the data unit.
  • data_title: Name/title of the data unit.
  • subtasks: A list of subtasks that follow the task format for AnnotationTask.

​
ConsensusAnnotationTask Objects

class ConsensusAnnotationTask(WorkflowTask)
Represents tasks in the Annotate stage of a Consensus Project. Attributes
  • data_hash (UUID): Unique ID for the data unit.
  • data_title (str): Name of the data unit.
  • subtasks (List[AnnotationTask]): List of tasks from individual annotators in a Consensus Project.
Allowed actions
  • move: Moves the consensus annotation task to another stage in the workflow.

​
move

def move(*,
         destination_stage_uuid: UUID,
         bundle: Optional[Bundle] = None) -> None
Moves the consensus annotation task from its current stage to another stage. Parameters
  • destination_stage_uuid (UUID): Unique identifier of the stage to move the task to.
  • bundle (Optional[Bundle]): Optional bundle to be included with the move.
Returns None