Vai al contenuto principale

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

La Vantage API consente di accedere ai parametri della Document skill e della Process skill e di modificarne i valori per una specifica transaction. I parametri vengono passati come coppie chiave-valore di tipo string. I valori impostati tramite l’API hanno priorità su quelli impostati nella Vantage UI.

​
Modificare i valori dei Parameter della skill

Per modificare i valori dei Parameter della skill per una transaction, crea una nuova transaction (oppure avviane una) tramite POST e includi i nuovi valori nel body skillParameters. Crea una transaction vuota: 
POST {your-host}/api/publicapi/v1/transactions
Oppure avvia una transaction che esegue una specifica skill: 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
Includi i nuovi valori dei Parameter nel corpo della richiesta: 
curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"Nuovo Parameter\",\"value\":\"Vendors nuovo\"}]}"
Una transaction può includere fino a 10 Parameter skill in formato chiave-valore. Le chiavi possono contenere fino a 128 caratteri; i valori fino a 256.

​
Ottenere i valori dei parametri della skill

Utilizzare una delle seguenti opzioni per recuperare i valori dei parametri della skill.

​
Interrogare l’endpoint skillParameters

Invia una richiesta GET: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
Risposta: 
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

​
Scaricare il file della Transaction

Invia una richiesta GET per scaricare il file della Transaction, che contiene i valori dei Parameter in formato JSON: 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download