メインコンテンツへスキップ
PDF4me API統合AIとSDK知識ベース拡張機能APIテスターブログ

Word文書からメタデータを抽出する - 文書分析 API

PDF4me Wordからメタデータを抽出する 詳細な文書分析機能により、Word文書から包括的なメタデータとプロパティを抽出できます。 API このサービスは、Word ファイルを処理し、組み込みのドキュメント プロパティ、カスタム プロパティ、ドキュメント統計、作成者情報、作成日、および改訂履歴を取得します。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全な送信のためのエンコード機能。文化固有のフォーマットとローカライズに対応しているため、文書管理、コンプライアンス追跡、コンテンツ分析、および企業文書ワークフローに最適です。

関連ブログ記事
この機能に関するブログ記事はまだありません。近日公開予定です。
その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。
ブログをご覧ください →

認証 API リクエスト​

アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。

Get your api Key

主な機能​

  • 包括的なメタデータ抽出組み込みおよびカスタムのドキュメントプロパティをすべて取得します。
  • 文書統計リアルタイムのページ数、単語数、文字数、段落数を取得します。
  • 著者情報著者、管理者、会社、連絡先情報を抽出します。
  • 日付/時刻プロパティ作成、変更、印刷のタイムスタンプを取得します。
  • カスタムプロパティ: 自動プレフィックス付きで全てのカスタムドキュメントプロパティにアクセス
  • 文化支援: 指定されたロケールに従って日付と時刻をフォーマットします
  • 読み取り専用操作: 元の文書を変更せずにメタデータを抽出する
  • 構造化出力: 整理されたメタデータを返す JSON 処理しやすい形式

REST API 終点​

の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのメタデータ抽出操作は、単一のエンドポイントを介して実行されます。

  • 方法： POST
  • 終点： office/ApiV2Word/ExtractMetadata

REST API パラメータ​

Wordからメタデータを抽出するためのパラメータの完全なリスト REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。

パラメータ必須その機能例
documentRequiredSource file. `Name` must end in `.docx` or `.doc`.{ "Name": "document.docx" }
document.NameRequiredFile name including its extension. Type: string.{ "Name": "document.docx" }
docContentRequiredThe source file, base64-encoded. Type: string.UEsDBBQABgAIAAAA...
isAsyncOptionalProcess the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean.
cultureNameOptionalCulture used to format the dates, e.g. `en-US` or `de-DE`. Type: string.en-US

出力​

の PDF4me Wordからメタデータを抽出する REST API 処理モードに基づいて異なる応答を返します。 API メタデータをとして返します JSON 物体バイナリデータとしてではなく。

同期処理（デフォルト）

の API リクエストを処理し、以下を返します。

ステータスコード: 200 OK

コンテンツタイプ: application/json

応答本文：

{
"document": null,
"fileName": null,
"success": true,
"errorMessage": null,
"metadata": {
"Author": "John Doe",
"Title": "Project Proposal",
"Subject": "Q1 2024 Planning",
"Keywords": "planning, budget, strategy",
"Comments": "Draft version for review",
"Category": "Business",
"Company": "Acme Corporation",
"Manager": "Jane Smith",
"Created": "1/15/2024 10:30:00 AM",
"LastModified": "1/20/2024 2:45:00 PM",
"LastPrinted": "1/18/2024 9:15:00 AM",
"RevisionNumber": 3,
"TotalEditingTime": 120,
"Pages": 8,
"Words": 2150,
"Characters": 12800,
"Paragraphs": 45,
"Custom_Department": "Marketing",
"Custom_ProjectCode": "PRJ-2024-001",
"Custom_Confidential": "Internal"
}
}

回答欄:

  • 書類 （Base64 メタデータ抽出には使用されません。null の場合があります。
  • ファイル名 （文字列またはnull）：メタデータ抽出には使用されません。nullの場合があります。
  • 成功 （ブール値）：リクエストが成功したかどうかを示します。
  • エラーメッセージ （文字列またはnull）：成功がfalseの場合のエラーの詳細
  • メタデータ （オブジェクト）：すべてのドキュメントプロパティを含む包括的なメタデータ辞書

使用方法：

  1. 抽出する metadata からのフィールド JSON 応答
  2. 必要に応じて個々の物件にアクセス
  3. メタデータは、文書の分類、コンプライアンスの追跡、または分析に使用されます。

例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
const author = data.metadata.Author;
const pageCount = data.metadata.Pages;
// Access any metadata property

メタデータプロパティ​

組み込みドキュメントプロパティ​

物件名タイプ説明例
著者String文書作成者名"John Doe"
タイトルString文書タイトル"Project Proposal"
主題String文書の主題"Q1 2024 Planning"
キーワードString文書キーワード（カンマ区切り）"planning, budget, strategy"
コメントString文書コメント"Draft version for review"
カテゴリString文書カテゴリ"Business"
会社String会社名"Acme Corporation"
マネージャーStringマネージャー名"Jane Smith"
作成済みString文書作成日時（書式設定済み）"1/15/2024 10:30:00 AM"
最終更新日String最終保存日時（フォーマット済み）"1/20/2024 2:45:00 PM"
最終印刷日String最終印刷日時（書式設定済み）"1/18/2024 9:15:00 AM"
改訂番号Integer文書改訂番号3
総編集時間Integer編集にかかった合計時間（分）120

文書統計​

物件名タイプ説明例
ページInteger総ページ数8
言葉Integer総単語数2150
キャラクターInteger合計文字数12800
段落Integer段落の総数45

カスタムプロパティ​

カスタムプロパティには、 Custom_ 回答の中で：

  • Custom_Department - 税関部門の所有物
  • Custom_ProjectCode - カスタムプロジェクトコードプロパティ
  • Custom_Confidential - 顧客の機密レベル
  • Word文書で定義されているその他のカスタムプロパティ

サポートされている文化の例​

カルチャーコード説明日付形式の例
en-US英語（アメリカ合衆国）「2024年1月15日 午前10時30分」
en-GB英語（イギリス）「2024/01/15 10:30:00」
de-DEドイツ語（ドイツ）「2024年1月15日 10:30:00」
fr-FRフランス語（フランス）「2024/01/15 10:30:00」
es-ESスペイン語（スペイン）「2024/01/15 10:30:00」
ja-JP日本語（日本）「2024/01/15 10:30:00」

リクエスト例​

ヘッダ​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

注記：

  • 手に入れよう API 鍵から PDF4me ダッシュボード
  • の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
  • 例: API 重要なのは abc123エンコードして Base64 そして使用する Authorization: Basic YWJjMTIz

ペイロード​

基本的な例（必須項目のみ）：

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

高度な例（オプションフィールド付き）：

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "cultureName": "en-US"
}

コードサンプル​

の PDF4me Wordからメタデータを抽出する REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C# (CSharp) サンプル

完了 C# Wordからメタデータを抽出するための実装：

業界におけるユースケースとアプリケーション​

法律・専門サービスにおけるユースケース

  • 文書分類訴訟の種類、依頼者、または専門分野別に法的文書を分類する
  • コンプライアンス追跡: 規制遵守のため、文書の作成日と改訂履歴を監視する。
  • クライアント文書管理: クライアントファイルの整理のためにドキュメントのプロパティを追跡します
  • 監査証跡の保守: 法的監査要件のためのログ文書メタデータ

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started