Queue items

Add, list, remove, assign, complete, and skip queue items.

add_items

Adds items to the queue for annotation.

def add_items(
    self,
    queue_id: Optional[str] = None,
    items: Optional[List[Dict[str, str]]] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> AddItemsResponse
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • items (List[Dict[str, str]]): List of dicts, each with source_type and source_id.
      • Valid source_type values: "trace", "observation_span", "trace_session", "call_execution", "prototype_run", "dataset_row".
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • AddItemsResponse with added and duplicates counts.

list_items

Lists items in a queue with optional filters.

def list_items(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    status: Optional[str] = None,
    assigned_to: Optional[str] = None,
    page: int = 1,
    page_size: int = 50,
    timeout: Optional[int] = None,
) -> List[QueueItem]
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • status (Optional[str]): Filter by item status — "pending", "in_progress", or "completed".
    • assigned_to (Optional[str]): Filter by assigned user ID.
    • page (int): Page number. Defaults to 1.
    • page_size (int): Results per page. Defaults to 50.
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • List[QueueItem]

remove_items

Bulk-removes items from the queue.

def remove_items(
    self,
    queue_id: Optional[str] = None,
    item_ids: Optional[List[str]] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> Dict[str, Any]
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • item_ids (List[str]): List of item UUIDs to remove.
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • Dict[str, Any]

assign_items

Assigns items to an annotator. Pass user_id=None to unassign.

def assign_items(
    self,
    queue_id: Optional[str] = None,
    item_ids: Optional[List[str]] = None,
    *,
    queue_name: Optional[str] = None,
    user_id: Optional[str] = None,
    timeout: Optional[int] = None,
) -> Dict[str, Any]
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • item_ids (List[str]): List of item UUIDs to assign.
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • user_id (Optional[str]): User UUID to assign to. Pass None to unassign.
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • Dict[str, Any]

complete_item

Marks a queue item as completed.

def complete_item(
    self,
    queue_id: Optional[str] = None,
    item_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> Dict[str, Any]
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • item_id (str): UUID of the queue item.
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • Dict[str, Any]

skip_item

Skips a queue item.

def skip_item(
    self,
    queue_id: Optional[str] = None,
    item_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> Dict[str, Any]
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • item_id (str): UUID of the queue item.
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • Dict[str, Any]

Was this page helpful?

Questions & Discussion