文書を分類する
PDF4me 文書を分類する これにより、文書の内容に基づいて文書を分類および識別できます。 API サービスプロセス PDF ファイルとドキュメント構造、コンテンツパターン、メタデータを分析して、ドキュメントの種類とカテゴリを決定します。 API 受け取る PDF コンテンツを通じて REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能を搭載。文書タイプの識別と自動分類に対応しているため、文書管理システムや自動化されたワークフローに最適です。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- 文書分類: コンテンツ分析に基づいて文書の種類を識別および分類する
- コンテンツ分析文書構造、コンテンツパターン、メタデータを分析する
- 複数の文書タイプ: さまざまなサポート PDF 文書フォーマット
- 自動処理手作業による介入なしに文書分類を効率化
- 単純 API 統合: 安らかな API 自動化された文書処理ワークフロー向けに設計されています
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするための方法。すべての文書分類操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
/api/v2/ClassifyDocument
REST API パラメータ
文書分類のパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| jobIdExt | Optional | Your own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string. | |
| integrations | Optional | Integration identifiers, forwarded unchanged with the job's notification settings. Type: array. | |
| isAsync | Optional | Set to `true` to process the action asynchronously and get a job to poll at `/api/v2/GetActionStatus`. Only honoured by actions that support asynchronous processing. Type: boolean. | true |
| docName | Optional | Source file name including its extension. Several actions dispatch on the extension, so it should always be set; when omitted a per-action default is used. Type: string. | output.pdf |
| docContent | Required | The source file. Accepts the base64-encoded file content, a `pdf4meblobid://<id>` reference to a previously uploaded blob, or an `https` URL to the source document. Required: an empty value fails with `File is empty`. Type: string. | JVBERi... |
| docContentBytes | Optional | Alternative raw byte payload for the source file. Type: string. | |
| callBackUrl | Optional | Optional URL notified when an asynchronous job completes. Type: string. | |
出力
の PDF4me 文書を分類する REST API 処理モードに基づいて異なる応答を返します。 API 分類データを JSON 応答。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
いつ async は false または提供されていない場合、 API 分類結果を即座に返します。
ステータスコード: 200 OK
回答形式:
{
"documentType": "invoice",
"category": "financial",
"confidence": 0.95,
"metadata": {
"pageCount": 1,
"createdDate": "2024-01-15T10:30:00Z"
}
}
応答には、文書の種類、カテゴリ、信頼度スコア、メタデータ情報などの分類データが含まれています。
非同期処理
いつ async は true、 API ドキュメントを非同期的に処理します。
初期対応:
ステータスコード: 202 Accepted
レスポンスヘッダー:
Location: https://api.pdf4me.com/api/v2/ParseDocumentStatus/{operationId}
応答本文:
{
"traceId": "operation-trace-id"
}
結果発表のための世論調査:
使用する Location ヘッダー URL 完了をポーリングする:
const response = await fetch(locationUrl, {
headers: { 'Authorization': 'Basic ' + apiKey }
});
// Continue polling until status code is 200
if (response.status === 200) {
const result = await response.json();
// Process classification results
}
エラー応答
| ステータスコード | 説明 | 回答例 |
|---|---|---|
| 400 Bad Request | 無効なリクエストパラメータ、または必須フィールドが欠落しています | {"error": "Missing required parameter: docContent"} |
| 401 Unauthorized | 無効または欠落 API 鍵 | {"error": "Unauthorized"} |
| 408 リクエストタイムアウト | リクエスト処理タイムアウト | {"error": "Request timeout"} |
| 500 Internal Server Error | 処理中にサーバーエラーが発生しました。 | {"error": "Internal server error"} |
理解する JSON 応答
分類応答は JSON 文書に関する構造化データを含むオブジェクト:
- ドキュメントタイプ: 識別された文書の種類(例:「請求書」、「契約書」、「報告書」)
- カテゴリ文書のカテゴリ(例:「財務」、「法律」、「ビジネス」)
- 自信分類の信頼度を示すスコア(0.0~1.0)
- メタデータページ数、作成日などの追加文書情報。
デコード Base64 内容(存在する場合):
応答に以下が含まれる場合 Base64-エンコードされたコンテンツは、以下を使用してデコードします。
// JavaScript
const decoded = atob(base64String);
# Python
import base64
decoded = base64.b64decode(base64_string).decode('utf-8')
リクエスト例
ヘッダ
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
注記:
- 手に入れよう API 鍵から PDF4me ダッシュボード
- の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
- 例: API 重要なのは
abc123エンコードして Base64 そして使用するAuthorization: Basic YWJjMTIz
ペイロード
基本的なリクエスト:
{
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"docName": "output.pdf"
}
非同期処理の場合:
{
"docContent": "JVBERi0xLjQKJeLjz9MK...",
"docName": "output.pdf",
"async": true
}
コードサンプル
の PDF4me 文書を分類する REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
文書分類機能
分類機能
- 文書タイプの検出: コンテンツ分析に基づく文書タイプの識別
- コンテンツの分類: 内容と目的による文書のグループ化
- テンプレート認識文書テンプレートと標準フォーマットの識別
- コンプライアンス分類規制およびコンプライアンス要件のための分類
エンタープライズ機能
- バッチ処理: 複数の文書を一貫した分類基準で処理する
- 品質保証ビジネスアプリケーションにおける分類の正確性と信頼性を確保する
- 統合準備完了既存の文書管理システムとのシームレスな統合
- スケーラブルな処理: エンタープライズグレードのパフォーマンスで大量のドキュメントを処理
業界におけるユースケースとアプリケーション
- Document Management & Organization
- Compliance & Regulatory
- Business Process Automation
- Financial Services
- Healthcare & Medical
- Legal & Professional Services
文書管理と整理のユースケース
- 自動ファイリングデジタルファイルシステム内の文書を自動的に分類・整理する
- コンテンツ管理コンテンツ管理および検索システムのための高度なカテゴリ分類
- アーカイブ組織歴史的文書および記録の体系的な分類
- 検索エンジン最適化: 正確な分類とタグ付けによる文書検索機能の強化
コンプライアンスおよび規制関連のユースケース
- 監査準備コンプライアンスおよび監査目的のための文書の自動分類
- 規制報告規制当局への提出書類処理の効率化
- 法的証拠開示法的証拠開示および訴訟支援のための効率的な文書分類
- ポリシー遵守組織の方針に対する文書の準拠状況の自動検証
ビジネスプロセス自動化のユースケース
- ワークフロールーティング分類結果に基づく文書の自動ルーティング
- プロセス最適化高度な分類機能を備えた、効率化された文書処理ワークフロー
- 品質管理文書の種類と内容の正確性を自動的に検証する
- リソース割り当て文書タイプに基づいた処理リソースの効率的な割り当て
金融サービスにおけるユースケース
- 請求書処理請求書、領収書、財務書類の自動分類
- ローン関連書類ローン申請および関連書類の処理を効率化
- 税務申告税務関連書類およびフォームの自動分類
- 監査サポート財務監査およびレビューのための効率的な文書整理
ヘルスケアおよび医療分野における活用事例
- 患者記録医療記録および患者文書の自動分類
- 保険金請求保険金請求および医療文書の処理の効率化
- コンプライアンス文書医療規制遵守のための自動分類
- 研究データ医学研究および臨床試験文書の体系的な整理
法律・専門サービスにおけるユースケース
- 契約管理契約書および法的合意書の自動分類
- 事例記録訴訟記録ファイルおよび関連書類の効率的な整理
- コンプライアンス監視規制遵守と監視のための自動分類
- クライアントドキュメント顧客ファイルと専門文書の処理を効率化