Relationship

A Relationship is an Object-type annotation that allows you to connect two separate annotations.

Import

🚧
Not supported yet

Export

When you export your annotation Relationships from Labelbox, the export file will contain the following information for each Relationship.

Python SDK

Learn more about exporting annotations using the SDK here

JSON

You will receive a JSON file when you generate an export from the app.

Parameter	Asset type	Description
`featureId`	Text, Image	ID of the annotation relationship in the ontology.
`schemaId`	Text, Image	Schema ID of the annotation relationship in the ontology.
`title`	Text	Text that appears as the relationship name.
`value`	Text	Name of the relationship in the Labelbox database.
`data.label`	Text	Definition of the relationship. If there is no definition, this field will be blank.
`data.endFeatureId`	Text	Definition of the relationship. If there is no definition, this field will be blank.
`data.startFeatureId`	Text	ID that indicates where the relationship starts.
`format`	Text	Value should be unidirectional. Indicates that the arrow on the relationship is pointing in one direction.
`version`	Text, Image	Value is 1, which means this export is using the latest Labelbox export format.
`instanceURI`	Text	URL where you can access the annotation relationship stored in the Labelbox database.
`data.source`	Image	Feature ID of the annotation where the relationship starts.
`data.target`	Image	Feature ID of the annotation where the relationship ends.
`data.label`	Text	Optional field that will only be returned for text relationships with a label.
`relationshipType`	Image	Indicates whether the relationship is unidirectional or bidirectional.

Format

"relationships": [
     {
        "featureId":"cl12o1opb000g3g6acccvuqui",
        "schemaId":"cl12nq1ik004g0z4lf84q58rm",
        "data":
            {
            	"source":"cl12nurbd00013g6an63jifsv",
           	    "target":"cl12nv4ab00073g6as6jkwcj3",
                "label": "verb"
        		},
        "relationshipType":"unidirectional",
        "version": 1
    }
]

"relationships": [
 	 {
     	"featureId":"cl12o1opb000g3g6acccvuqui",
    	"schemaId":"cl12nq1ik004g0z4lf84q58rm",
    	"data":
    		{
        	"source":"cl12nurbd00013g6an63jifsv",
        	"target":"cl12nv4ab00073g6as6jkwcj3"
      	},
    	"relationshipType":"unidirectional",
    	"version": 1
  	}
]

"relationships":[
   {
      "featureId":"cl2zjivad00203g6ck8nk7jrt",
      "schemaId":"ckrdp1ln400003h6jq23cbjfl",
      "data":
         {
            "source":"cl2zji82m00043g6cunt8telp",
            "target":"cl2zjihh600053g6cztv2bblb",
            "label":"Person"
         },
      "relationshipType":"unidirectional",
      "version":1
   }
]

"relationships":[
   {
      "featureId":"cl3uaz2kn000p3f6crzl3qqww",
      "schemaId":"cl3n8b4oz51sc087jdrgl17q2",
      "data":
     		 {
            "source":"cl3uay4qj000i3f6c9jtvu2ab",
            "target":"cl3uaxxo2000f3f6cbselj2z3"
         },
      "relationshipType":"unidirectional",
      "version":1
   }
]