Key Phrase Extraction activity

Configure the Key Phrase Extraction activity

To configure the Key Phrase Extraction activity, do the procedure in this topic.

Examples

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

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 Key Phrase Extraction activity onto your process.

General Configuration

Specifies the basic settings for the Key Phrase Extraction 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:

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

Key Phrase Extraction Configuration

Configures the request and response settings to get the key phrases from text.

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 Analytics 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 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: Click the Request tab. Allowed Values: Click the Schema Mapping 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: (Example) Schema Mapper

Key Phrase Extraction Configuration > Response tab

Configures the response settings to get the key phrases from the analyzed text.

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 Key Phrase Extraction service. Allowed Values: A process data variable that accepts a text string in JSON format that contains a list of extracted phrases. Default Value: None Accepts Variables: Yes Example: [{"Documents":[{"Id":"3da0e08e-7d73-48ae-8c34-b27d2478ee5e","KeyPhrases":["trail","small children","family"]}],"Errors":[]}]