単一の API コールでドキュメントを処理する

単一の API コールを使用してドキュメントを処理する (トランザクションの作成、ファイルのアップロード、およびトランザクションの開始) ための一般的なシナリオは、次の手順で構成されます。

利用可能なすべての Skill の一覧を取得する
トランザクションを作成して開始する
Transaction Status を監視する
ソースファイルと結果ファイルをダウンロードする

サーバーへの各リクエストには、認証情報を含める必要があります。詳細は、Authentication を参照してください。このシナリオは、サイズが 30 MB 未満のファイルが 1 つだけであり、そのファイル内の画像を編集する必要がない場合に使用してください。

利用可能なすべてのSkillの一覧を取得する

これを行うには、skills リソースに GET リクエストを送信します。

GET https://vantage-us.abbyy.com/api/publicapi/v1/skills

GET https://vantage-eu.abbyy.com/api/publicapi/v1/skills

GET https://vantage-au.abbyy.com/api/publicapi/v1/skills

次のコマンドを実行します。 Windows の場合:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"

Linux の場合:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'

レスポンスには、次のような JSON ファイルが含まれます。 レスポンス:

[
   {
      "id": "Receipt",
      "name": "Receipt",
      "type": "Document"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "NewClassifier",
      "type": "Classification"
   },
   {
      "id": "c4b26798-07cb-11eb-adc1-0242ac120002",
      "name": "Invoice",
      "type": "Document"
   }
]

使用するSkill識別子を指定します。Skillの詳細な説明は、組み込みSkillに記載されています。

トランザクションの作成と開始

指定したSkillでアップロード済みのファイルを処理するトランザクションを作成して開始するには、次のPOSTリクエストをtransactions/launch?skillId=<skill-id>リソースに送信します。

POST https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id

POST https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id

POST https://vantage-au.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id

これにより、新しいトランザクションが作成され、直ちに開始されます。次のコマンドを実行します。 Windowsの場合:

curl -X POST "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id" \
-H "accept: text/plain" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@1page_invoiceUS_86.pdf;type=application/pdf"

curl -X POST "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id" \
-H "accept: text/plain" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@1page_invoiceUS_86.pdf;type=application/pdf"

curl -X POST "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id" \
-H "accept: text/plain" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@1page_invoiceUS_86.pdf;type=application/pdf"

Linuxの場合:

curl -X POST 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Files=@1page_invoiceUS_86.pdf;type=application/pdf'

curl -X POST 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Files=@1page_invoiceUS_86.pdf;type=application/pdf'

curl -X POST 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/launch?skillId=skill-id' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Files=@1page_invoiceUS_86.pdf;type=application/pdf'

ファイルをVantageにアップロードすると、ファイル名に含まれる次のすべての文字はアンダースコアに置き換えられます：:/?#[]@!$&'()*+,;=\。変更後のファイル名は、Vantage APIとSkill Monitorの両方に表示されます。

Transaction Status の監視

短いタイムアウトを設定したループで Transaction Status の監視を開始するには (ステータスの確認は1秒に1回以下にすることを推奨します) 、リクエストURIにトランザクション識別子を指定して、transactions/<transaction_id> リソースに GET リクエストを送信します。

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id

次のコマンドを実行します。 Windows の場合:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

Linux の場合:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

レスポンスは次のようになります。 レスポンス:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-eu.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing", 
   "manualReviewLink": "https://vantage-au.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.JPG"
      }
   ]
}

レスポンスには次の情報が含まれます。

status キーの値が Processing の場合、結果はまだ準備できていません。トランザクションのステータスが Processed に変わると、結果をダウンロードできるようになります。
manualReviewLink キーには、手動確認クライアントの Web インターフェイスへのリンクと、手動確認が必要な場合は Vantage の access token が含まれます。このリンクとトークンを使用すると、特定のトランザクションの分類結果およびフィールド抽出結果を確認して修正できます。確認が完了するまで、status キーの値は Processing に設定されます。提供されるリンクの有効期間は 168 時間です。期限切れ後は、同じ方法でさらに 168 時間有効な新しいリンクを作成して取得する必要があります。詳細は手動確認の統合を参照してください。

このリンクを使用して認証されたユーザーは、他のドキュメントやトランザクションを表示または変更できません。

Document skill の場合、レスポンスは次のようになります。 レスポンス:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "resultFiles": [
            {
               "fileId": "3a3e6245-48e1-489a-9fef-a10b5ba28515",
               "type": "Json"
            }
         ],
         "businessRulesErrors": []
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

documents array では、各ドキュメントに resultFiles array があります。この array を使用して fileId の値を取得します。出力ファイルの形式は、使用する skill によって決まります。現在、すべての Skill は JSON 形式で抽出されたフィールドを返します。分類スキルの場合、ドキュメントの処理後に受信するレスポンスは次のようになります。 レスポンス:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processed",
   "documents": [
      {
         "id": "9838448d-72ae-4e9a-b071-2bb16f732e46",
         "classification": {
            "isResultClassConfident": true,
            "resultClass": {
               "id": "8f2a51d4-6c0b-4e2a-9d3e-5b7c1a9f0e64",
               "name": "Invoice"
            },
            "classConfidences": [
               {
                  "classId": "8f2a51d4-6c0b-4e2a-9d3e-5b7c1a9f0e64",
                  "className": "Invoice",
                  "confidence": 89
               },
               {
                  "classId": "2c9d7e01-4b3a-4f6c-8a15-d0e6f2b8c473",
                  "className": "PurchaseOrder",
                  "confidence": 32
               }
            ]
         }
      }
   ],
   "sourceFiles": [
      {
         "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
         "name": "Invoice07.jpg"
      }
   ]
}

ドキュメントの class は resultClass.name キーから取得し、各候補 class の confidence は confidence キーで確認します (0 ～ 100 の整数) 。 Process skill の場合、Process skill で使用可能な stages に応じて、Document skill および分類スキルで返される情報のすべてまたは一部がレスポンスに含まれることがあります。

ソースファイルと結果ファイルのダウンロード

処理の完了後、2 種類のファイルをダウンロードできます。

ソースファイル — アップロードした元のファイルです。元のバイナリ形式で返されます。
結果ファイル — 処理結果です。既定では、抽出データが JSON 形式で返されます (出力形式は Skill で設定されます)。

ソースファイルと結果ファイルでは、それぞれ異なる endpoint と異なるファイル識別子を使用します。

ソースファイル — GET transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download。ファイル ID は、GET transactions/<transaction-id>/documents のレスポンス (sourceFiles[].id) から取得します。
結果ファイル — GET transactions/<transaction-id>/files/<file-id>/download。ファイル ID は、Transaction Status のレスポンス内の resultFiles 配列 (documents[].resultFiles[].fileId) から取得します。

識別子付きのドキュメント一覧を取得するには、transactions/<transaction-id>/documents リソースに GET リクエストを送信し、トランザクション識別子を指定します。

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents

次のコマンドを実行します。 Windows の場合:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"

Linux の場合:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'

ソースファイル

必要なソースファイルをダウンロードするには、transactions/<transaction-id>/documents/<document-id>/sourceFiles/<file-id>/download リソースに GET リクエストを送信し、トランザクション、ドキュメント、ファイルの識別子 (直前のレスポンスで取得) を指定します。

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download

次のコマンドを実行します。 Windows の場合:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download" \
-H "Authorization: Bearer token"

Linux の場合:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles/file-id/download' \
-H 'Authorization: Bearer token'

レスポンスには、バイナリ形式のファイルが含まれます。すべてのソースファイルに対してこの手順を繰り返します。

結果ファイル

結果ファイルをダウンロードするには、transactions/<transaction-id>/files/<file-id>/download リソースに GET リクエストを送信し、トランザクション識別子と結果ファイルの fileId を指定します。fileId は、Transaction Status の監視時に返される resultFiles 配列から取得します (各エントリには fileId と type (Json など) が含まれます) 。

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

次のコマンドを実行します。 Windows の場合:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

Linux の場合:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

概要

開発者ガイド

単一の API コールでドキュメントを処理する

利用可能なすべてのSkillの一覧を取得する

トランザクションの作成と開始

Transaction Status の監視

ソースファイルと結果ファイルのダウンロード

ソースファイル

結果ファイル

​利用可能なすべてのSkillの一覧を取得する

​トランザクションの作成と開始

​Transaction Status の監視

​ソースファイルと結果ファイルのダウンロード

​ソースファイル

​結果ファイル

利用可能なすべてのSkillの一覧を取得する

トランザクションの作成と開始

Transaction Status の監視

ソースファイルと結果ファイルのダウンロード

ソースファイル

結果ファイル