Detect Text

Activity for detecting the words, lines, and text found in the input image in Amazon Rekognition

UiPath.AmazonRekognition.Activities.DetectLabels

The Detect Text activity uses the Amazon Rekognition DetectText API to detect the words, lines, and text found in the input image (ImagePath or ImageURL).

The output of the Detect Text activity can be an array of words and/or lines (Words and Lines), and/or an aggregate of all text found in the image (Text).

Summary

Dependencies

Dependency	Details
Packages	UiPath.Amazon.Rekognition.Activities
Activities	Amazon Scope

Attributes

Attribute	Details
Inputs (Variables)	String Applies to property: ImagePath or ImageURL Double Applies to property: Confidence Int32 Applies to property: MaxResults
Outputs (Variables)	TextElement[] Applies to property: Words and Lines String Applies to property: Text
API used	Amazon Rekognition - DetectText
Examples	Quickstart

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	Detect Labels
Allowed values	Enter a String or String variable.
Notes	N/A

Input

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

Confidence

The minimum confidence that the detected line or word exists in the image and is correctly interpreted.

Attributes	Description
Type	Double
Required	No
Default value	0.80 (not displayed in the property)
Allowed values	Enter a number between 0 and 1 to indicate the percentage of confidence (e.g., enter .9 if you want the confidence to be 90%).
Notes	If this property is set, the Words and Lines properties only return the words and lines that meet or exceed the specified value

Output

Lines

An array containing each line of text detected in the image.

Attributes	Details
Type	TextElement[] UiPath.Amazon.Rekognition.Models.TextElement[]
Required	No (recommended if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter your value as a TextElementl[] variable.
Notes	The output data includes the Text, Confidence, and Location of the lines.

Text

An aggregate of the all text found in the image.

Attributes	Details
Type	String
Required	No (recommended if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter your value as a String variable.
Notes	N/A

Text

An array containing each word detected in the image.

Attributes	Details
Type	TextElement[] UiPath.Amazon.Rekognition.Models.TextElement[]
Required	No (recommended if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter your value as a TextElementl[] variable
Notes	The output data includes the Text, Confidence, and Location of the words.