The functions in this section are exposed in the Business Entities > Library Types > ABBYY Vantage from the Direct.Shared.Library.dll.
To view the ABBYY Vantage library objects:
-
Verify that the Direct.Shared.Library.dll file is installed in Real-Time Designer installation folder.
-
Edit (as an admin) C:\Users\<user>\AppData\Roaming\Nice_Systems\Real-Time\RTClient.exe.config file and in the <configSections> ensure that the following appears: <section name="VantageUrlConfigurator" type="Direct.Shared.ABBYYVantageConfigurator, Direct.Shared.Library" />
-
In Real-Time Designer, select Project > References > Library References > Direct.Shared.Library.
-
From the Type dropdown list, select ABBYY Vantage.
ABBYY Vantage Properties
|
Property |
Description |
Type |
|---|---|---|
| Client Id |
The ABBYY Vantage API application identifier. This should be created by a user with the Tenant Administrator role in ABBYY Vantage. See the ABBYY Vantage Administrators Guide. |
Text |
| Client Secret |
The ABBYY Vantage client secret. This should be created by a user with the Tenant Administrator role in ABBYY Vantage. The client secret value is only available when it is being created. Store it in a secure location. See the ABBYY Vantage Administrators Guide. |
Text |
| Error | Stores any errors returned by ABBYY Vantage (Detail, Instance, Status, Title, and Type). | Error Details |
| Exception | The exception event. | |
| Password | The ABBYY Vantage password. | Text |
| Response |
The API call response from the following functions:
|
Text |
| ResponseCode |
The API call response code:
|
Number |
| Status | The API call status. Completed once done. | Text |
| URL | The ABBYY Vantage URL. https://vantage-eu.abbyy.com/ | Text |
| User Name | The ABBYY Vantage user name. | Text |
Functions
|
Function |
Description |
RETURN |
|---|---|---|
| Add file to transaction | Adds a file to an ABBYY Vantage transaction. | None |
| Connect | Connects to the ABBYY Vantage API. | Boolean |
| Create Empty Transaction | Creates an empty ABBYY Vantage transaction. | Text |
| Create transaction & process file | Create an ABBYY Vantage transaction and processes the file. | Text |
| Download Result | Downloads the result of the file processing from ABBYY Vantage. | Boolean |
| Get Skills | Gets a list of skills from ABBYY Vantage. | List of Vantage Skills |
| Get Transaction Status | Gets the transaction status. | Transaction Status |
| Start processing transaction | Starts processing an ABBY Vantage transaction. | None |
Transaction Response
|
PROPERTY |
Description |
|---|---|
| Id | The ID of the transaction. |
| SkillId | The ID of the applied skill. |
| SkillName | The name of the applied skill. |
| Documents |
The list of the Documents objects, together with the processing results.
For more information, refer to the JSON schema on the ABBYY Vantage Developer's Guide. |
| CreationTime | The time of the transaction. |
| SourceFiles |
The list of SourceFile objects, together with information about the source files submitted for processing. ABBYY Vantage currently only supports one file per transaction.
|
The following is a sample response for the Get Transaction Status function. Use the fileId from this response as an input parameter for the Download Result function.
{
"id":"6def39bb-dddd-4241-9623-23e98d67b991",
"status":"Processed",
"documents":[
{
"id":"67d66822-9e3e-4475-a82b-dbe868ae6da8",
"resultFiles":[
{
"fileId":"5c3822ac-4329-43b5-9d30-04e157f5797d",
"fileName":"FuelSkill.json",
"type":"Json"
}
],
"businessRulesErrors":[
]
}
],
"sourceFiles":[
{
"id":"107c2b57-c684-4c28-804c-ca1b8fdbed62",
"name":"New doc 11-03-2021 09.25.53 am.jpg"
}
]
}
The following is a sample response for the Download Result function.
{
"Transaction": {
"Id": "6def39bb-dddd-4241-9623-23e98d67b991",
"SkillId": "ceea8eae-0323-476f-ae28-fb6f9e3b6605",
"SkillName": "FuelSkill",
"Documents": [
{
"Id": "67d66822-9e3e-4475-a82b-dbe868ae6da8",
"ExtractedData": {
"DocumentDefinition": {
"RootConcept": {
"Id": "root",
"Name": "Empty",
"Fields": [
{
"Id": "5ecf509b-3e8a-4ae8-a133-c29a415f6caa",
"Name": "New Field",
"Type": "String",
"Cardinality": {
"Min": 0,
"Max": 1
}
},
{
"Id": "3cea23c5-46da-46bf-8596-630e6288861a",
"Name": "New Field 2",
"Type": "String",
"Cardinality": {
"Min": 0,
"Max": 1
}
},
{
"Id": "10366775-f6c9-4e04-a715-e7fc36c4b663",
"Name": "New Field 3",
"Type": "String",
"Cardinality": {
"Min": 0,
"Max": 1
}
}
]
}
},
"RootObject": {
"Id": "root",
"Concept": "Empty",
"Fields": [
{
"Name": "New Field",
"List": [
{
"Id": "71517cd0-d96b-4a1f-82ed-3aff563b6238",
"Annotations": [
{
"Source": "Image",
"ImageRegions": [
{
"Page": "e3c2ea3e-cd90-46d4-9ed3-2ca4a6d26a29",
"Rects": [
[
606,
600,
794,
652
]
]
}
],
"RawValue": "80209",
"Confidence": 1,
"SuspiciousSymbols": []
}
],
"Value": "80209"
}
]
},
{
"Name": "New Field 2",
"List": [
{
"Id": "f058e5aa-7212-4b65-9011-6b673d5e0685",
"Annotations": [
{
"Source": "Image",
"ImageRegions": [
{
"Page": "e3c2ea3e-cd90-46d4-9ed3-2ca4a6d26a29",
"Rects": [
[
567,
782,
792,
825
]
]
}
],
"RawValue": "Petrol",
"Confidence": 1,
"SuspiciousSymbols": [
2
]
}
],
"Value": "Petrol"
}
]
},
{
"Name": "New Field 3",
"List": [
{
"Id": "cbd571bf-4c52-4332-bada-1109ba87d2d2",
"Annotations": [
{
"Source": "Image",
"ImageRegions": [
{
"Page": "e3c2ea3e-cd90-46d4-9ed3-2ca4a6d26a29",
"Rects": [
[
567,
736,
640,
775
]
]
}
],
"RawValue": "04",
"Confidence": 1,
"SuspiciousSymbols": []
}
],
"Value": "04"
}
]
}
]
}
},
"Pages": [
{
"Id": "e3c2ea3e-cd90-46d4-9ed3-2ca4a6d26a29",
"SourceFile": "New doc 11-03-2021 09.25.53 am.jpg",
"SourceImagePageIndex": 0
}
]
}
],
"CreationTime": "2021-09-25T18:51:39.4425611+00:00",
"SourceFiles": [
{
"Id": "107c2b57-c684-4c28-804c-ca1b8fdbed62",
"Name": "New doc 11-03-2021 09.25.53 am.jpg"
}
]
},
"Version": "2.1"
}