AnnotationQueue class

Reference for the AnnotationQueue class in the Future AGI Python SDK: create, fetch, and populate annotation queues programmatically.

For step-by-step examples, see the Annotation Queue Using SDK guide.

The AnnotationQueue class is the SDK client for managing annotation queues, items, scores, and analytics. Annotation queues let you organize traces, sessions, datasets, and simulation outputs for structured human review. You can define custom labels, set how many annotations are needed per item, and add guidelines to keep feedback consistent.

Note

All methods that accept queue_id also accept queue_name as an alternative. Similarly, methods that accept label_id also accept label_name. The SDK resolves names to IDs automatically. If multiple matches are found, an error is raised asking you to use the ID instead.

Installation

pip install futureagi

Initialization

from fi.queues import AnnotationQueue

client = AnnotationQueue(
    fi_api_key="your_api_key",
    fi_secret_key="your_secret_key",
    fi_base_url="https://api.futureagi.com",  # optional
)

Arguments:

  • fi_api_key (Optional[str]): API key for authentication.
  • fi_secret_key (Optional[str]): Secret key for authentication.
  • fi_base_url (Optional[str]): Base URL for the API.
Was this page helpful?

Questions & Discussion