NamedEntityRecognitionRelationshipDefinition

NamedEntityRecognitionRelationshipDefinition objects specify the types of relationship that can exist between two text spans.

A relationship can either be named or unnamed. A named relationship is useful if you need to distinguish between multiple types of relationship that could exist between the same two text spans. For instance, if you're annotating a description of someone's family history, you might want to distinguish a "child of" relationship from a "sibling of" relationship.

A task can only specify one type of relationship. Either all the relationships in a task must be named, or all must be unnamed.

Parameter	Type	Default	Description
name	string		A unique identifier for this type of relationship. Required for named relationships; disallowed for unnamed relationships.
display_name	string		A description for this relationship to display to taskers. Should be able to be used to construct a short phrase describing the relationship. For example, a relationship between two text spans "A" and "B" with `display_name` "is parent of" would be rendered to taskers as "A is parent of B". Required for named relationships; disallowed for unnamed relationships.
is_directed	boolean	false	A field indicating whether the directionality of this relationship matters. For example, a "is parent of" relationship would likely be directed, whereas a "is sibling of" relationship would likely not be directed. Optional for named relationships; disallowed for unnamed relationships.
source_label	string		A string referencing the `name` field of a `NamedEntityRecognitionLabel` object. If set, mandates that the source text span of this field must be labeled with the corresponding `NamedEntityRecognitionLabel`, or one of its `children`. Optional for both named and unnamed relationships.
target_label	string		A string referencing the `name` field of a `NamedEntityRecognitionLabel` object. If set, mandates that the target text span of this field must be labeled with the corresponding `NamedEntityRecognitionLabel`, or one of its `children`. Optional for both named and unnamed relationships.