DetectEntities Processor

Part of the AWS Processor package

This processor takes in an input string and returns textual references to real world items (such as names, places, etcetera).

Properties

All of our Comprehend processors also include these common properties.

This processor does not have any unique properties outside of the common ones.

Data Output

If the Destination property is set to flowfile-attribute, then the output of this processor will be routed to the FlowFile's nlp.Entities attribute, which will be created if it isn't present.

Output Format

Field Name	Data Type	Description
entities	array of Entity	The list of entities found by the API

Relevant Data Structures

Entity

Field Name	Data Type	Description
text	string	The raw text of the entity
score	float	How confident the API is in its response
beginOffset	int	The number of characters this entity is offset from the beginning of the input string
endOffset	int	The number of characters this entity's last character is offset from the beginning of the input string
type	string (Entity Type)	The kind of entity

Example Output

{
	"raw-input": "...",
	"output": {
		"entities": [
			{
				"score": 0.9880011,
				"beginOffset", 47,
				"endOffset": 76,
				"text": "Calculated Systems, LLC",
				"type": "ORGANIZATION",
			},
			{
				"score": 0.999892,
				"beginOffset": 98,
				"endOffset": 106,
				"text": "14.9 pct",
				"type": "QUANTITY"
			},
			// ... plus potentially many more entries!
		]
	}
}