Language Detection activity

An activity that maps data from the language detection function in Microsoft Cognitive Services to your process schema. Language detection identifies the language used in a specified text.


Language Detection activity

Configure the Language Detection activity

To configure the Language Detection 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 the 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 Language Detection activity onto your process.

    Drag Language Detection activity

General Configuration

Specifies the basic settings for the Language Detection 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 Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data 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

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Language Detection Configuration

Configures the request and response settings to identify the language used in a specified text.

Figure: Language Detection Configuration > Request tab

Language Detection Configuration Request tab

Fields

Field Name Definition

MS Cognitive Services

Function:
Specifies the access token that connects to your Microsoft Cognitive Services.
Accepted 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

Function:
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.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

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

Default Value:
None
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?

Language Detection Configuration > Response tab

Configures the response settings to identify the language used in a specified text.

Figure: Language Detection Configuration > Response tab

Language Detection Configuration Response tab

Fields

Field Name Definition

MS Cognitive Services

Function:
Specifies the access token that connects to your Microsoft Cognitive Services.
Accepted 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

Function:
Specifies the connection from the Microsoft Cognitive Services API response parameter to your process schema.
Accepted 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
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?

Store the Response in Custom Attribute

Function:
Specifies the process data variable that stores the responses from the Microsoft Language Detection service.
Accepted Values:
A process data variable that accepts a text string in JSON format that contains a list of detected languages.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:
[{"Documents":[{"DetectedLanguages":[{"Name":"English","Score":1,"Iso6391Name":"en"}],"Id":"cc70d315-1ddd-4e28-8ac7-bbcccce526b5"}],"Errors":[]}]