Text Moderation (Microsoft Cognitive Services) activity

An activity that reviews your text with the text moderation function in Microsoft Cognitive Services to find possible offensive statements in many languages, and stores the result of this function in your process schema.

Configure the Text Moderation activity

To configure the Text Moderation activity, do the procedure in this topic.

Examples

(Example) How to Get the Access Token Credentials from Microsoft Cognitive Services

Prerequisites

AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 or higher.

Good to Know

To send an email notification, click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).
In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, open the MS Cognitive Services tab.
On the MS Cognitive Services tab, drag the Text Moderation activity onto your process.

General Configuration

Specifies the basic settings for the Text Moderation activity.

Good to Know

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

Fields

Field Name	Definition
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

Field Name

Definition

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:

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

Text Moderation Configuration

Configures the request and response settings for the text moderation.

Fields

Field Name	Definition
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 Moderation API. Default Value: None Example: Refer to: (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services
Create	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: (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services
Request Text	Description: Specifies the text input to review for profanity, deliberately misspelled words, or personally identifiable information (PII). Allowed Values: More than one line of text. Accepted: 1024 characters maximum Default Value: None
Language	Description: Specifies the language for which the text is reviewed for profanity, deliberately misspelled words, or personally identifiable information (PII). Allowed Values: A language from the list. Default Value: None Accepts Variables: No
List ID	Description: Specifies a custom term list to check in Microsoft Cognitive Services. Custom term lists are used in addition to the default term list for the language selected in the Language field. If you do not enter a list ID, only the default term list is used. Allowed Values: An integer. Represents A list ID for a custom term list in Microsoft Cognitive Services. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Auto Correct	Description: Specifies whether to correct the text input for misspelled words. Allowed Values: Deselected - The input text is not corrected for misspelled words. Selected - The input text is corrected for misspelled words. Default Value: Deselected
Get PII	Description: Specifies if the personally identifiable information (PII) shows in the response. PII includes: Full name E-mail address Mailing address IP address Phone number Social Security Number (SSN) Allowed Values: Deselected - The response will not include PII. Selected - The response will include PII. Default Value: Deselected

Text Moderation Configuration > Response tab

Configures the response settings for text moderation in Microsoft Cognitive Services.

Fields

Field Name	Definition
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: (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services
Create	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: (Example) How to Get the Access Token Credentials from Microsoft Cognitive Services
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 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: (Example) Schema Mapper
Store the Response in Custom Attribute	Description: Specifies the process data variable that stores the responses from the Microsoft Text Moderation service. Allowed Values: A process data variable that accepts a text string in JSON format that contains the corrected text. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?