Add file_delete method to delete experiment file (#101)

* Implement file_delete

* Add confirmation prompt and error handling to file_delete

* Add release note

* Apply suggestions from code review

Co-authored-by: Helena Zhang <Helena.Zhang@ibm.com>

* Apply suggestions from code review

---------

Co-authored-by: Helena Zhang <Helena.Zhang@ibm.com>

Author: 1d4n

qiskit_ibm_experiment/client/experiment.py

@@ -345,6 +345,15 @@ def experiment_file_download(
         """
         return self.api.file_download(experiment_id, file_name, json_decoder)
 
+    def experiment_file_delete(self, experiment_id: str, file_name: str):
+        """Deletes a data file from the DB
+
+        Args:
+            experiment_id: Experiment ID.
+            file_name: The path of the data file to delete.
+        """
+        return self.api.file_delete(experiment_id, file_name)
+
     def device_components(self, backend_name: Optional[str]) -> List[Dict]:
         """Return device components for the backend.
 

qiskit_ibm_experiment/client/experiment_rest_adapter.py

@@ -37,6 +37,7 @@ class ExperimentRestAdapter:
         "files": "/experiments/{uuid}/files",
         "files_upload": "/experiments/{uuid}/files/upload/{path}",
         "files_download": "/experiments/{uuid}/files/{path}",
+        "files_delete": "/experiments/{uuid}/files/{path}",
     }
 
     _HEADER_JSON_CONTENT = {"Content-Type": "application/json"}
@@ -462,3 +463,13 @@ def file_download(
                 return result.json(cls=json_decoder)
             return result.content
         return result
+
+    def file_delete(self, experiment_id: str, file_name: str):
+        """Deletes a file from the DB
+        Args:
+            experiment_id: Experiment ID.
+            file_name: The path of the data file to delete.
+        """
+        url = self.get_url("files_delete")
+        url = url.format(uuid=experiment_id, path=file_name)
+        self.session.delete(url)

qiskit_ibm_experiment/service/ibm_experiment_service.py

@@ -1742,6 +1742,31 @@ def file_download(
         )
         return file_data
 
+    def file_delete(self, experiment_id: str, file_name: str):
+        """Deletes a data file from the DB
+
+        Note:
+            This method prompts for confirmation and requires a response before proceeding.
+
+        Args:
+            experiment_id: The experiment the data file belongs to.
+            file_name: The path of the data file to delete.
+
+        Raises:
+            IBMApiError: If the request to the server failed.
+        """
+        if not self._confirm_delete(
+            "Are you sure you want to delete the experiment file? [y/N]: "
+        ):
+            return
+        try:
+            self._api_client.experiment_file_delete(experiment_id, file_name)
+        except RequestsApiError as api_err:
+            if api_err.status_code == 404:
+                logger.warning("File %s not found.", file_name)
+            else:
+                raise IBMApiError(f"Failed to process the request: {api_err}") from None
+
     def experiment_has_file(self, experiment_id: str, file_name: str) -> bool:
         """Checks whether a specific expriment has a specific file
         Args:

releasenotes/notes/file-delete-4ca0baa574907813.yaml

@@ -0,0 +1,5 @@
+---
+
+features:
+  - |
+    Added the :meth:`~IBMExperimentService.file_delete` method to delete experiment artifacts.