ドキュメントを解析する

抽出する → ドキュメントを解析する

の ドキュメントを解析する API 構造化データを抽出する PDF 作成したテンプレートを使用して PDF4me ダッシュボード。送信します。 docContent （オプション。省略した場合、ドキュメントは以下によって取得されます。） docName) docName、 TemplateId （GUID） または TemplateName、 ParseId （GUID）、そしてオプションで async. API リターン JSON 解析済みデータ（文書タイプ、ページ数、抽出フィールド）を使用します。以下のテスターを使って試してみてください。詳細は後続のセクションをご覧ください。

ドキュメントの解析を試してください API

:::注記 クイックリファレンス 終点： POST /api/v2/ParseDocument ・ 必須： api-key、 docName、 TemplateId （または TemplateName) ParseId :::

ライブで試してみましょう

以下のフォームを使用して送信してください API 鍵、 PDF （Base64 または参照される docNameテンプレートIDまたは名前、および解析ID。レスポンスは JSON 解析済みのドキュメントデータを使用します。コードは不要です。フィールドに入力してクリックしてください。 リクエストを送信。

Loading API Tester...

概要、パラメータ、および使用例

Overview

ドキュメント解析とは何ですか？

このエンドポイントは、 PDF 使用 テンプレートを解析します あなたが作成するもの PDF4me ダッシュボード。 PDF （docContent オプション。省略した場合、ドキュメントは以下によって取得されます。 docName) docName、 TemplateId （GUID） または TemplateName、 そして ParseId （GUID) API リターン JSON テンプレートのキャプチャ領域とキーに基づいて、ドキュメントの種類、ページ数、抽出フィールドを指定します。

主な機能

• テンプレートベースダッシュボードでテンプレートを作成する：サンプルをアップロードする PDFキャプチャ領域を描画し、キーと正規表現を設定します。
• TemplateId または TemplateNameテンプレートを使用する GUID またはダッシュボードから名前を選択してください。
• ParseId： 個性的 GUID 解析操作ごと（クライアント側で生成するか、 API-提供された）。
• 構造化された出力: JSON 文書の種類、ページ数、および抽出された構造化データを含む。

テンプレートIDと解析IDを取得する

1. アクセス PDF4me ダッシュボード: 行く ドキュメントを解析します ページ。
2. テンプレートを作成する「追加」をクリックしてテンプレート名を入力し、保存してください。
3. テンプレートの設定テンプレートをアップロードする PDFキャプチャ領域を描画し、キーと正規表現を設定し、解析をテストして保存します。
4. テンプレートIDを取得する: ユニークなものをコピーする GUID テンプレート用（または使用） TemplateName)
5. 解析IDを生成する: ユニークなものを作成する GUID 各解析操作（クライアント側またはツール経由）ごとに。

:::ヒント 最適な用途 繰り返し発生する文書タイプ（請求書、フォームなど）があり、構造化された抽出が必要な場合に使用してください。以下の機能と組み合わせて使用してください。 文書を分類するタイプ別にルーティングし、適切なテンプレートで解析する。 :::

Parameters

API パラメータ

パラメータ	タイプ	必須	説明
api-key	弦	はい	あなたの PDF4me API 鍵、 Base64 エンコードされています。 ダッシュボード。
docContent	ベース64	いいえ	PDF ファイルの内容（Base64)省略した場合、ドキュメントは以下によって取得されます。 docName。
docName	弦	はい	PDF ファイル名に拡張子「.pdf」を付けます。
TemplateId	弦	はい*	個性的 GUID 解析テンプレート（ダッシュボードから）の場合。*使用方法 TemplateId または TemplateName。
TemplateName	弦	いいえ	テンプレート名（代替） TemplateId)
ParseId	弦	はい	個性的 GUID この解析操作の場合。
async	ブール値	いいえ	非同期処理を有効にする。

Use cases

Parse Document を使用するタイミング

• 請求書と各種用紙: 繰り返し発生する文書タイプから構造化フィールド（金額、日付、ベンダー）を抽出します。
• 文書自動化テンプレートを使用して類似のデータを取得します PDFs の中へ CRM、 ERPまたはデータベース。
• コンプライアンス標準化された文書から、保存または監査に必要な主要項目を抽出する。

フルが必要API？

リクエスト/レスポンスのスキーマとコードサンプルについては、以下を参照してください。 ドキュメントを解析する で PDF4me APIドキュメント。

前提条件

このエンドポイントを使用する前に、以下のものを用意してください。

• 有効な PDF4me API 鍵 （手に入れよう API 鍵）
• A PDF ドキュメント Base64 フォーマットまたはパブリック URL へ PDF ファイル
• A テンプレートを解析します あなたの PDF4me ダッシュボード（解析テンプレートを作成する）
• あなたには テンプレートID （GUID） または テンプレート名 解析テンプレートから
• A IDを解析 （GUID解析操作の場合

回答形式

の API を返します JSON ドキュメントの種類、ページ数、抽出された構造化情報など、解析済みのドキュメントデータを含むレスポンス。

ヘルプが必要な場合

Get Your API KeyFull DocumentationAPI Tester Home