Analyze Image activity

An activity that analyzes your image with the Analyze Image function in Microsoft Cognitive Services to find offensive or unwanted images, and stores the result of this function in your process schema.


Analyze Image activity

Configure the Analyze Image activity

To configure the Analyze Image activity, do the procedure in this topic.

Examples

Prerequisites

Good to Know

How to Start

  1. On the App Explorer screen, do one of these:
  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 Analyze Image activity onto your process

    Drag Analyze Image activity

General Configuration

Specifies the basic settings for the Analyze Image 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

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

Source Repository

Specifies the original, or source, location type for your files.

Figure: Source Repository screen

Source Repository screen

Fields

Field NameDefinition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > Amazon S3.

Box Box icon

Function:
Specifies that Box is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > Box.

Dropbox Dropbox icon

Function:
Specifies that Dropbox is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > Dropbox.

FTP FTP icon

Function:
Specifies that FTP is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > FTP.

Google Drive Google Drive icon

Function:
Specifies that Google Drive is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > Google Drive.

NetSuite NetSuite icon

Function:
Specifies that NetSuite is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > NetSuite.

OneDrive OneDrive icon

Function:
Specifies that OneDrive is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > OneDrive.

OneDrive for Business OneDrive For Business icon

Function:
Specifies that OneDrive for Business is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > OneDrive for Business.

Salesforce Salesforce icon

Function:
Specifies that Salesforce is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > Salesforce.

SFTP SFTP icon

Function:
Specifies that SFTP is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > SFTP.

SharePoint SharePoint icon

Function:
Specifies that SharePoint is the source location for your files.

To select your file in the source location, complete the fields on Analyze Image > Source Repository > SharePoint.

Analyze Image Configuration screen

Configures the response settings for the images analysis.

Figure: Analyze Image Configuration screen

Analyze Image Configuration screen

Fields

Field NameDefinition

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
Example:
Refer to:

Store the Response in Custom Attribute

Function:
Specifies the process data variable that stores the responses from the Microsoft Analyze Image service.
Accepted Values:
A process data variable that accepts a text string in JSON format that contains the information from the analyzed image.
Default Value:
None
Accepts Process Data Variables:
Yes
Example:

[{"categories":[{"name":"outdoor_road","score":0.7421875}],"description":{"tags":["road","yellow","people"],"captions":[{"text":"a person riding a motorcycle on the side of a road ","dominantColors":["Grey"],"accentColor":"A1712A","isBWImg":false},…..}]