メインコンテンツへスキップ

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.

Vantage API を使用すると、特定のトランザクションに対して Document と Process skill の Skill Parameter にアクセスし、その値を変更できます。パラメーターは、キーと値の string のペアとして渡されます。API で設定された値が Vantage UI で設定された値よりも優先されます。

​
Skill Parameter の値を変更する

トランザクションの Skill Parameter の値を変更するには、POST リクエストで新しいトランザクションを作成 (または起動) し、skillParameters を含むリクエストボディに新しい値を指定します。 空のトランザクションを作成します。 
POST {your-host}/api/publicapi/v1/transactions
または、特定のSkillを実行するトランザクションを開始します。 
POST {your-host}/api/publicapi/v1/transactions/launch?skillId={skill-id}
リクエスト本文に新しいパラメーター値を含めます: 
curl -X POST "{your-host}/api/publicapi/v1/transactions" ^
-H "Authorization: Bearer {token}" ^
-H "Content-Type: application/json" ^
-d "{\"skillId\":\"123\",\"skillParameters\":[{\"key\":\"New parameter\",\"value\":\"Vendors new\"}]}"
1 つのトランザクションには、キーと値のペアからなる skill parameter を最大 10 個含めることができます。キーは 128 文字まで、値は 256 文字までです。

​
Skill Parameter 値を取得する

次のいずれかを使用して Skill Parameter 値を取得します。

​
skillParameters エンドポイントにクエリを実行する

GET リクエストを送信します： 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/skillParameters/
レスポンス： 
[
  {
    "key": "New parameter",
    "value": "Vendors"
  }
]

​
トランザクション ファイルをダウンロード

JSON 形式のパラメーター値を含むトランザクション ファイルをダウンロードするには、GET リクエストを送信します。 
GET {your-host}/api/publicapi/v1/transactions/{transaction-id}/files/{file-id}/download

Skill Parameter

再学習せずに Skill の動作を調整できるよう、Skill Parameter を設定および管理します。

Document Skill Parameter

さまざまな処理シナリオに対応するために、Document skill のパラメーターを設定します。

Process Skill Parameter

Process skill から Document Skill Parameter にアクセスして変更します。

Extract アクティビティ

Document skill を使用してドキュメントからフィールド値を抽出します。

Vantage API の概要

REST API を介して Vantage にプログラムからアクセスします。