updated set_scores logic

Author: Narek Mkhitaryan

src/superannotate/lib/app/interface/sdk_interface.py

@@ -758,6 +758,11 @@ def get_user_scores(
             ]
         """
         project, folder = self.controller.get_project_folder(project)
+        if project.type != ProjectType.MULTIMODAL:
+            raise AppException(
+                "This function is only supported for Multimodal projects."
+            )
+
         item = self.controller.get_item(project=project, folder=folder, item=item)
         response = BaseSerializer.serialize_iterable(
             self.controller.work_management.get_user_scores(
@@ -789,7 +794,7 @@ def set_user_scores(
         :type scored_user: str
 
         :param scores: A list of dictionaries containing the following key-value pairs:
-                * **name** (*str*): The name of the score (required).
+                * **component_id** (*str*): The component_id of the score (required).
                 * **value** (*Any*): The score value (required).
                 * **weight** (*Union[float, int]*, optional): The weight of the score. Defaults to `1` if not provided.
 
@@ -798,7 +803,7 @@ def set_user_scores(
 
                 scores = [
                     {
-                        "name": "Speed",  # str (required)
+                        "component_id": "<component_id_for_score>",  # str (required)
                         "value": 90,      # Any (required)
                         "weight": 1       # Union[float, int] (optional, defaults to 1.0 if not provided)
                     }
@@ -813,20 +818,27 @@ def set_user_scores(
                 item_=12345,
                 scored_user="example@superannotate.com",
                 scores=[
-                    {"name": "Speed", "value": 90},
-                    {"name": "Accuracy", "value": 9, "weight": 4.0},
-                    {"name": "Attention to Detail", "value": None, "weight": None},
+                    {"component_id": "r_kfrp3n", "value": 90},
+                    {"component_id": "h_jbrp4v", "value": 9, "weight": 4.0},
+                    {"component_id": "m_kf8pss", "value": None, "weight": None},
                 ]
             )
 
         """
         project, folder = self.controller.get_project_folder(project)
+        if project.type != ProjectType.MULTIMODAL:
+            raise AppException(
+                "This function is only supported for Multimodal projects."
+            )
         item = self.controller.get_item(project=project, folder=folder, item=item)
+        editor_template = self.controller.projects.get_editor_template(project.id)
+        components = editor_template.get("components", [])
         self.controller.work_management.set_user_scores(
             project=project,
             item=item,
             scored_user=scored_user,
             scores=scores,
+            components=components,
         )
         logger.info("Scores successfully set.")
 
@@ -879,7 +891,7 @@ def retrieve_context(
                 "This function is only supported for Multimodal projects."
             )
 
-        editor_template = self.controller.projects.get_editor_template(project)
+        editor_template = self.controller.projects.get_editor_template(project.id)
         components = editor_template.get("components", [])
 
         _found, _context = retrieve_context(components, component_id)

src/superannotate/lib/core/entities/work_managament.py

@@ -184,7 +184,7 @@ class ScoreEntity(TimedBaseModel):
 
 
 class ScorePayloadEntity(BaseModel):
-    name: str
+    component_id: str
     value: Any
     weight: Optional[Union[float, int]] = 1.0
 

src/superannotate/lib/core/serviceproviders.py

@@ -234,7 +234,7 @@ def attach_editor_template(
 
     @abstractmethod
     def get_editor_template(
-        self, team: entities.TeamEntity, project: entities.ProjectEntity
+        self, organization_id: str, project_id: int
     ) -> ServiceResponse:
         raise NotImplementedError
 

src/superannotate/lib/infrastructure/controller.py

@@ -1,3 +1,4 @@
+import copy
 import io
 import logging
 import os
@@ -307,9 +308,7 @@ def get_user_scores(
         return scores
 
     @staticmethod
-    def _validate_scores(
-        scores: List[dict], all_score_names: List[str]
-    ) -> List[ScorePayloadEntity]:
+    def _validate_scores(scores: List[dict]) -> List[ScorePayloadEntity]:
         score_objects: List[ScorePayloadEntity] = []
 
         for s in scores:
@@ -322,53 +321,79 @@ def _validate_scores(
             except Exception:
                 raise AppException("Invalid Scores.")
 
-        # validate provided score names
-        provided_score_names = [s.name for s in score_objects]
-        if set(provided_score_names) - set(all_score_names):
-            raise AppException("Please provide valid score names.")
-
-        names = [score.name for score in score_objects]
-        if len(names) != len(set(names)):
-            raise AppException("Invalid Scores.")
+        component_ids = [score.component_id for score in score_objects]
+        if len(component_ids) != len(set(component_ids)):
+            raise AppException("Component IDs in scores data must be unique.")
         return score_objects
 
+    @staticmethod
+    def retrieve_scores(
+        components: List[dict], score_component_ids: List[str]
+    ) -> Dict[str, Dict]:
+        score_component_ids = copy.copy(score_component_ids)
+        found_scores = {}
+        try:
+
+            def _retrieve_score_recursive(
+                all_components: List[dict], component_ids: List[str]
+            ):
+                for component in all_components:
+                    if "children" in component:
+                        _retrieve_score_recursive(component["children"], component_ids)
+                    if "scoring" in component and component["id"] in component_ids:
+                        component_ids.remove(component["id"])
+                        found_scores[component["id"]] = {
+                            "score_id": component["scoring"]["id"],
+                            "user_role_name": component["scoring"]["role"]["name"],
+                            "user_role": component["scoring"]["role"]["id"],
+                        }
+
+            _retrieve_score_recursive(components, score_component_ids)
+        except KeyError:
+            raise AppException("An error occurred while parsing the editor template.")
+        return found_scores
+
     def set_user_scores(
         self,
         project: ProjectEntity,
         item: BaseItemEntity,
         scored_user: str,
         scores: List[Dict[str, Any]],
+        components: List[dict],
     ):
-        users = self.list_users(project=project, email=scored_user)
+        users = self.list_users(email=scored_user)
         if not users:
             raise AppException("User not found.")
         user = users[0]
-        role_id = user.role
-        role_name = self.service_provider.get_role_name(project, int(role_id))
-
-        score_name_field_options_map = {
-            s.name: s for s in self.service_provider.work_management.list_scores().data
-        }
 
         # get validate scores
-        scores: List[ScorePayloadEntity] = self._validate_scores(
-            scores, list(score_name_field_options_map.keys())
+        scores: List[ScorePayloadEntity] = self._validate_scores(scores)
+
+        provided_score_component_ids = [s.component_id for s in scores]
+        component_id_score_data_map = self.retrieve_scores(
+            components, provided_score_component_ids
         )
 
-        scores_to_create: List[dict] = []
+        if len(component_id_score_data_map) != len(scores):
+            raise AppException("Invalid component_id provided")
+
+        scores_to_set: List[dict] = []
         for s in scores:
-            score_to_create = {
+            score_data = {
                 "item_id": item.id,
-                "score_id": score_name_field_options_map[s.name].id,
-                "user_role_name": role_name,
-                "user_role": role_id,
+                "score_id": component_id_score_data_map[s.component_id]["score_id"],
+                "user_role_name": component_id_score_data_map[s.component_id][
+                    "user_role_name"
+                ],
+                "user_role": component_id_score_data_map[s.component_id]["user_role"],
                 "user_id": user.email,
                 "value": s.value,
                 "weight": s.weight,
+                "component_id": s.component_id,
             }
-            scores_to_create.append(score_to_create)
+            scores_to_set.append(score_data)
         res = self.service_provider.telemetry_scoring.set_score_values(
-            project_id=project.id, data=scores_to_create
+            project_id=project.id, data=scores_to_set
         )
         if res.status_code == 400:
             res.res_error = "Please provide valid score values."
@@ -533,9 +558,10 @@ def upload_priority_scores(
         )
         return use_case.execute()
 
-    def get_editor_template(self, project: ProjectEntity) -> dict:
+    @timed_lru_cache(seconds=5)
+    def get_editor_template(self, project_id: int) -> dict:
         response = self.service_provider.projects.get_editor_template(
-            team=self._team, project=project
+            organization_id=self._team.owner_id, project_id=project_id
         )
         response.raise_for_status()
         return response.data

src/superannotate/lib/infrastructure/services/project.py

@@ -49,12 +49,10 @@ def attach_editor_template(
             url, "post", data=template, content_type=ServiceResponse, params=params
         )
 
-    def get_editor_template(
-        self, team: entities.TeamEntity, project: entities.ProjectEntity
-    ) -> bool:
-        url = self.URL_EDITOR_TEMPLATE.format(project_id=project.id)
+    def get_editor_template(self, organization_id: str, project_id: int) -> bool:
+        url = self.URL_EDITOR_TEMPLATE.format(project_id=project_id)
         params = {
-            "organization_id": team.owner_id,
+            "organization_id": organization_id,
         }
         return self.client.request(
             url, "get", content_type=ServiceResponse, params=params

tests/data_set/editor_templates/form_with_scores.json

@@ -0,0 +1,146 @@
+{
+  "components": [
+    {
+      "id": "component_id_0",
+      "type": "select",
+      "permissions": [],
+      "hasTooltip": false,
+      "label": "Select",
+      "isRequired": false,
+      "value": [],
+      "exclude": false,
+      "disablePasting": false,
+      "options": [
+        {
+          "value": "Partially complete, needs review",
+          "checked": false
+        },
+        {
+          "value": "Incomplete",
+          "checked": false
+        },
+        {
+          "value": "Complete",
+          "checked": false
+        },
+        {
+          "value": "4",
+          "checked": false
+        }
+      ],
+      "isMultiselect": true,
+      "placeholder": "Select"
+    },
+    {
+      "id": "component_id_1",
+      "type": "input",
+      "permissions": [],
+      "hasTooltip": false,
+      "label": "Text input",
+      "isRequired": false,
+      "value": "",
+      "exclude": false,
+      "disablePasting": false,
+      "placeholder": "Placeholder",
+      "min": 0,
+      "max": 300
+    },
+    {
+      "id": "component_id_2",
+      "type": "number",
+      "permissions": [],
+      "hasTooltip": false,
+      "label": "Number",
+      "isRequired": false,
+      "value": null,
+      "exclude": false,
+      "disablePasting": false,
+      "min": null,
+      "max": null,
+      "step": 1
+    },
+    {
+      "id": "r_34k7k7",
+      "type": "rating",
+      "permissions": [],
+      "hasTooltip": false,
+      "scoring": {
+        "id": null,
+        "role": {
+          "id": 1,
+          "name": "Annotator"
+        },
+        "name": "SDK-my-score-1"
+      },
+      "label": "SDK-my-score-1",
+      "isRequired": false,
+      "value": null,
+      "exclude": false,
+      "disablePasting": false,
+      "numberOfStars": 10
+    },
+    {
+      "id": "r_ioc7wd",
+      "type": "number",
+      "permissions": [],
+      "hasTooltip": false,
+      "scoring": {
+        "id": null,
+        "role": {
+          "id": 1,
+          "name": "Annotator"
+        },
+        "name": "SDK-my-score-2"
+      },
+      "label": "SDK-my-score-2",
+      "isRequired": false,
+      "value": null,
+      "exclude": false,
+      "disablePasting": false,
+      "min": 1,
+      "max": 100,
+      "step": 1
+    },
+    {
+      "id": "r_tcof7o",
+      "type": "radio",
+      "permissions": [],
+      "hasTooltip": false,
+      "scoring": {
+        "id": null,
+        "role": {
+          "id": 1,
+          "name": "Annotator"
+        },
+        "name": "SDK-my-score-3"
+      },
+      "label": "SDK-my-score-3",
+      "isRequired": false,
+      "value": "",
+      "exclude": false,
+      "disablePasting": false,
+      "options": [
+        {
+          "value": "1",
+          "checked": null
+        },
+        {
+          "value": "2",
+          "checked": null
+        },
+        {
+          "value": "3",
+          "checked": null
+        }
+      ],
+      "layout": "column"
+    }
+  ],
+  "code": [
+    [
+      "__init__",
+      "from typing import List, Union\n# import requests.asyncs as requests\nimport requests\nimport sa\n\nnumber_component_id_2 = ['component_id_2']\nselect_component_id_0 = ['component_id_0']\ninput_component_id_1 = ['component_id_1']\n\ndef before_save_hook(old_status: str, new_status: str) -> bool:\n    # Your code goes here\n    return\n\ndef on_saved_hook():\n    # Your code goes here\n    return\n\ndef before_status_change_hook(old_status: str, new_status: str) -> bool:\n    # Your code goes here\n    return\n\ndef on_status_changed_hook(old_status: str, new_status: str):\n    # Your code goes here\n    return\n\ndef post_hook():\n    # Your code goes here\n    return\n\ndef on_component_id_2_change(path: List[Union[str, int]], value):\n    # The path is a list of strings and integers, the length of which is always an odd number and not less than 1.\n    # The last value is the identifier of the form element and the pairs preceding it are\n    # the group identifiers and the subgroup index, respectively\n    # value is current value of the form element\n\n    # Your code goes here\n    return\n\ndef on_component_id_0_change(path: List[Union[str, int]], value):\n    # The path is a list of strings and integers, the length of which is always an odd number and not less than 1.\n    # The last value is the identifier of the form element and the pairs preceding it are\n    # the group identifiers and the subgroup index, respectively\n    # value is current value of the form element\n\n    # Your code goes here\n    return\n\ndef on_component_id_1_change(path: List[Union[str, int]], value):\n    # The path is a list of strings and integers, the length of which is always an odd number and not less than 1.\n    # The last value is the identifier of the form element and the pairs preceding it are\n    # the group identifiers and the subgroup index, respectively\n    # value is current value of the form element\n\n    # Your code goes here\n    return\n"
+    ]
+  ],
+  "environments": []
+}