Comprehend connector

The Comprehend connector uses the Amazon Comprehend service's natural language processing (NLP) to identify and analyze text from UTF-8 plain text files.

The implementation value of the Comprehend connector in a service task would be similar to the following:

<bpmn2:serviceTask id="ServiceTask_8tacy8mn" implementation="comprehendConnector.ENTITY" />

Amazon Web Services (AWS) configuration

The following are the Amazon Comprehend APIs that are called using the connector:

The Comprehend connector requires an AWS account to access Amazon features. It also requires an Identity and Access Management (IAM) user to have the textract:DetectDocumentText and textract:AnalyzeDocument permissions.

Input parameters

The following are the parameters that can be passed to the Comprehend connector as input parameters using the ENTITY action:

ParameterDescriptionTypeRequired?
nodeIdThe node ID of the file to use from Alfresco Content ServicesString*
uriThe URI of the file to useString*
filesA file uploaded in a process and set as a process variable or uploaded as part of a form or another connectorFile*
textThe text to be analyzedString*
maxEntitiesThe maximum number of entities returned by the service. The default is 1000IntegerNo
confidenceLevelThe minimum confidence level to use in the analysis between 0 and 1. The default is 0.75StringNo
timeoutThe timeout period for calling the Comprehend service in millisecondsIntegerNo

* Only one of these parameters is required.

Output parameters

The following are the parameters that are returned to the process by the Comprehend connector as output parameters using the ENTITY action:

ParameterDescriptionType
analysis.errorA list of errors if any are caught by the connectorString
awsResultThe result of the analysis from the the Comprehend serviceJSON
aisResponseThe result of the analysis in Alfresco Intelligence Service formatJSON

Configuration parameters

Values for configuration parameters that are specific to a connector instance can be set in the modeling application or during application deployment.

The following are the configuration parameters that need to be set for the Comprehend connector:

ParameterDescriptionRequired?
AWS_ACCESS_KEY_IDThe access key to be used to authenticate against AWSYes
AWS_SECRET_KEYThe secret key to be used to authenticate against AWSYes
AWS_REGIONThe region of AWS to use the Comprehend service inYes
AWS_S3_BUCKETThe name of the S3 bucket to useYes
ALFRESCO_CONTENT_REPO_BASE_URLThe base URL of the Content Services deployment

© 2023 Alfresco Software, Inc. All Rights Reserved.