分类文件
PDF4me 分类文件 使您能够根据文档内容对其进行分类和识别。 API 服务流程 PDF 它分析文件并研究文档结构、内容模式和元数据,以确定文档类型和类别。 API 接收 PDF 通过内容 REST API 利用电话 Base64 采用编码技术实现安全传输。该解决方案支持文档类型识别和自动分类,是文档管理系统和自动化工作流程的理想之选。
验证您的身份 API 要求
要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份。 REST API。
主要特点
- 文件分类基于内容分析识别和分类文档类型
- 内容分析分析文档结构、内容模式和元数据
- 多种文档类型支持各种 PDF 文档格式
- 自动化处理:无需人工干预即可简化文档分类
- 简单的 API 一体化RESTful API 专为自动化文档处理工作流程而设计
REST API 端点
这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有文档分类操作均通过单个端点执行:
- 方法: POST
- 终点:
/api/v2/ClassifyDocument
REST API 参数
分类文档的完整参数列表 REST API参数按类别组织,以便更好地理解和实施。
重要的: 标有星号 (*) 的参数为必填项,必须提供。 API 正常运作。
必需参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| docContent* | Base64 (String) | 输入的内容 PDF 文件编码为 Base64 文档分析和分类处理格式 | JVBERi... |
| docName* | String | 来源 PDF 文件名应带有正确的 .pdf 扩展名,以便识别和处理文档。 | output.pdf |
可选参数
| 范围 | 类型 | 描述 | 例子 |
|---|---|---|---|
| async | Boolean | 启用异步处理。 true, 这 API 返回 202 Accepted 与一个 Location 用于轮询结果的标头 | true |
输出
这 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
文档管理与组织应用案例
- 自动归档自动对数字文件系统中的文档进行分类和整理
- 内容管理内容管理和检索系统的高级分类
- 档案组织历史文献和记录的系统分类
- 搜索优化通过准确的分类和标记增强文档搜索功能
合规与监管应用案例
- 审计准备:出于合规性和审计目的对文档进行自动分类
- 监管报告简化监管申报文件的处理流程
- 法律取证高效的文档分类,助力法律取证和诉讼支持
- 政策合规性自动验证文件是否符合组织政策
业务流程自动化用例
- 工作流路由:基于分类结果的文档自动路由
- 流程优化:采用高级分类技术的精简文档处理工作流程
- 质量控制自动验证文档类型和内容准确性
- 资源分配基于文档类型高效分配处理资源
金融服务应用案例
- 发票处理发票、收据和财务文件的自动分类
- 贷款文件简化贷款申请及相关文件的处理流程
- 税务筹划自动对税务相关文件和表格进行分类
- 审计支持高效的财务审计和审核文件整理
医疗保健应用案例
- 患者记录医疗记录和患者文档的自动分类
- 保险索赔简化保险索赔和医疗文件的处理流程
- 合规文件医疗保健监管合规性的自动化分类
- 研究数据医学研究和临床试验文件的系统化整理
法律及专业服务用例
- 合同管理合同和法律协议的自动分类
- 案例文件高效整理法律案件档案及相关文件
- 合规性监控用于监管合规性和监控的自动化分类
- 客户文档简化客户文件和专业文档的处理流程