More validations

Author: Val Brodsky

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

@@ -25,8 +25,8 @@ class NoFactualInformationStepActions(Enum):
 @dataclass
 class FactCheckingVariants:
     """
-    List of possible fact checking variants (options)
-    Note variant kinds can not be changed
+    This class is used to define the possible options for fact-checking a step
+    NOTE do not change steps directly
     """
 
     accurate_step: Variant = field(
@@ -123,13 +123,18 @@ def from_dict(cls, dictionary: List[Dict[str, Any]]):
             no_factual_information_step=no_factual_information_step,  # type: ignore
         )
 
+
 @dataclass
 class FactCheckingDefinition:
     variants: FactCheckingVariants = field(default_factory=FactCheckingVariants)
     version: int = field(default=1)
     title: Optional[str] = None
     value: Optional[str] = None
 
+    def __post_init__(self):
+        if self.version != 1:
+            raise ValueError("Invalid version")
+
     def asdict(self) -> Dict[str, Any]:
         result = {"variants": self.variants.asdict(), "version": self.version}
         if self.title is not None:
@@ -167,6 +172,9 @@ def __post_init__(self):
             "This feature is experimental and subject to change.",
         )
 
+        if self.name.strip() == "":
+            raise ValueError("Name cannot be empty")
+
     def set_unsupported_step_actions(
         self, actions: List[UnsupportedStepActions]
     ) -> None:

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

@@ -77,6 +77,10 @@ class StepReasoningDefinition:
     title: Optional[str] = None
     value: Optional[str] = None
 
+    def __post_init__(self):
+        if self.version != 1:
+            raise ValueError("Invalid version")
+
     def asdict(self) -> Dict[str, Any]:
         result = {"variants": self.variants.asdict(), "version": self.version}
         if self.title is not None:
@@ -115,9 +119,14 @@ def __post_init__(self):
             "This feature is experimental and subject to change.",
         )
 
+        if not self.name.strip():
+            raise ValueError("Name is required")
+
     def set_incorrect_step_actions(self, actions: List[IncorrectStepActions]):
         """
         For live models, will invoke the model to generate alternatives if a step is marked as incorrect
+        NOTE by default all actions are set to True
+        Pass empty list to reset to false
         """
         actions_values = [action.value for action in actions]
         self.definition.variants.incorrect_step.set_actions(actions_values)

libs/labelbox/tests/unit/test_unit_step_reasoning_tool.py

@@ -1,9 +1,16 @@
+import pytest
+
 from labelbox.schema.tool_building.step_reasoning_tool import (
     IncorrectStepActions,
     StepReasoningTool,
 )
 
 
+def test_validations():
+    with pytest.raises(ValueError):
+        StepReasoningTool(name="")
+
+
 def test_step_reasoning_as_dict_default():
     tool = StepReasoningTool(name="step reasoning")
     assert tool.asdict() == {