解析文档
提炼 → 解析文档
这 解析文档 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 使用已解析的文档数据。无需编写代码，只需填写字段并点击即可。 发送请求.
概述、参数和用例
- Overview
- Parameters
- Use cases
什么是文档解析？
此端点从中提取结构化数据 PDF 使用 解析模板 你在……中创造 PDF4me 仪表板。您提供 PDF （docContent 可选，如果省略，则文档将通过以下方式获取 docName）， docName， TemplateId （GUID） 或者 TemplateName， 和 ParseId （GUID）。 这 API 返回 JSON 根据模板的捕获区域和键，提取文档类型、页数和字段。
主要特点
- 基于模板在控制面板中创建模板：上传示例 PDF绘制捕获区域，配置键和正则表达式。
- TemplateId 或者 TemplateName使用模板的 GUID 或从仪表盘上获取名称。
- ParseId： 独特的 GUID 每个解析操作（客户端生成或使用） API-假如）。
- 结构化输出： JSON 包含文档类型、页数和提取的结构化数据。
获取模板和解析 ID
- 使用权 PDF4me 仪表板前往 解析文档 页。
- 创建模板点击“添加”，输入模板名称，然后保存。
- 配置模板上传模板 PDF绘制捕获区域，配置键和正则表达式，测试解析，然后保存。
- 获取模板 ID复制唯一 GUID 您的模板（或使用） TemplateName）。
- 生成解析 ID创造一个独特的 GUID 对于每个解析操作（客户端或通过工具）。
:::提示 最适合
当您有重复出现的文档类型（例如发票、表单）且需要结构化提取时，请使用此工具。可与以下工具结合使用： 分类文件 按类型路由，然后使用正确的模板进行解析。
:::
API 参数
| 范围 | 类型 | 必需的 | 描述 |
|---|---|---|---|
| api-key | 细绳 | 是的 | 你的 PDF4me API 钥匙， Base64 已编码。从……获取 仪表板。 |
| docContent | base64 | 不 | PDF 文件内容（Base64如果省略，则文档将通过以下方式获取 docName。 |
| docName | 细绳 | 是的 | PDF 文件名，扩展名为.pdf。 |
| TemplateId | 细绳 | 是的* | 独特的 GUID 用于解析模板（来自仪表板）。*使用 TemplateId 或者 TemplateName。 |
| TemplateName | 细绳 | 不 | 模板名称（替代名称） TemplateId）。 |
| ParseId | 细绳 | 是的 | 独特的 GUID 针对此解析操作。 |
| async | 布尔值 | 不 | 启用异步处理。 |
先决条件
使用此端点之前，请确保您已具备以下条件：
- 有效的 PDF4me API 钥匙 （获得你的 API 钥匙）
- A PDF 文档 Base64 格式或公共 URL 一个 PDF 文件
- A 解析模板 在您的 PDF4me 仪表板 （创建解析模板）
- 你需要 模板 ID （GUID） 或者 模板名称 从您的解析模板
- A 解析 ID （GUID) 用于解析操作
回复格式
这 API 返回一个 JSON 响应包含已解析的文档数据，包括文档类型、页数和提取的结构化信息。