個別の API コールで Document を処理する

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.

トランザクションの作成、ファイルのアップロード、トランザクションの開始など、個別の API コールを使用して Document を処理する一般的なシナリオは、次の手順で構成されます。

1. 利用可能なすべての Skill の一覧を取得する
2. 空のトランザクションを作成する
3. トランザクション内で処理するファイルのセットを追加する
4. トランザクションを開始する
5. トランザクションのステータスを監視する
6. ソースファイルと結果ファイルをダウンロードする

各リクエストには、アクセストークンなどの認証情報を必ず含める必要があります。詳細については、認証 を参照してください。 そのためには、skills リソースに GET リクエストを送信します。 次のコマンドを実行します： その結果、アプリケーション インスタンスに追加されたすべての Skill の情報が返されます。 transactions リソースに次の POST リクエストを送信します。 次のコマンドを実行します： リクエストの本文に、前の API 呼び出しで返された skillId Parameter を指定します。これにより、作成されたトランザクションの id を含むレスポンスが返されます。 重要: 1 つのトランザクションに含められるファイルの最大数は 1000 件です。 ファイルセットの追加方法は次の 2 通りです:

• トランザクションへ直接追加
• Document に追加してから、その Document をトランザクションに追加

その場合は、POST リクエストを transactions/<transaction-id>/files リソースに送信します。 次のコマンドを実行します： その結果、追加されたファイルとその識別子の一覧を含むレスポンスが返ってきます。この呼び出しを複数回繰り返すことで、必要な数だけファイルを追加できます。 ファイルのアップロードに関する追加オプション:

• 追加した画像の編集
• ファイルとドキュメントの順序の設定

まず、POST リクエストを transactions/<transaction-id>/documents リソースに送信して、ドキュメントを作成します。 その結果、Document 識別子を含むレスポンスが返されます。 次に、transactions/<transaction-id>/documents/<document-id>/sourceFiles リソースに POST リクエストを送信して、Document にファイルを追加します。 指定した Skill とファイルでトランザクションを開始するには、transactions/<transaction-id>/start リソースに次の POST リクエストを送信します。 短いタイムアウトを設定したループでトランザクションのステータス監視を開始するには (1秒より高頻度の確認は推奨しません) 、リクエストURIにトランザクション識別子を含めて transactions/<transaction_id> リソースへ GET リクエストを送信します。 その結果、トランザクションのステータスを含むレスポンスが返されます。トランザクション処理のステータスは次のいずれかです。

• New。トランザクションは作成されていますが、まだ処理キューに入っていません。
• Queued。トランザクションは処理のためにキューに入っています。
• InProgress。トランザクションは処理中です。
• Processed。トランザクションは正常に処理完了しました。
• ProcessedWithWarnings。トランザクションは処理されましたが、警告が発生しました。
• NotProcessed。エラーのため、トランザクションは処理されませんでした。
• Deleted。トランザクションはユーザーによって、または保持ポリシーにより自動的に削除されました。

トランザクションのステータスが Processed または ProcessedWithWarnings の場合、手順 6 に進みます。 ドキュメントの識別子を含む一覧を取得するには、transactions/<transaction-id>/documents リソースに GET リクエストを送信し、トランザクションの識別子を指定します。 その結果、このトランザクション内で作成されたドキュメントの一覧が返されます。レスポンスにはこれらのドキュメントの識別子も含まれており、特定のドキュメントの詳細情報を取得する際に必要になる場合があります。 特定のドキュメントに追加されたファイルの一覧を取得するには、transactions/<transaction-id>/documents/<document-id> リソースに GET リクエストを送信します。 その結果、Document に関する情報が返されます。レスポンスには、Document に追加されたファイルの識別子も含まれます。 ソースファイルをダウンロードするには、transactions/<transaction-id>/files/<file-id>/download リソースに GET リクエストを送信します。