Skip to content
DemoFAQ

PDF 生成模板编辑器

开源可视化 PDF 生成引擎,支持自定义模板,并提供面向开发者的 API,灵活构建文档生成流程。

查看 GitHub

设置 DocumentAI 模型 — C ​

DocumentAI 模型设置与模型包说明 ​

概述 ​

在使用 OCR、版面分析、表格识别、PDF 转可搜索 PDF 或 PDF 转 OFD 之前,需要通过 CPDF_SetDocumentAIModel 设置 DocumentAI 模型路径。模型以模型包的形式提供:一个基础包和若干扩展包。每次调用 CPDF_SetDocumentAIModel 只加载该文件里包含的能力,并与已加载的能力合并,不会替换。

CPDF_SetDocumentAIModel 的第二个参数 gpu_id 用于指定 AI 模型使用的 GPU 编号,-1 表示不使用 GPU。

c
CSDKErrorCode code = CPDF_SetDocumentAIModel(CPDF_TEXT("path/documentai.model"), -1);
if (code != e_CErrSuccess) {
    return code;
}

模型包说明 ​

所有模型包(含基础包)的下载地址:https://download.compdf.com/download/models

SDK 包内默认自带基础模型 documentai.model,使用默认配置无需额外下载。 需要更高精度的版本或扩展功能时,才需要额外下载对应的扩展模型包,放到您指定的目录,并通过 CPDF_SetDocumentAIModel 指定路径。

文件大小作用获取方式 / 何时需要
documentai.model约 230 MB基础包:版面分析、表格识别(均衡档位)、全部基础 OCR 语言SDK 包内默认自带;使用任何 AI 功能(版面分析、OCR、表格识别)都需要
table_legacy.model约 270 MB表格扩展包:高精度档位所需的有线 / 无线表格检测等资源需额外下载;仅在 table_recognition_accuracy 为 e_CHighAccuracy(高精度)时需要,使用默认的均衡档位不需要
ocr_server.model约 139 MB高精度 OCR 增强包,包含中文、英文、日文等多种语言需额外下载;需要更高精度的 OCR 识别时
document_process.model约 37 MB文档方向分类与倾斜矫正需额外下载;使用 enable_document_orientation_classification(方向识别)或 enable_document_dewarp(矫正)时需要

四个文件合计约 676 MB。不需要额外功能时无需下载任何扩展包:默认配置只使用 SDK 包内自带的 documentai.model。

分包增量加载 ​

所有模型包都通过同一个接口加载:

c
// 先加载基础包。
CPDF_SetDocumentAIModel(CPDF_TEXT("path/documentai.model"), -1);
// 需要时再加载扩展包,已加载的能力会保留。
CPDF_SetDocumentAIModel(CPDF_TEXT("path/table_legacy.model"), -1);
CPDF_SetDocumentAIModel(CPDF_TEXT("path/document_process.model"), -1);
  • 每次调用只加载该文件里包含的能力,与已加载的能力合并,不会替换。加载顺序没有限制。
  • 某个包加载失败时,保留之前已加载的能力,并返回具体错误码,不会静默降级。
  • 调用 CPDF_ReleaseDocumentAIModel 会释放全部已加载的模型;之后再使用 AI 功能需要重新加载。
  • 转换任务进行中,或释放尚未完成时,再次加载会被拒绝并返回 e_CErrConverting。

版本配套要求 ​

  • 模型包必须与 SDK 版本配套。SDK 包内自带的 documentai.model 已是 4.3.0 配套的版本;额外下载的扩展包也请下载 4.3.0 对应的版本。
  • 4.2.0 及更早的 documentai.model 不包含均衡档位所需的资源,而 4.3.0 沿用同一个文件名。如果您曾把旧版 documentai.model 拷贝到自己的部署目录或工程中,升级时请用 4.3.0 SDK 包内的新文件覆盖,不要沿用原来的同名文件。 旧模型加载失败会返回错误,不会自动回退到高精度档位。
  • 不要只替换动态库或只替换模型文件,两者需要成套更新。

常见问题 ​

现象可能原因
CPDF_SetDocumentAIModel 返回错误路径错误;模型文件与 SDK 版本不配套;文件不完整(下载中断)
选了 e_CHighAccuracy,表格结果与预期不同或效果变差没有加载 table_legacy.model(表格已改用规则识别)
转换时返回 e_CErrLicenseOCRPermissionDeny(29)授权不包含 OCR 权限,与模型无关

OpenVINO 加速包 ​

如果您的设备使用 Intel 处理器,可以额外部署 OpenVINO 加速包,以提升 OCR 等 AI 识别的速度。加速包部署成功后,SDK 在加载 DocumentAI 模型时会自动使用 OpenVINO 后端,无需修改代码,也无需任何额外设置。

  • 适用范围: Windows x64,Intel CPU。加速包只影响 AI 推理(例如 OCR 识别)的速度,不改变转换接口和转换选项。
  • 获取: 请在 https://download.compdf.com/download 下载与 SDK 版本对应的 OpenVINO 加速包,请不要混用不同版本的文件。
  • 部署: 解压后将加速包内的全部文件复制到 SDK 动态库所在的目录(即 onnxruntime 运行库所在的同一目录),然后照常调用 CPDF_SetDocumentAIModel 加载模型并执行转换。

注意事项:

  • 加速包缺失、文件不完整或与 SDK 版本不匹配时,SDK 会自动使用默认的 CPU 后端,转换照常进行,不会因此报错。
  • 请整包部署,不要只复制或替换其中的部分文件。
  • 加速包需要在加载模型之前部署;已加载的模型不会切换后端,部署后请重新启动程序或重新加载模型。
  • 使用 OpenVINO 后端时内存占用会有所增加。实际提速效果取决于处理器型号、文档内容和线程设置,并非所有场景都会更快。
  • 如需停用加速,删除这些文件即可恢复为默认的 CPU 后端。