Add source_ontology_name with validators

Author: kvilon

libs/labelbox/src/labelbox/data/annotation_types/relationship.py

@@ -14,7 +14,8 @@ class Type(Enum):
         UNIDIRECTIONAL = "unidirectional"
         BIDIRECTIONAL = "bidirectional"
 
-    source: Union[ObjectAnnotation, ClassificationAnnotation]
+    source: Optional[Union[ObjectAnnotation, ClassificationAnnotation]] = None
+    source_ontology_name: Optional[str] = None
     target: ObjectAnnotation
     type: Type = Type.UNIDIRECTIONAL
     readonly: Optional[bool] = None
@@ -27,6 +28,18 @@ def check_readonly(self):
             )
         return self
 
+    @model_validator(mode="after")
+    def validate_source_fields(self):
+        if self.source is None and self.source_ontology_name is None:
+            raise ValueError("Either source or source_ontology_name must be provided")
+        return self
+
+    @model_validator(mode="after")
+    def validate_source_consistency(self):
+        if self.source is not None and self.source_ontology_name is not None:
+            raise ValueError("Only one of 'source' or 'source_ontology_name' may be provided")
+        return self
+
 
 class RelationshipAnnotation(BaseAnnotation):
     value: Relationship

libs/labelbox/src/labelbox/data/serialization/ndjson/label.py

@@ -209,6 +209,8 @@ def _create_relationship_annotations(
                     - For other target annotations: source must be ObjectAnnotation
                 - Target:
                     - Target must always be ObjectAnnotation
+            ValueError: If relationship validation fails:
+                - For PDF target annotations: either source or source_ontology_name must be provided
         """
         for annotation in label.annotations:
             if isinstance(annotation, RelationshipAnnotation):
@@ -221,13 +223,17 @@ def _create_relationship_annotations(
                 if isinstance(
                     target.value, (DocumentRectangle, DocumentEntity)
                 ):
-                    if not isinstance(
+                    if source is not None and not isinstance(
                         source, (ObjectAnnotation, ClassificationAnnotation)
                     ):
                         raise TypeError(
                             f"Unable to create relationship with invalid source. For PDF targets, "
                             f"source must be ObjectAnnotation or ClassificationAnnotation. Got: {type(source)}"
                         )
+                    if source is None and annotation.value.source_ontology_name is None:
+                        raise ValueError(
+                            "Unable to create relationship - either source or source_ontology_name must be provided"
+                        )
                 elif not isinstance(source, ObjectAnnotation):
                     raise TypeError(
                         f"Unable to create relationship with non ObjectAnnotation source: {type(source)}"
@@ -239,7 +245,7 @@ def _create_relationship_annotations(
                         f"Unable to create relationship with non ObjectAnnotation target: {type(target)}"
                     )
 
-                if not source._uuid:
+                if source is not None and not source._uuid:
                     source._uuid = uuid1
                 if not target._uuid:
                     target._uuid = uuid2

libs/labelbox/src/labelbox/data/serialization/ndjson/relationship.py

@@ -11,10 +11,11 @@
 
 
 class _Relationship(BaseModel):
-    source: str
+    source: Optional[str] = None
     target: str
     type: str
     readonly: Optional[bool] = None
+    sourceOntologyName: Optional[str] = None
 
 
 class NDRelationship(NDAnnotation):
@@ -25,11 +26,13 @@ def to_common(
         annotation: "NDRelationship",
         source: SUPPORTED_ANNOTATIONS,
         target: SUPPORTED_ANNOTATIONS,
+        source_ontology_name: Optional[str] = None,
     ) -> RelationshipAnnotation:
         return RelationshipAnnotation(
             name=annotation.name,
             value=Relationship(
                 source=source,
+                source_ontology_name=source_ontology_name,
                 target=target,
                 type=Relationship.Type(annotation.relationship.type),
                 readonly=annotation.relationship.readonly,
@@ -50,8 +53,9 @@ def from_common(
             name=annotation.name,
             dataRow=DataRow(id=data.uid, global_key=data.global_key),
             relationship=_Relationship(
-                source=str(relationship.source._uuid),
+                source=str(relationship.source._uuid) if relationship.source else None,
                 target=str(relationship.target._uuid),
+                sourceOntologyName=relationship.source_ontology_name,
                 type=relationship.type.value,
                 readonly=relationship.readonly,
             ),