Skip to main content

Read Text

UiPath.MicrosoftVision.Activities.ReadText

The Read Text activity uses the Microsoft Vision API to read the text from the specified image and gives information on the positioning of the text inside the image.

How it works​

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Add the Microsoft Vision Scope activity to your project.
  2. Add the Read Text activity inside the Microsoft vision Scope activity.
  3. Create and enter variables for the Input properties.
  4. Create and enter variables for the Output property.

Properties​

Common​

  • Continue On Error - This field only supports boolean values (True, False). The default value in this field is False. As a result, if this field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input​

  • Image Path - The path to a local image to be analyzed. This field supports only Strings or String variables. If Image URL is provided, this field is ignored.
  • Image URL - The URL of an image to be analyzed. This field supports only Strings or String variables. If Image Path is provided, this field is ignored.

Misc​

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

Options​

  • Auto Detect Language - If selected, the engine auto-detects the language. Enabling this has the same effect as specifying the Language as Unk.
  • Detect Orientation - If checked, the engine will try to detect and correct orientation. Enter a Boolean or Boolean variable.
  • Language - The language of the text in the picture. For a list of supported items please visit the Microsoft documentation

Output​

  • Result - The generated lines of text. Enter a Textline[] variable. Textline has two properties: Text, Position.
  • Text - A string which contains all the text identified within the specified image. This field supports only String variables.