Queue lifecycle

Activate and complete annotation queues.

`activate`

Activates a queue, transitioning it from draft to active status.

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

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:
- QueueDetail instance

`complete_queue`

Marks a queue as completed.

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

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:
- QueueDetail instance

Note

Completing a queue does not automatically disable its automation rules. If you have active rules, they may continue adding items to the queue, which will re-activate it. Disable or delete automation rules manually before completing the queue if you want to prevent new items from being added.

Was this page helpful?

Questions & Discussion