Sentiment Analysis activity

An activity that maps data from the sentiment analysis function in Microsoft Cognitive Services to your process schema. Sentiment analysis analyzes the sentiments in text, such as positive, negative, or neutral.


Sentiment Analysis activity

Configure the Sentiment Analysis activity

To configure the Sentiment Analysis activity, do the procedure in this topic.

Examples

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the MS Cognitive Services tab.

    MS Cognitive Services tab
  3. On the MS Cognitive Services tab, drag the Sentiment Analysis activity onto your process.

    Drag Sentiment Analysis activity

General Configuration

Specifies the basic settings for the Sentiment Analysis activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Sentiment Analysis Configuration

Configures the request and response settings to analyze the sentiments in text.

Figure: Sentiment Analysis Configuration > Request tab

Sentiment Analysis Configuration Request tab

Fields

Field NameDefinition

MS Cognitive Services

Description:
Specifies the access token that connects to your Microsoft Cognitive Services.
Allowed Values:
A list of access tokens configured for your environment.

The selected access token must have the Microsoft Cognitive Service Type configured for Text Analytics API.

Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Cognitive Services
Function of this Screen:
Configure an access token to connect to Microsoft Cognitive Services.
Example:
Refer to:

Map Request to AgilePoint Schema

Description:
Connects the Microsoft Cognitive Services request to your process schema. This is necessary only if the request passes data from the process schema to parameters in Cognitive Services.
To Open this Field:
  1. Click the Request tab.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper screen.

Use this screen to connect the request to the data model for your process.

Default Value:
None
Example:
Refer to:

Sentiment Analysis Configuration > Response tab

Configures the response settings for sentiment analysis in the analyzed text.

Figure: Sentiment Analysis Configuration > Response tab

Sentiment Analysis Configuration Response tab

Fields

Field NameDefinition

MS Cognitive Services

Description:
Specifies the access token that connects to your Microsoft Cognitive Services.
Allowed Values:
A list of access tokens configured for your environment.

The selected access token must have the Microsoft Cognitive Service Type configured for Computer Vision API.

Default Value:
None
Example:
Refer to:

Create Add Token icon

Opens this Screen:
Access Token for Microsoft Cognitive Services
Function of this Screen:
Configure an access token to connect to Microsoft Cognitive Services.
Example:
Refer to:

Map Response to AgilePoint Schema

Description:
Specifies the connection from the Microsoft Cognitive Services API response parameter to your process schema.
Allowed Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the response to the data model for your process.

Default Value:
None
Example:
Refer to:

Store the Response in Custom Attribute

Description:
Specifies the process data variable that stores the responses from the Microsoft Sentiment Analysis service.
Allowed Values:
A process data variable that accepts a text string in JSON format that contains a list of sentiment scores.
Default Value:
None
Accepts Variables:
Yes
Example:
[{"Documents":[{"Id":"566819ae-11a7-4c7b-a187-59a5702d4511","Score":0.802317262}]}]