Description

This activity allows you to recognize text using the Klippa OCR service. 

How to work with credentials

To start using this activity, you first need to enter your credentials.

The button to add new credentials.

This article describes in detail the process of adding credentials.

Parameters

API Key

Klippa OCR requires an account in the service itself. Create an account in Klippa and fill it out in Studio Pro to get access to the Klippa functionality. If you already have an account in Studio Pro, you can select it from the drop-down list. If not, click Add New Account and fill in the details. 

In the appeared window you will see a from for creating an account:

1. Service — this field can be filled in any way, it will not affect the operation of this action.
2. Login — this field can be filled in any way, it will not affect the operation of this action.
3. Password — here you need to specify the API Key. 

The endpoint used in Klippa OCR is /parseDocument.

Path

1. Set a value option allows you to manually specify the path to the image whose text you want to recognize. Click the "PICK" button to open the file explorer and select the path to the picture. 
2. Calculate a value option allows you to use a special formula or a special method to determine the path.
3. Save the previous step result option takes the result of the previous workflow activity as the path. 

Additional parameters

Use this parameter to pass custom parameters to Klippa, such as {"template": "financial_candidate"}. You can learn more about these parameters in this article.

1. Calculate a value option allows you to use a special formula or method to determine additional parameters. In this case, the formula or method must be written using JavaScript syntax. 
2. Save the previous step result option takes the result of the previous workflow activity as the additional parameters.

Comment

This parameter allows you to create an annotation to the activity. The input text will be displayed above the activity name.