concrete.situations.ttypes module¶
-
class
concrete.situations.ttypes.
Argument
(role=None, entityId=None, situationId=None, propertyList=None)¶ Bases:
object
A situation argument, consisting of an argument role and a value.Argument values may be Entities or Situations.Attributes:- role: The relationship between this argument and the situation thatowns it. The roles that a situation’s arguments can takedepend on the type of the situation (including subtypeinformation, such as event_type).- entityId: A pointer to the value of this argument, if it is explicitlyencoded as an Entity.- situationId: A pointer to the value of this argument, if it is a situation.- propertyList: For the BinarySRL task, there may be situationswhere more than one property is attached to a singleparticipant. A list of these properties can be stored in this field.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
Justification
(justificationType=None, mentionId=None, tokenRefSeqList=None)¶ Bases:
object
Attributes:- justificationType: An enumerated value used to describe the way in which thejustification’s mention provides supporting evidence for thesituation.- mentionId: A pointer to the SituationMention itself.- tokenRefSeqList: An optional list of pointers to tokens that are (especially)relevant to the way in which this mention providesjustification for the situation. It is left up to individualanalytics to decide what tokens (if any) they wish to includein this field.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
MentionArgument
(role=None, entityMentionId=None, situationMentionId=None, tokens=None, constituent=None, confidence=None, propertyList=None)¶ Bases:
object
A “concrete” argument, that may be used by SituationMentions or EntityMentionsto avoid conflicts where abstract Arguments were being used to support concrete Mentions.Attributes:- role: The relationship between this argument and the situation thatowns it. The roles that a situation’s arguments can takedepend on the type of the situation (including subtypeinformation, such as event_type).- entityMentionId: A pointer to the value of an EntityMention, if this is being used to supportan EntityMention.- situationMentionId: A pointer to the value of this argument, if it is a SituationMention.- tokens: The location of this MentionArgument in the Communication.If this MentionArgument can be identified in a document using anEntityMention or SituationMention, then UUID references to thosetypes should be preferred and this field left as null.- constituent: An alternative way to specify the same thing as tokens.- confidence: Confidence of this argument belonging to its SituationMention- propertyList: For the BinarySRL task, there may be situationswhere more than one property is attached to a singleparticipant. A list of these properties can be stored in this field.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
Property
(value=None, metadata=None, polarity=None)¶ Bases:
object
Attached to Arguments to support situations wherea ‘participant’ has more than one ‘property’ (in BinarySRL terms),whereas Arguments notionally only support one Role.Attributes:- value: The required value of the property.- metadata: Metadata to support this particular property object.- polarity: This value is typically boolean, 0.0 or 1.0, but we use afloat in order to potentially capture cases where an annotator ishighly confident that the value is underspecified, via a value of0.5.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
Situation
(uuid=None, situationType=None, situationKind=None, argumentList=None, mentionIdList=None, justificationList=None, timeML=None, intensity=None, polarity=None, confidence=None)¶ Bases:
object
A single situation, along with pointers to situation mentions thatprovide evidence for the situation. “Situations” include events,relations, facts, sentiments, and beliefs. Each situation has acore type (such as EVENT or SENTIMENT), along with an optionalsubtype based on its core type (e.g., event_type=CONTACT_MEET), anda set of zero or more unordered arguments.This struct may be used for a variety of “processed” Situations suchas (but not limited to):- SituationMentions which have been collapsed into a coreferential cluster- Situations which are inferred and not directly supported by a textual mentionAttributes:- uuid: Unique identifier for this situation.- situationType: The core type of this situation (eg EVENT or SENTIMENT),or a coarse grain situation type.- situationKind: A fine grain situation type that specifically describes thesituation based on situationType above. It allows for moredetailed description of the situation.Some examples:if situationType == EVENT, the event type for the situationif situationType == STATE, the state typeif situationType == TEMPORAL_FACT, the temporal fact typeFor Propbank, this field should be the predicate lemma and id,e.g. “strike.02”. For FrameNet, this should be the frame name,e.g. “Commerce_buy”.Different and more varied situationTypes may be addedin the future.- argumentList: The arguments for this situation. Each argument consists of arole and a value. It is possible for an situation to havemultiple arguments with the same role. Arguments areunordered.- mentionIdList: Ids of the mentions of this situation in a communication(type=SituationMention)- justificationList: An list of pointers to SituationMentions that providejustification for this situation. These mentions may be eitherdirect mentions of the situation, or indirect evidence.- timeML: A wrapper for TimeML annotations.- intensity: An “intensity” rating for this situation, typically ranging from0-1. In the case of SENTIMENT situations, this is used to recordthe intensity of the sentiment.- polarity: The polarity of this situation. In the case of SENTIMENTsituations, this is used to record the polarity of thesentiment.- confidence: A confidence score for this individual situation. You can alsoset a confidence score for an entire SituationSet using theSituationSet’s metadata.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
SituationMention
(uuid=None, text=None, situationType=None, situationKind=None, argumentList=None, intensity=None, polarity=None, tokens=None, constituent=None, confidence=None)¶ Bases:
object
A concrete mention of a situation, where “situations” includeevents, relations, facts, sentiments, and beliefs. Each situationhas a core type (such as EVENT or SENTIMENT), along with anoptional subtype based on its core type (e.g.,event_type=CONTACT_MEET), and a set of zero or more unorderedarguments.This struct should be used for most types of SRL labelings(e.g. Propbank and FrameNet) because they are grounded in text.Attributes:- uuid: Unique identifier for this situation.- text: The text content of this situation mention. This field isoften redundant with the ‘tokens’ field, and may notbe generated by all analytics.- situationType: The core type of this situation (eg EVENT or SENTIMENT),or a coarse grain situation type.- situationKind: A fine grain situation type that specifically describes thesituation mention based on situationType above. It allows formore detailed description of the situation mention.Some examples:if situationType == EVENT, the event type for the sit. mentionif situationType == STATE, the state type for this sit. mentionFor Propbank, this field should be the predicate lemma and id,e.g. “strike.02”. For FrameNet, this should be the frame name,e.g. “Commerce_buy”.Different and more varied situationTypes may be addedin the future.- argumentList: The arguments for this situation mention. Each argumentconsists of a role and a value. It is possible for an situationto have multiple arguments with the same role. Arguments areunordered.- intensity: An “intensity” rating for the situation, typically ranging from0-1. In the case of SENTIMENT situations, this is used to recordthe intensity of the sentiment.- polarity: The polarity of this situation. In the case of SENTIMENTsituations, this is used to record the polarity of thesentiment.- tokens: An optional pointer to tokens that are (especially)relevant to this situation mention. It is left up to individualanalytics to decide what tokens (if any) they wish to include inthis field. In particular, it is not specified whether thearguments’ tokens should be included.- constituent: An alternative way to specify the same thing as tokens.- confidence: A confidence score for this individual situation mention. Youcan also set a confidence score for an entire SituationMentionSetusing the SituationMentionSet’s metadata.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
SituationMentionSet
(uuid=None, metadata=None, mentionList=None, linkingList=None)¶ Bases:
object
A theory about the set of situation mentions that are present in amessage. See also: SituationMentionAttributes:- uuid: Unique identifier for this set.- metadata: Information about where this set came from.- mentionList: List of mentions in this set.- linkingList: Entity linking annotations associated with this SituationMentionSet.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
SituationSet
(uuid=None, metadata=None, situationList=None, linkingList=None)¶ Bases:
object
A theory about the set of situations that are present in amessage. See also: SituationAttributes:- uuid: Unique identifier for this set.- metadata: Information about where this set came from.- situationList: List of mentions in this set.- linkingList: Entity linking annotations associated with this SituationSet.-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-
-
class
concrete.situations.ttypes.
TimeML
(timeMLClass=None, timeMLTense=None, timeMLAspect=None)¶ Bases:
object
A wrapper for various TimeML annotations.Attributes:- timeMLClass: The TimeML class for situations representing TimeML events- timeMLTense: The TimeML tense for situations representing TimeML events- timeMLAspect: The TimeML aspect for situations representing TimeML events-
read
(iprot)¶
-
validate
()¶
-
write
(oprot)¶
-