Merge pull request #86 from scaleapi/delete_annotations

delete annotations

Author: sasha-scale

nucleus/__init__.py

@@ -90,6 +90,7 @@
     IMAGE_URL_KEY,
     ITEM_METADATA_SCHEMA_KEY,
     ITEMS_KEY,
+    KEEP_HISTORY_KEY,
     MODEL_RUN_ID_KEY,
     NAME_KEY,
     NUCLEUS_ENDPOINT,
@@ -1037,6 +1038,28 @@ def delete_slice(self, slice_id: str) -> dict:
         )
         return response
 
+    def delete_annotations(
+        self, dataset_id: str, reference_ids: list = None, keep_history=False
+    ) -> dict:
+        """
+        This endpoint deletes annotations.
+
+        :param
+        slice_id: id of the slice
+
+        :return:
+        {}
+        """
+        payload = {KEEP_HISTORY_KEY: keep_history}
+        if reference_ids:
+            payload[REFERENCE_IDS_KEY] = reference_ids
+        response = self.make_request(
+            payload,
+            f"annotation/{dataset_id}",
+            requests_command=requests.delete,
+        )
+        return response
+
     def append_to_slice(
         self,
         slice_id: str,

nucleus/constants.py

@@ -41,6 +41,7 @@
 ITEM_KEY = "item"
 ITEM_METADATA_SCHEMA_KEY = "item_metadata_schema"
 JOB_ID_KEY = "job_id"
+KEEP_HISTORY_KEY = "keep_history"
 LABEL_KEY = "label"
 MASK_URL_KEY = "mask_url"
 MESSAGE_KEY = "message"

nucleus/dataset.py

@@ -241,7 +241,7 @@ def append(
                 payload={REQUEST_ID_KEY: request_id, UPDATE_KEY: update},
                 route=f"dataset/{self.id}/append?async=1",
             )
-            return AsyncJob(response["job_id"], self._client)
+            return AsyncJob(response[JOB_ID_KEY], self._client)
 
         return self._client.populate_dataset(
             self.id,
@@ -361,3 +361,11 @@ def items_and_annotations(
             requests_command=requests.get,
         )
         return convert_export_payload(api_payload[EXPORTED_ROWS])
+
+    def delete_annotations(
+        self, reference_ids: list = None, keep_history=False
+    ):
+        response = self._client.delete_annotations(
+            self.id, reference_ids, keep_history
+        )
+        return AsyncJob(response[JOB_ID_KEY], self._client)

tests/test_annotation.py

@@ -302,3 +302,19 @@ def test_polygon_gt_upload_ignore(dataset):
     assert_polygon_annotation_matches_dict(
         response_annotation, TEST_POLYGON_ANNOTATIONS[0]
     )
+
+    @pytest.mark.integration
+    def test_box_gt_deletion(dataset):
+        annotation = BoxAnnotation(**TEST_BOX_ANNOTATIONS[0])
+
+        print(annotation)
+
+        response = dataset.annotate(annotations=[annotation])
+
+        assert response["annotations_processed"] == 1
+
+        job = dataset.delete_annotations()
+        job.sleep_until_complete()
+        job_status = job.status()
+        assert job_status["status"] == "Completed"
+        assert job_status["job_id"] == job.id

tests/test_slice.py

@@ -1,5 +1,6 @@
 import copy
 import pytest
+import uuid
 from nucleus import Slice, NucleusClient, DatasetItem, BoxAnnotation
 from nucleus.constants import (
     ANNOTATIONS_KEY,
@@ -170,7 +171,7 @@ def test_slice_send_to_labeling(dataset):
 
     # Slice creation
     slc = dataset.create_slice(
-        name=TEST_SLICE_NAME,
+        name=(TEST_SLICE_NAME + str(uuid.uuid4())[-10:]),
         reference_ids=[ds_items[0].reference_id, ds_items[1].reference_id],
     )