redaction-service/drools-prompt/RedactionEntity_properties_doc

39 lines
1.8 KiB
Plaintext

/**
* A boundary has a start and end property accessible by start() and end() respectively. It marks the start and end offset in String offsets.
*/
Boundary boundary
/**
* The type of an Entity identifies groups of Entities. Examples for Entites we want to find are "CBI_author" for authors, "CBI_address" for addresses or "PII" for personally identifiable information.
* Other types include helper types, which interact with the main Entities, for example "published_information" or "vertebrate". These Entities are used to modify the main Entities, if they occur in the same Section.
* A typical example would be to ignore Entities of type "CBI_author", if they occur in the same Section as "published_information" entities.
*/
String type
/**
* The EntityType can be one of four different values: ENTITY, RECOMMENDATION, FALSE_POSITIVE, FALSE_RECOMMENDATION.
* If an ENTITY is overlapped by a FALSE_POSITIVE, the ENTITY is removed. If a RECOMMENDATION is overlapped by either an ENTITY or FALSE_RECOMMENDATION, it is removed.
*/
EntityType entityType
/**
* The text the Entity represents.
*/
String value
/**
* Up to three words after the Entity in the text.
*/
String textAfter
/**
* Up to three words before the Entity in the text.
*/
String textBefore
/**
* All pages whose TextBlock intersects the boundary of this entity. Is always equal to the Pages which have this RedactionEntity in their EntitySet.
*/
Set<Page> pages
/**
* All SemanticNodes whose TextBlock intersects the boundary of this entity. Is always equal to the SemanticNodes which have this RedactionEntity in their EntitySet.
*/
List<SemanticNode> intersectingNodes
/**
* The SemanticNode which is the deepest in the Tree structure and whose TextBlock fully contains the boundary of this Node.
*/
SemanticNode deepestFullyContainingNode