Make variants internal

Author: Val Brodsky

libs/labelbox/src/labelbox/schema/tool_building/fact_checking_tool.py

@@ -26,7 +26,7 @@ class NoFactualInformationStepActions(Enum):
 class FactCheckingVariants:
     """
     This class is used to define the possible options for fact-checking a step
-    NOTE do not change steps directly
+    NOTE do not change the variants directly
     """
 
     accurate_step: Variant = field(

libs/labelbox/src/labelbox/schema/tool_building/step_reasoning_tool.py

@@ -17,6 +17,7 @@ class StepReasoningVariants:
     """
     This class is used to define the possible options for evaluating a step
     Currently the options are correct, neutral, and incorrect
+    NOTE: do not change the variant values
     """
 
     correct_step: Variant = field(
@@ -33,7 +34,10 @@ class StepReasoningVariants:
             _available_actions={
                 action.value for action in IncorrectStepActions
             },
-            actions=["regenerateSteps"],  # regenerateSteps is on by default
+            actions=[
+                IncorrectStepActions.REGENERATE_STEPS.value,
+                IncorrectStepActions.GENERATE_AND_RATE_ALTERNATIVE_STEPS.value,
+            ],  # action On by default
         )
     )
 
@@ -102,6 +106,8 @@ class StepReasoningTool:
     """
     Use this class in OntologyBuilder to create a tool for step reasoning
     The definition field lists the possible options to evaulate a step
+
+    NOTE: color attribute is for backward compatibility only and should not be set directly
     """
 
     name: str

libs/labelbox/src/labelbox/schema/tool_building/variant.py

@@ -16,9 +16,7 @@ def asdict(self) -> Dict[str, Any]:
 
 
 @dataclass
-class VariantWithActions:
-    id: int
-    name: str
+class VariantWithActions(Variant):
     actions: List[str] = field(default_factory=list)
     _available_actions: Set[str] = field(default_factory=set)
 
@@ -32,11 +30,7 @@ def reset_actions(self) -> None:
         self.actions = []
 
     def asdict(self) -> Dict[str, Any]:
-        data = {
-            "id": self.id,
-            "name": self.name,
-        }
-        if len(self.actions) > 0:
-            data["actions"] = self.actions
+        data = super().asdict()
+        data["actions"] = self.actions
 
         return data

libs/labelbox/tests/integration/test_ontology.py

@@ -340,7 +340,7 @@ def test_step_reasoning_ontology(chat_evaluation_ontology):
         {
             "id": 2,
             "name": "Incorrect",
-            "actions": ["regenerateSteps"],
+            "actions": ["regenerateSteps", "generateAndRateAlternativeSteps"],
         },
     ]
     assert step_reasoning_tool["definition"]["version"] == 1
@@ -365,7 +365,7 @@ def test_step_reasoning_ontology(chat_evaluation_ontology):
         {
             "id": 2,
             "name": "Incorrect",
-            "actions": ["regenerateSteps"],
+            "actions": ["regenerateSteps", "generateAndRateAlternativeSteps"],
         },
     ]
 

libs/labelbox/tests/unit/test_unit_fact_checking_tool.py

@@ -1,5 +1,4 @@
 from labelbox.schema.tool_building.fact_checking_tool import FactCheckingTool
-from labelbox.schema.tool_building.step_reasoning_tool import StepReasoningTool
 
 
 def test_fact_checking_as_dict_default():
@@ -20,9 +19,21 @@ def test_fact_checking_as_dict_default():
                 {"id": 0, "name": "Accurate"},
                 {"id": 1, "name": "Inaccurate"},
                 {"id": 2, "name": "Disputed"},
-                {"id": 3, "name": "Unsupported", "actions": []},
-                {"id": 4, "name": "Can't confidently assess", "actions": []},
-                {"id": 5, "name": "No factual information", "actions": []},
+                {
+                    "id": 3,
+                    "name": "Unsupported",
+                    "actions": ["writeJustification"],
+                },
+                {
+                    "id": 4,
+                    "name": "Can't confidently assess",
+                    "actions": ["writeJustification"],
+                },
+                {
+                    "id": 5,
+                    "name": "No factual information",
+                    "actions": ["writeJustification"],
+                },
             ],
             "version": 1,
         },
@@ -33,9 +44,9 @@ def test_fact_checking_as_dict_default():
 
 def test_step_reasoning_as_dict_with_actions():
     tool = FactCheckingTool(name="Fact Checking Tool")
-    tool.set_unsupported_step_actions()
-    tool.set_cant_confidently_assess_step_actions()
-    tool.set_no_factual_information_step_actions()
+    tool.set_unsupported_step_actions([])
+    tool.set_cant_confidently_assess_step_actions([])
+    tool.set_no_factual_information_step_actions([])
 
     # Get the dictionary representation
     tool_dict = tool.asdict()
@@ -55,17 +66,17 @@ def test_step_reasoning_as_dict_with_actions():
                 {
                     "id": 3,
                     "name": "Unsupported",
-                    "actions": ["writeJustification"],
+                    "actions": [],
                 },
                 {
                     "id": 4,
                     "name": "Can't confidently assess",
-                    "actions": ["writeJustification"],
+                    "actions": [],
                 },
                 {
                     "id": 5,
                     "name": "No factual information",
-                    "actions": ["writeJustification"],
+                    "actions": [],
                 },
             ],
             "version": 1,

libs/labelbox/tests/unit/test_unit_step_ontology_variants.py

@@ -0,0 +1,18 @@
+from labelbox.schema.tool_building.variant import VariantWithActions
+
+
+def test_variant_with_actions_as_dict():
+    variant = VariantWithActions(
+        id=0, name="Correct", _available_actions={"regenerateSteps"}
+    )
+    variant.set_actions(["regenerateSteps"])
+    assert variant.asdict() == {
+        "id": 0,
+        "name": "Correct",
+        "actions": ["regenerateSteps"],
+    }
+    variant.reset_actions()
+    assert variant.asdict() == {
+        "id": 0,
+        "name": "Correct",
+    }

libs/labelbox/tests/unit/test_unit_step_reasoning_tool.py

@@ -1,7 +1,6 @@
 import pytest
 
 from labelbox.schema.tool_building.step_reasoning_tool import (
-    IncorrectStepActions,
     StepReasoningTool,
 )
 
@@ -26,7 +25,10 @@ def test_step_reasoning_as_dict_default():
                 {
                     "id": 2,
                     "name": "Incorrect",
-                    "actions": ["regenerateSteps"],
+                    "actions": [
+                        "regenerateSteps",
+                        "generateAndRateAlternativeSteps",
+                    ],
                 },
             ],
             "version": 1,
@@ -36,12 +38,7 @@ def test_step_reasoning_as_dict_default():
 
 def test_step_reasoning_as_dict_with_actions():
     tool = StepReasoningTool(name="step reasoning")
-    tool.set_incorrect_step_actions(
-        [
-            IncorrectStepActions.REGENERATE_STEPS,
-            IncorrectStepActions.GENERATE_AND_RATE_ALTERNATIVE_STEPS,
-        ]
-    )
+    tool.set_incorrect_step_actions([])
     assert tool.asdict() == {
         "tool": "step-reasoning",
         "name": "step reasoning",