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 result of this function in your 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 Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Cognitive Services Cognitive Services icon tab.
      2. On the Cognitive Services Cognitive Services icon tab, drag the Analyze Image Analyze Image icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

General Configuration

Specifies the basic settings for the Analyze Image activity.

Figure: General Configuration screen

General Configuration screen

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

Source Repository

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

Figure: Source Repository screen

Source Repository screen

Fields

Field Name Definition

Amazon S3 Amazon S3 icon

Function:
Specifies that Amazon S3 is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Amazon S3) - Analyze Image.

Box Box icon

Function:
Specifies that Box is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Box) - Analyze Image.

Dropbox Dropbox icon

Function:
Specifies that Dropbox is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Dropbox) - Analyze Image.

FTP FTP icon

Function:
Specifies that FTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (FTP) - Analyze Image.

Google Drive Google Drive icon

Function:
Specifies that Google Drive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Google Drive) - Analyze Image.

NetSuite NetSuite icon

Function:
Specifies that NetSuite is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (NetSuite) - Analyze Image.

OneDrive OneDrive icon

Function:
Specifies that OneDrive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive) - Analyze Image.

OneDrive For Business OneDrive For Business icon

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

To select your file in the source location, complete the fields on Source Repository Configuration (OneDrive For Business) - Analyze Image.

Salesforce Salesforce icon

Function:
Specifies that Salesforce is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Salesforce) - Analyze Image.

SFTP SFTP icon

Function:
Specifies that SFTP is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SFTP) - Analyze Image.

SharePoint SharePoint icon

Function:
Specifies that SharePoint is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SharePoint) - Analyze Image.

Analyze Image Configuration screen

Configures the response settings for the images analysis.

Figure: Analyze Image Configuration screen

Analyze Image Configuration screen

Fields

Field Name Definition

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 Cognitive Service Type configured for Computer Vision API.

Default Value:
None
Example:
Refer to:

Add Token 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 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, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 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},…..}]