[PTDT-2863]: Feature schema attributes

libs/labelbox/src/labelbox/schema/ontology.py

@@ -25,6 +25,7 @@
 from labelbox.schema.tool_building.tool_type_mapping import (
     map_tool_type_to_tool_cls,
 )
+from labelbox.schema.tool_building.types import FeatureSchemaAttributes
 
 
 class DeleteFeatureFromOntologyResult:
@@ -73,6 +74,7 @@ class Tool:
         classifications: (list)
         schema_id: (str)
         feature_schema_id: (str)
+        attributes: (list)
     """
 
     class Type(Enum):
@@ -95,6 +97,7 @@ class Type(Enum):
     classifications: List[Classification] = field(default_factory=list)
     schema_id: Optional[str] = None
     feature_schema_id: Optional[str] = None
+    attributes: Optional[FeatureSchemaAttributes] = None
 
     @classmethod
     def from_dict(cls, dictionary: Dict[str, Any]) -> Dict[str, Any]:
@@ -109,6 +112,7 @@ def from_dict(cls, dictionary: Dict[str, Any]) -> Dict[str, Any]:
                 for c in dictionary["classifications"]
             ],
             color=dictionary["color"],
+            attributes=dictionary.get("attributes", None),
         )
 
     def asdict(self) -> Dict[str, Any]:
@@ -122,6 +126,7 @@ def asdict(self) -> Dict[str, Any]:
             ],
             "schemaNodeId": self.schema_id,
             "featureSchemaId": self.feature_schema_id,
+            "attributes": self.attributes,
         }
 
     def add_classification(self, classification: Classification) -> None:

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

@@ -5,7 +5,10 @@
 
 from lbox.exceptions import InconsistentOntologyException
 
-from labelbox.schema.tool_building.types import FeatureSchemaId
+from labelbox.schema.tool_building.types import (
+    FeatureSchemaId,
+    FeatureSchemaAttributes,
+)
 
 
 @dataclass
@@ -42,6 +45,7 @@ class Classification:
         schema_id: (str)
         feature_schema_id: (str)
         scope: (str)
+        attributes: (list)
     """
 
     class Type(Enum):
@@ -70,6 +74,7 @@ class UIMode(Enum):
     ui_mode: Optional[UIMode] = (
         None  # How this classification should be answered (e.g. hotkeys / autocomplete, etc)
     )
+    attributes: Optional[FeatureSchemaAttributes] = None
 
     def __post_init__(self):
         if self.name is None:
@@ -88,6 +93,10 @@ def __post_init__(self):
         else:
             if self.instructions is None:
                 self.instructions = self.name
+        if self.attributes is not None:
+            warnings.warn(
+                "Attributes are an experimental feature and may change in the future."
+            )
 
     @classmethod
     def from_dict(cls, dictionary: Dict[str, Any]) -> "Classification":
@@ -103,6 +112,7 @@ def from_dict(cls, dictionary: Dict[str, Any]) -> "Classification":
             schema_id=dictionary.get("schemaNodeId", None),
             feature_schema_id=dictionary.get("featureSchemaId", None),
             scope=cls.Scope(dictionary.get("scope", cls.Scope.GLOBAL)),
+            attributes=dictionary.get("attributes", None),
         )
 
     def asdict(self, is_subclass: bool = False) -> Dict[str, Any]:
@@ -118,6 +128,9 @@ def asdict(self, is_subclass: bool = False) -> Dict[str, Any]:
             "options": [o.asdict() for o in self.options],
             "schemaNodeId": self.schema_id,
             "featureSchemaId": self.feature_schema_id,
+            "attributes": self.attributes
+            if self.attributes is not None
+            else None,
         }
         if (
             self.class_type == self.Type.RADIO

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

@@ -1,6 +1,17 @@
-from typing import Annotated
+from typing import Annotated, List
+from pydantic import Field, BaseModel
+from typing import TypedDict
 
-from pydantic import Field
+
+class FeatureSchemaAttribute(TypedDict):
+    attributeName: str
+    attributeValue: str
+
+
+FeatureSchemaAttriubte = Annotated[FeatureSchemaAttribute, Field()]
 
 FeatureSchemaId = Annotated[str, Field(min_length=25, max_length=25)]
 SchemaId = Annotated[str, Field(min_length=25, max_length=25)]
+FeatureSchemaAttributes = Annotated[
+    List[FeatureSchemaAttribute], Field(default_factory=list)
+]

libs/labelbox/tests/unit/test_unit_ontology.py

@@ -15,6 +15,7 @@
             "color": "#FF0000",
             "tool": "polygon",
             "classifications": [],
+            "attributes": None,
         },
         {
             "schemaNodeId": None,
@@ -24,6 +25,7 @@
             "color": "#FF0000",
             "tool": "superpixel",
             "classifications": [],
+            "attributes": None,
         },
         {
             "schemaNodeId": None,
@@ -32,6 +34,7 @@
             "name": "bbox",
             "color": "#FF0000",
             "tool": "rectangle",
+            "attributes": None,
             "classifications": [
                 {
                     "schemaNodeId": None,
@@ -56,6 +59,7 @@
                                     "name": "nested nested text",
                                     "type": "text",
                                     "options": [],
+                                    "attributes": None,
                                 }
                             ],
                         },
@@ -67,6 +71,7 @@
                             "options": [],
                         },
                     ],
+                    "attributes": None,
                 },
                 {
                     "schemaNodeId": None,
@@ -76,6 +81,7 @@
                     "name": "nested text",
                     "type": "text",
                     "options": [],
+                    "attributes": None,
                 },
             ],
         },
@@ -87,6 +93,7 @@
             "color": "#FF0000",
             "tool": "point",
             "classifications": [],
+            "attributes": None,
         },
         {
             "schemaNodeId": None,
@@ -96,6 +103,7 @@
             "color": "#FF0000",
             "tool": "line",
             "classifications": [],
+            "attributes": None,
         },
         {
             "schemaNodeId": None,
@@ -105,6 +113,7 @@
             "color": "#FF0000",
             "tool": "named-entity",
             "classifications": [],
+            "attributes": None,
         },
     ],
     "classifications": [
@@ -117,6 +126,7 @@
             "type": "radio",
             "scope": "global",
             "uiMode": "searchable",
+            "attributes": None,
             "options": [
                 {
                     "schemaNodeId": None,

libs/labelbox/tests/unit/test_unit_prompt_issue_tool.py

@@ -47,6 +47,7 @@ def test_as_dict():
                 "schemaNodeId": None,
                 "featureSchemaId": None,
                 "scope": "global",
+                "attributes": None,
             }
         ],
         "color": None,