Progress & analytics

get_progress

Gets queue progress metrics.

def get_progress(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> QueueProgress

• Arguments:
  • queue_id (Optional[str]): UUID of the annotation queue.
  • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • QueueProgress instance with total, pending, in_progress, completed, skipped, progress_pct, and annotator_stats.

get_analytics

Gets queue analytics including throughput, annotator performance, and label distribution.

def get_analytics(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> QueueAnalytics

• Arguments:
  • queue_id (Optional[str]): UUID of the annotation queue.
  • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • QueueAnalytics instance with throughput, annotator_performance, label_distribution, status_breakdown, and total.

get_agreement

Gets inter-annotator agreement metrics for a queue.

def get_agreement(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> QueueAgreement

• Arguments:
  • queue_id (Optional[str]): UUID of the annotation queue.
  • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • QueueAgreement instance with overall_agreement, per_label, and annotator_pairs.