Export

Export annotations, or export a queue to a dataset.

export

Exports queue annotations in JSON or CSV format.

def export(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    export_format: str = "json",
    status: Optional[str] = None,
    timeout: Optional[int] = None,
) -> Any
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • export_format (str): Export format — "json" or "csv". Defaults to "json".
    • status (Optional[str]): Filter by item status (e.g. "completed").
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • For JSON: List[Dict]. For CSV: raw text string.

export_to_dataset

Exports annotated queue items to a Future AGI dataset.

def export_to_dataset(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    dataset_name: Optional[str] = None,
    dataset_id: Optional[str] = None,
    status_filter: Optional[str] = None,
    timeout: Optional[int] = None,
) -> ExportToDatasetResponse
  • Arguments:
    • queue_id (Optional[str]): UUID of the annotation queue.
    • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
    • dataset_name (Optional[str]): Name for a new dataset. Mutually exclusive with dataset_id.
    • dataset_id (Optional[str]): UUID of an existing dataset to append to. Mutually exclusive with dataset_name.
    • status_filter (Optional[str]): Item status to export. Defaults to "completed".
    • timeout (Optional[int]): Request timeout in seconds.
  • Returns:
    • ExportToDatasetResponse with dataset_id, dataset_name, and rows_created.

Was this page helpful?

Questions & Discussion