跳到主要内容
PDF4me API集成知识库扩展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 正常运作。

必需参数​

范围类型描述例子
文档*Object文件参考。必须包含 姓名 （字符串）：扩展名为 .docx 的 Word 文件名{ "Name": "document.docx" }
文档内容*Base64Word文档内容编码 Base64UEsDBBQABgAIAAAA...

可选参数​

范围类型描述例子
文化名称String日期/时间格式的区域性代码（例如，“en-US”、“de-DE”、“fr-FR”）。默认值：InvariantCulture（统一格式）。影响元数据中的日期/时间显示格式。无效的区域性代码将回退到 InvariantCulture。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
  • 成功 （布尔值）：指示请求是否成功
  • 错误信息 （字符串或 null）：成功失败时的错误详情
  • 元数据 （对象）：包含所有文档属性的综合元数据字典

使用方法：

  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:00”
en-GB英语（英国）“2024年1月15日 10:30:00”
de-DE德国（德国）“2024年1月15日 10:30:00”
fr-FR法语（法国）“2024年1月15日 10:30:00”
es-ES西班牙语（西班牙）“2024年1月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