リクエスト

Postman ツールまたは curl を使用して API 要求をテストし、処理のために文書をサブミットし、リソースを削除することができます。ツールを使用して、状況の取得および出力のダウンロードを行うこともできます。

処理のための文書の送信
処理状況を取得しています
JSON 出力の取得
抽出された KVP の検証
リソースの削除
オントロジーのエクスポート

注: 問題がある場合は、 curlの最新バージョンにアップグレードしてください。

処理のための文書の送信

POST 要求を送信して、メタデータ、コンテンツ分析、および構造抽出のためのファイルを送信できます。

POST /v1/projects/{{ProjectId}}/analyzers

表 1. 文書を送信するための要件
プロパティー	データ・タイプ	Description
HTTP 基本認証ヘッダー	ストリング	リクエスト認証のために、 HTTP 基本認証形式でエンコードされたユーザーとパスワード。
ProjectId パス (必須)	ストリング	Document Processing プロジェクト ID。
ファイル本文 (必須)	ファイル	処理されるファイル。受け入れられる形式は PDF のみです。
docClass 本文 (オプション)	ストリング	現在のドキュメントのドキュメント・クラス・シンボル名を指定して、処理中にドキュメント分類をスキップできるようにします。
jsonOptions 本文	ストリング	`jsonOptions` 行は、オプションのコンマ区切りリストとして最終的な JSON コードに表示されます (その他の形式は無効です)。サポートされるオプション: ocr (ワード・ベースの光学式文字認識の場合) dc (文書分類の場合) kvp (キーと値のペア) sn (セマンティック正規化) hr (ヘッダー) th (表ヘッダー) mt (必須) ds (文書セグメンテーション) char (文字ベースの光学式文字認識) 重要: char オプションを使用すると、 `postprocessing` ポッドのメモリー使用量が多くなるため、プロセスがメモリー不足になり、停止する可能性があります。このオプションを使用する必要がある場合は、`postprocessing` ポッドに合わせて RAM をモニターおよび増設します。
uniqueId 本文 (オプション)	ストリング	最終的な出力に含める顧客の固有 ID。
webhookId 本文 (オプション)	ストリング	指定された Webhook ID。文書処理が完了すると、この Webhook に通知されます。

注:

この設計では、応答時間が標準 API 要求のタイムアウトより長くなる可能性がある文書サイズおよびシステム・アクティビティーが考慮されます。そのため、Automation Document Processing では、ほぼリアルタイムの応答のみが提供されます。受け入れられる最大ファイル・サイズは 250 MB です。
ファイル名に Unicode 文字が含まれているファイルの場合、API の呼び出しに使用されるコードで Unicode 文字を処理するようにしてください。そうしないと、エラー・コード CIWCA16001 が出されます。

文書を送信するための curl 要求の例

禅トークンあり

curl -k -X POST https://{{hostname:port}}/v1/projects/{{projectId}}/analyzers \
  --header "Authorization: Basic {{encodedCredential}}" \
  --form "file=@./test.pdf" \
  --form "responseType=json" \
  --form "jsonOptions=HR,DC,KVP,TH,OCR,SN,MT,CB,ST,DS"

処理状況を取得しています

GET 要求を送信して、analyzerId 値に基づいて処理の状況を取得することができます。 statusDetails パラメーターの状況値は、以下のとおりです。Completed,In Progress、またはFailed.

GET /v1/projects/{{ProjectId}}/analyzers/{{analyzerId}}

表 2. プロセスを取得するための要件
プロパティー	データ・タイプ	Description
HTTP 基本認証ヘッダー	ストリング	リクエスト認証のために、 HTTP 基本認証形式でエンコードされたユーザーとパスワード。
ProjectId パス (必須)	ストリング	Document Processing プロジェクト ID。
analyzerId パス (必須)	ストリング	各アナライザーの固有 ID。 POST /analyzers の応答から取得します。

処理状況を取得するための curl 要求の例

禅トークンあり

curl -k -X GET https://{{hostname:port}}/v1/projects/{{projectId}}/analyzers/{{analyzerId}} \
  --header "Authorization: Bearer {{encodedCredential}}"

JSON 出力の取得

GET 要求を送信して、analyzerId 値および照会に基づいて特定のコンテンツ JSON 出力を取得できます。

簡素化されたバージョン (キー・クラスごとに最適なキー値ペア):

GET /v1/projects/{projectId}/analyzers/{analyzerId}/json/basic

詳細バージョン (ランク順の各キー・クラスのすべての候補キー値ペア):

GET /v1/projects/{projectId}/analyzers/{analyzerId}/json/detail

完全 (詳細) バージョン:

GET /v1/projects/{{ProjectId}}/analyzers/{{analyzerId}}/json

表 3. JSON 出力を取得するための要件
プロパティー	データ・タイプ	Description
HTTP 基本認証ヘッダー	ストリング	リクエスト認証のために、 HTTP 基本認証形式でエンコードされたユーザーとパスワード。
ProjectId パス (必須)	ストリング	Document Processing プロジェクト ID。
analyzerId パス (必須)	ストリング	各アナライザーの固有 ID。 POST /analyzers の応答から取得します。

JSON 出力を取得するための curl 要求の例

禅トークンあり

ACA_URL=$(oc get route cpd -o jsonpath="{.spec.host}"/adp/aca) 
curl -k --location --request GET "https://${ACA_URL}/v1/projects/{{ProjectId}}/analyzers/{{analyzerId}}/json" \
--header "Authorization: Bearer $Zen_JWT"

抽出された KVP の検証

POST 要求を送信して、抽出された KVP (キーと値のペア) を検証できます。

POST /v1/projects/{{ProjectId}}/validator

表 4。抽出された KVP を検証するための要件
プロパティー	データ・タイプ	Description
HTTP 基本認証ヘッダー	ストリング	リクエスト認証のために、 HTTP 基本認証形式でエンコードされたユーザーとパスワード。
ProjectId パス (必須)	ストリング	Document Processing プロジェクト ID。
データ本文 (必須)	バイナリー	Classification および pageList が含まれたオントロジー JSON ファイル。 Classification には、DocumentLanguage、PageTitle、DocumentClass、および AlternateDocumentClass が含まれます。 pageList には主に KVPTable が含まれます。

抽出された KVP を検証するための curl 要求の例

禅トークンあり

curl -k -X POST https://{{hostname:port}}/v1/projects/{{projectId}}/validator \
  --header "Authorization: Bearer {{encodedCredential}}" \
  --header "Content-Type: application/json" \
  --data-binary "{{Path to JSON}}"

リソースの削除

DELETE 要求を送信して、analyzerId 値に基づいて、処理された文書および関連するすべての出力とパラメーターをデータベースから削除することができます。

DELETE /v1/projects/{{ProjectId}}/analyzers/{{analyzerId}}

表 5. リソースを削除するための要件
プロパティー	データ・タイプ	Description
HTTP 基本認証ヘッダー	ストリング	リクエスト認証のために、 HTTP 基本認証形式でエンコードされたユーザーとパスワード。
ProjectId パス (必須)	ストリング	Document Processing プロジェクト ID。
analyzerId パス (必須)	ストリング	各アナライザーの固有 ID。 POST /analyzers の応答から取得します。

リソースを削除する curl 要求の例

禅トークンあり

curl -k -X DELETE https://{{hostname:port}}/v1/projects/{{projectId}}/analyzers/{{analyzerId}} \
  --header "Authorization: Bearer {{encodedCredential}}"

オントロジーのエクスポート

GET 要求を送信して、例えば IBM Business Automation Workflowと統合するために、文書タイプ、フィールド、フィールド・タイプ定義などの定義を使用して簡易なオントロジーをエクスポートできます。

GET /v1/projects/{projectId}/ontology

オントロジーをエクスポートするための curl 要求の例

禅トークンあり

curl -k -X GET https://{{hostname:port}}/v1/projects/{{projectId}}/ontology \
  --header "Authorization: Bearer {{encodedCredential}}"