Add a 'run_dataset_recommendation' method

Author: julienr

src/picterra/client.py

@@ -833,6 +833,21 @@ def train_detector(self, detector_id):
             raise APIError(resp.text)
         return self._wait_until_operation_completes(resp.json())
 
+    def run_dataset_recommendation(self, detector_id):
+        """
+        This is an **experimental** feature
+
+        Runs dataset recommendation on a detector. Note that you currently have to use
+        the UI to be able to view the recommendation markers/report.
+
+        Args:
+            detector_id (str): The id of the detector
+        """
+        resp = self.sess.post(self._api_url("detectors/%s/dataset_recommendation/" % detector_id))
+        if not resp.ok:
+            raise APIError(resp.text)
+        return self._wait_until_operation_completes(resp.json())
+
     def run_advanced_tool(self, tool_id: UUID, inputs: dict, outputs: dict):
         """
         This is an experimental feature

tests/test_client.py

@@ -202,6 +202,9 @@ def add_mock_detector_edit_response(d_id, **kwargs):
 def add_mock_detector_train_responses(detector_id):
     _add_api_response("detectors/%s/train/" % detector_id, responses.POST, OP_RESP)
 
+def add_mock_run_dataset_recommendation_responses(detector_id):
+    _add_api_response("detectors/%s/dataset_recommendation/" % detector_id, responses.POST, OP_RESP)
+
 
 def add_mock_operations_responses(status, **kwargs):
     data = {"type": "mock_operation_type", "status": status}
@@ -876,6 +879,18 @@ def test_train_detector():
     assert len(responses.calls) == 4
 
 
+@responses.activate
+def test_run_dataset_recommendation():
+    add_mock_run_dataset_recommendation_responses(1)
+    add_mock_operations_responses("running")
+    add_mock_operations_responses("running")
+    add_mock_operations_responses("success")
+    client = _client()
+    op = client.run_dataset_recommendation(1)
+    assert op["status"] == "success"
+    assert len(responses.calls) == 4
+
+
 @pytest.mark.parametrize(("name", "color"), ((None, None), ("foobar", "#aabbcc")))
 @responses.activate
 def test_upload_vector_layer(name, color):