Abbyy Vantage: Process documents within a conversation



This tutorial will explain how to integrate an organization's Abbyy Vantage instance to a Cognigy.AI virtual agent in order to process user documents during a chat/voice conversation.

The provider itself describes Vantage as the following:

ABBYY Vantage is a comprehensive platform of cognitive services that applies AI to understand your documents in a fast and simple way. Vantage makes today’s digital worker and processes smarter by delivering cognitive skills that read, understand, and extract insights from documents, helping enterprises accelerate digital transformation (Abbyy, 2021).


Table of Contents

  1. Video Description
  2. Install the Abbyy Vantage Extension
  3. Create an OAuth Connection
    1. Authenticate the process
  4. Create an Instance Connection
  5. Run a Skill as Transaction
    1. Check if the process is authenticated
  6. Start a Skill and display the results

Video Description

Install the Abbyy Vantage Extension

The first step is to install the required integration. In this case, a so-called Extension is installed to Cognigy.AI. Thus, navigate to the Extensions Marketplace inside of the Virtual Agent and add the Abbyy Vantage Extension by clicking on the Install button. Now follow this installation guide and upload the Extension to Cognigy, where it will be displayed as the following:


Congrats! The installation of the Extension is finished!

Create an OAuth Connection

In this step, a so-called Connection will be created. If one, in Cognigy.AI, clicks on the previously uploaded Extension, the following details can be observed:


The red-marked part in the above figure shows, that there are two Connections required. Therefore, they need to be created and filled with the OAuth and instance information. In order to do so, two initial Flow Nodes have to be added to a Flow. First, one can start with the OAuth Connection:

  1. Create a new Flow in Cognigy.AI
  2. Inside of the Flow Chart, click on + and navigate to the Abbyy Vantage Extension:


  3. Add the Authenticate Flow Node by clicking on it:


  4. In order to edit the Flow Node and create the Connection, please click on it. An Edit Node menu will be opened on the right side of the screen:


  5. Right next to the Connection field (the first one at the top), one needs to click on the + button. The Connection menu will be opened at the center of the screen:

  6.  Please contact your Abbyy Vantage administrator in order to provide the following OAuth credentials. Insert the related credentials/information of the organization to the fields:
    1. clientId
      1. The Abbyy instance client ID
    2. clientSecret
      1. The Abbyy instance client secret
    3. username
      1. The administrator's user name
    4. password
      1. The administrator's password
    5. url
      1. The Abbyy authentication URL
      2. e.g. This URL could change for different types of Abbyy Vantage installations.
  7. Click on the Create button

Authenticate the process

With the above Connection provided, the Authenticate Flow Node can be executed in order to store the required Abbyy Access Token into the Cognigy Context:


The result looks like the following:

    "abbyy": {
        "auth": {
        "access_token": "eyJh...",
        "expires_in": 2592000,
        "token_type": "Bearer",
        "scope": "openid permissions"

In all other related Flow Nodes, such as Get Skills, this information must be provided with CognigyScript


or a Token


Create an Instance Connection

To go back to the aforementioned Get Skills Flow Node, another Connection can be seen in the edit menu:



In this case, the Abbyy Instance information is requested, while this information is used by

  1. The Get Skills
  2. Run Transaction
  3. and Get Transaction (Results) Flow Node.


The instanceUri can be extracted from the Abbyy Vantage URL that a person opens in order to access the software:

    • e.g.
    • Please make sure to remove the last "/" from the URL

With this information, a transaction can be started in the next steps.

Run a Skill as Transaction

Finally, the Flow is ready to run an Abbyy Skill as transaction and process user documents. In order to get started, a basic template for such a Flow could loo such as:


Check if the process is authenticated

In this example, the Flow starts with an If Node, checking the existence of the Abbyy Access Token which tells the system if the current conversation is authenticated for further Abbyy actions:


Therefore, the Flow can execute the Authenticate Flow Node based on this condition:


Start a Skill and display the results

Otherwise, any Abbyy Skill can be executed within the Cognigy.AI system, while the conversation could wait until the results are available. Last but not least, a Say Node can display the response in a human-readable way:





Article is closed for comments.

Was this article helpful?
0 out of 0 found this helpful