init

Bin

2025-12-16 9e0b2ba2c317b1a86212f24cbae3195ad1f3dbfa

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// id and title fixed because they'll be always defined in API response
declare type APIProject = {
  id: number;
 
  /** Project name. Must be between 3 and 50 characters long. */
  title: string;
 
  /** Project description */
  description?: string | null;
 
  /** Label config in XML format. See more about it in documentation */
  label_config?: string | null;
 
  /** Labeling instructions in HTML format */
  expert_instruction?: string | null;
 
  /** Show instructions to the annotator before they start */
  show_instruction?: boolean;
 
  /** Show a skip button in interface and allow annotators to skip the task */
  show_skip_button?: boolean;
 
  /** Allow annotators to submit empty annotations */
  enable_empty_annotation?: boolean;
 
  /** Show annotation history to annotator */
  show_annotation_history?: boolean;
  organization?: number | null;
  color?: string | null;
 
  /** 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) */
  maximum_annotations?: number;
 
  /** Whether or not the project is published to annotators */
  is_published?: boolean;
 
  /** Machine learning model version */
  model_version?: string | null;
 
  /** Whether or not the project is in the middle of being created */
  is_draft?: boolean;
  created_by?: APIUserSimple;
 
  /** @format date-time */
  created_at?: string;
 
  /** Minimum number of completed tasks after which model training is started */
  min_annotations_to_start_training?: number;
 
  /** If set, the annotator can view model predictions */
  show_collab_predictions?: boolean;
  num_tasks_with_annotations?: string;
 
  /** Total task number in project */
  task_number?: number;
 
  /** Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number */
  useful_annotation_number?: string;
 
  /** Honeypot annotation number in project */
  ground_truth_number?: string;
 
  /** Skipped by collaborators annotation number in project */
  skipped_annotations_number?: string;
 
  /** Total annotations number in project including skipped_annotations_number and ground_truth_number. */
  total_annotations_number?: string;
 
  /** Total number of tasks with at least one annotation */
  finished_task_number: number;
 
  /** Total predictions number in project including skipped_annotations_number and ground_truth_number. */
  total_predictions_number?: string;
  sampling?: "Sequential sampling" | "Uniform sampling" | "Uncertainty sampling" | null;
  show_ground_truth_first?: boolean;
  show_overlap_first?: boolean;
  overlap_cohort_percentage?: number;
 
  /** Task data credentials: login */
  task_data_login?: string | null;
 
  /** Task data credentials: password */
  task_data_password?: string | null;
 
  /** Weights for control tags */
  control_weights?: Record<string, unknown> | null;
 
  /** JSON-formatted labeling configuration */
  parsed_label_config?: string;
 
  /**
   * Total number of tasks in the queue
   */
  queue_total: number;
 
  /**
   * Number of finished tasks
   */
  queue_done: number;
};