DetectKeyPhrases Processor

Part of the AWS Processor package

This processor will take an input string and return key phrases found in the text.

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.KeyPhrases attribute, which will be created if it isn't present.

Output Format

Field Name	Data Type	Description
keyPhrases	array of KeyPhrase	The list of key phrases detected by the API

Relevant Data Structures

KeyPhrase

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

Example Output

{
	"raw-input": "...": {
		"keyPhrases": [
			{
				"score": 0.9991118,
				"beginOffset": 0,
				"endOffset": 74,
				"text": "Computers are machines"
			},
			{
				"score": 0.988914,
				"beginOffset": 100,
				"endOffset": 121,
				"text": "that can perform calculations much faster than humans"
			},
			// ... plus potentially many more entries!
		]
	}
}