Delete Annotations

šŸ“˜

Click for Python SDK

Dataset.delete_annotations(
    reference_ids: List[str],
    keep_history: bool
) -> AsyncJob

This endpoint deletes all ground truth annotations for an entire dataset or by specific dataset items. To delete by DatasetItem, pass a list of reference ids as an argument. By default, this endpoint deletes all version history associated with the deleted annotations. To toggle the preservation of version history, use the keep_history flag.

Because deleting annotations for a large dataset can be time consuming, this endpoint is asynchronous, meaning that the endpoint returns before deletion has completed. Consequently, the job_id returned by this endpoint can be used to check the status of the job.

Path Params
string
required

The Scale-generated ID of the Dataset.

Body Params
reference_ids
array of strings

A list of reference IDs corresponding to the items whose associated annotations you wish to delete.

reference_ids
boolean
Defaults to false

Whether to preserve version history. If False, all previous versions will be deleted along with the annotations. If True, the version history (including deletion) wil persist.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json