MODEL-1448: Upsert label feedback method

Author: dubininsergey

libs/labelbox/src/labelbox/__init__.py

@@ -36,6 +36,7 @@
 from labelbox.schema.slice import Slice, CatalogSlice, ModelSlice
 from labelbox.schema.queue_mode import QueueMode
 from labelbox.schema.task_queue import TaskQueue
+from labelbox.schema.label_score import LabelScore
 from labelbox.schema.identifiables import UniqueIds, GlobalKeys, DataRowIds
 from labelbox.schema.identifiable import UniqueId, GlobalKey
 from labelbox.schema.ontology_kind import OntologyKind

libs/labelbox/src/labelbox/client.py

@@ -2216,3 +2216,27 @@ def get_embedding_by_name(self, name: str) -> Embedding:
                 return e
         raise labelbox.exceptions.ResourceNotFoundError(Embedding,
                                                         dict(name=name))
+
+    def upsert_label_feedback(self, label_id: str, feedback: str,
+                              scores: Dict[str, float]) -> Entity.Label:
+        """
+
+        Args:
+            label_id: Target label ID
+            feedback: Free text comment regarding the label
+            scores: A dict of scores, the key is a score name and the value is the score value
+        Returns: A list of LabelScore instances
+
+        """
+        mutation_str = """mutation UpsertAutoQaLabelFeedbackPyApi($labelId: ID!, $feedback: String!, $scores: Json!){
+            upsertAutoQaLabelFeedback(input: {labelId: $labelId, feedback: $feedback, scores: $scores}) { id scores {id name score} }
+        }
+        """
+        res = self.execute(mutation_str, {
+            "labelId": label_id,
+            "feedback": feedback,
+            "scores": scores
+        })
+        scores_raw = res["upsertAutoQaLabelFeedback"]["scores"]
+
+        return [Entity.LabelScore(self, x) for x in scores_raw]

libs/labelbox/src/labelbox/orm/model.py

@@ -382,6 +382,7 @@ class Entity(metaclass=EntityMeta):
         CatalogSlice: Type[labelbox.CatalogSlice]
         ModelSlice: Type[labelbox.ModelSlice]
         TaskQueue: Type[labelbox.TaskQueue]
+        LabelScore: Type[labelbox.LabelScore]
 
     @classmethod
     def _attributes_of_type(cls, attr_type):

libs/labelbox/src/labelbox/schema/label_score.py

@@ -0,0 +1,19 @@
+from labelbox.orm.db_object import DbObject
+from labelbox.orm.model import Field
+
+
+class LabelScore(DbObject):
+    """
+    a label score
+
+    Attributes
+    name
+    score
+
+    """
+
+    name = Field.String("name")
+    data_row_count = Field.Float("score")
+
+    def __init__(self, client, *args, **kwargs):
+        super().__init__(client, *args, **kwargs)

libs/labelbox/tests/integration/test_label.py

@@ -1,7 +1,7 @@
 import time
 
+from labelbox import Client
 import pytest
-import requests
 import os
 
 from labelbox import Label
@@ -29,11 +29,13 @@ def test_labels(configured_project_with_label):
 
 
 # TODO: Skipping this test in staging due to label not updating
-@pytest.mark.skipif(condition=os.environ['LABELBOX_TEST_ENVIRON'] == "onprem" or
-                    os.environ['LABELBOX_TEST_ENVIRON'] == "staging" or
-                    os.environ['LABELBOX_TEST_ENVIRON'] == "local" or
-                    os.environ['LABELBOX_TEST_ENVIRON'] == "custom",
-                    reason="does not work for onprem")
+@pytest.mark.skipif(
+    condition=os.environ["LABELBOX_TEST_ENVIRON"] == "onprem"
+    or os.environ["LABELBOX_TEST_ENVIRON"] == "staging"
+    or os.environ["LABELBOX_TEST_ENVIRON"] == "local"
+    or os.environ["LABELBOX_TEST_ENVIRON"] == "custom",
+    reason="does not work for onprem",
+)
 def test_label_update(configured_project_with_label):
     _, _, _, label = configured_project_with_label
     label.update(label="something else")
@@ -57,7 +59,7 @@ def test_label_bulk_deletion(configured_project_with_label):
     project, _, _, _ = configured_project_with_label
 
     for _ in range(2):
-        #only run twice, already have one label in the fixture
+        # only run twice, already have one label in the fixture
         project.create_label()
     labels = project.labels()
     l1 = next(labels)
@@ -74,3 +76,15 @@ def test_label_bulk_deletion(configured_project_with_label):
     time.sleep(5)
 
     assert set(project.labels()) == {l2}
+
+
+def test_upsert_label_scores(configured_project_with_label, client: Client):
+    project, _, _, _ = configured_project_with_label
+
+    label = next(project.labels())
+
+    scores = client.upsert_label_feedback(
+        label_id=label.uid, feedback="That's a great label!", scores={"overall": 5}
+    )
+    assert len(scores) == 1
+    assert scores[0].score == 5