UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

UiPath.AmazonRekognition.Activities.AddFace

Overview

The Add Face activity uses the Amazon Rekognition IndexFaces API to first detect faces in the input image (ImagePath or ImageURL) and then add them to the specified collection (CollectionName). For each face detected, the activity returns an array of the faces (Faces) that were added to the collection.

Summary

Dependencies

Dependency
Details

Packages

UiPath.Amazon.Rekognition.Activities

Activities

Amazon Scope
Create Collection (unless a collection already exists)

Attributes

Attribute
Details

Inputs (Variables)

String

  • Applies to property: ImagePath, ImageURL, and CollectionName

Outputs (Variables)

Faces[]

  • Applies to property: Faces

API used

Amazon Rekognition - IndexFaces

Examples

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Add Faces

Allowed values

Enter a String or String variable.

Notes

N/A


Input

CollectionName

The name or ID of an existing collection that you want to add detected faces to.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • If you have an existing collection that you want to use, enter its exact collection name.
  • There is not an activity to retrieve a list of your collection names, but you can call the ListCollections API directly using the AWS CLI or AWS SDK API.

ImagePath

The path to a local image that you want to analyze.

Attributes
Details

Type

String

Required

Yes (if the ImageURL is empty)

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • Either the ImagePath or ImageURL property is required.
  • If you enter values for both the ImagePath and ImageURL, the Image Path value is used.

ImageURL

The URL of an image that you want to analyze.

Attributes
Details

Type

String

Required

Yes (if the ImagePath is empty)

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • Either the ImagePath or ImageURL property is required.
  • If you enter values for both the ImagePath and ImageURL, the Image Path value is used.

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Options

ImageID

A unique identifier that you want to assign to the face(s) in the input image.

Attributes
Details

Type

String

Required

No

Default Value

Empty

Allowed Values

Enter a String or String variable.

Notes

  • Example: if your image has only one face, your ImageID could be the person's name (e.g., "Peter"). If your image has multiple faces, the ImageID is applied to all faces in the image. In this instance, your value should reflect how you want to identify the group of faces (e.g., "Peter.Paul.Mary").
  • Using the ImageID property is useful if you plan to use the Identify Face activity. The Identify Face activity returns an array of faces (via the Faces output property) that match those found in the input image. If you previously assigned an ImageID to an image, that value would be returned in the array.

Output

Faces

An array of the face(s) added to the collection specified in the CollectionName.

Attributes
Details

Type

Face[]
UiPath.Amazon.Rekognition.Models.Face[]

Required

No (recommended if you plan to use the output data in subsequent activities)

Default Value

Empty

Allowed Values

Enter a Face[] variable.

Notes

  • Each identified face in the image is assigned a unique set of face properties using the Face datatype, which includes a FaceID and BoundingBox.
  • If you plan to use the For Each activity to process the array output, select UiPath.Amazon.Rekognition.Models.Face as the TypeArgument.

Updated 5 months ago


Add Face


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.