Api Reference File Processing — Self-hosted Deployment

介绍

本章节介绍目前 ComPDF AI 相关功能接口的介绍

ComPDF AI的优势

• 24个标签检测: 基于AI训练，我们的算法能够使用24个标签识别和分类页面元素。
• 保留原始逻辑: 我们强大的排序算法可以保留原始的阅读结构和逻辑。
• 分析和解析数据: 智能解析和分析数据供下游应用，如自动生成报告或接入问答系统。
• 支持GPU和CPU: 支持私有化部署ComPDF AI，并利用GPU和CPU加速文档处理。

智能文档抽取 - sync

提取文档中关键信息字段和表格信息。支持的文件格式：PDF，JPG，JPEG，PNG。

请求方式：

• 请求方式：POST。
• 传参方式：Body (form-data)。

请求地址：

http://lcoalhost:7000/api/idp/data-extract-api

请求头参数：

参数名	数据类型	描述	是否必填
API_KEY	String	License Key	是

请求Body参数：

参数名	数据类型	描述	是否必填
file	File	源文档。	是
keys	array[string]	关键信息字段。	否
tableHandles	array[string]	表头字段。	否
keysDescribe	array[string]	关键信息字段附加描述，和keys中元素下标一一对应，没有的描述填充""空字符串。	否
tableHandlesDescribe	array[string]	表头字段附加描述，和tableHandles中元素下标一一对应，没有的描述填充""空字符串。	否

当 keys 和 tableHandles 都不存在时，提取文件中所有关键信息。

JSON内容解释

返回参数	数据类型	描述
code	Int	错误码，200 代表成功
message	String	错误信息
data	Object	返回结果
+details	Object	关键信息提取结果
++pages	Object	当前页码，Page-Index
+++key	String	关键信息字段提取结果，key:value
+++tables	Array	关键信息表格提取结果，tables:[ [table1], [table2] ]

JSON结构示例：

{
    "code": 200,
    "msg": "success",
    "data": {
        "details": {
            "Page-1": {
                "Invoice Number": "202401291234567890",
                "Invoice Date": "01/29/2024",
                "Zip Code": "92868",
                "Company Name": "PDF Technologies, Inc.",
                "Tax": "5%",
                "Total Excluding Tax": "$ 20.40",
                "Total": "$ 428.40",
                "tables": [
                    [
                        {
                            "Num": "1",
                            "Products": "ComPDFKit API",
                            "Payment Cycle": "Package Payments",
                            "Gear Level": "5000",
                            "Price": "$ 408.00"
                        }
                    ]
                ]
            }
        }
    }
}

智能文档解析 - sync

解析文档结构，输出结构化Json数据。支持的文件格式：PDF，JPG，JPEG，PNG。

请求方式：

• 请求方式：POST。
• 传参方式：Body (form-data)。

请求地址：

http://lcoalhost:7000/api/idp/api-file-resolve-api

请求头参数：

参数名	数据类型	描述	是否必填
API_KEY	String	License Key	是

请求Body参数：

参数名	数据类型	描述	是否必填
file	File	源文档。	是

JSON内容解释

返回参数	数据类型	描述
code	Int	错误码，200 代表成功
message	String	错误信息
data	Object	返回结果
+fileId	String	File ID
+downFileUrl	String	文档解析结果URL。

响应结果结构示例：

{
    "code": 200,
    "message": "success",
    "data": {
        "fileId": "42b3f995dd890ba9533d1bdcbb4c7246",
        "downFileUrl": "http://localhost:7000/api/idp/get-file?path=%2FComPDF AI%2Fserver%2Fout_tmp%2F979796629%2FTEST%282%29_ComPDF AI_batch_parse.zip"
    }
}

文件解析标签详情见： ComPDF AI智能文档解析字段介绍