转档公共参数

转档接口 options JSON 字段说明。

这些参数来自当前 ComPDF Web 和 ComPDF Self-hosted API 行为。具体功能页面只列出常用参数；本页列出可在 options JSON 对象中传入的公共参数。

参数名	类型	作用
enableAiLayout	Integer 或 String	是否开启 AI 版面分析。0 表示不开启，1 表示开启。ComPDF Web 默认值为 1。
pageLayoutMode	String	版面重建模式。e_Flow 偏向可编辑流式文本，e_Box 偏向固定视觉位置。
isContainImg	Integer 或 String	转换结果中是否包含图像。0 表示不包含，1 表示包含。
isContainAnnot	Integer 或 String	转换结果中是否包含注释。0 表示不包含，1 表示包含。
formulaToImage	Integer 或 String	是否将公式渲染为图片。0 尽量保留可编辑内容，1 将公式输出为图片。
enableOcr	Integer 或 String	是否使用 OCR。0 表示不开启，1 表示开启。
ocrRecognitionLang	String	OCR 识别语言。支持值：AUTO 自动、CHINESE 中文简体、CHINESE_TRAD 中文繁体、ENGLISH 英语、KOREAN 韩语、JAPANESE 日语、LATIN 拉丁语、DEVANAGARI 梵文、CYRILLIC 西里尔语、ARABIC 阿拉伯语、TAMIL 泰米尔语、TELUGU 泰卢固语、KANNADA 卡纳达语、THAI 泰语、GREEK 希腊语、ESLAV eslav 语系。默认值：AUTO。
ocrOption	String	INVALID_CHARACTER、SCAN_PAGE、INVALID_CHARACTERAND_SCAN_PAGE 或 ALL。默认值：ALL。
pageRanges	String	需要处理的页码范围，从 1 开始。示例：1、1-3、1,3-5。为空表示全部页面。
isOutputDocumentPerPage	Integer 或 String	是否每页输出为一个单独文档。0 表示否，1 表示是。
containPageBackgroundImage	Integer 或 String	是否包含页面背景图像，主要用于开启 OCR 的转换场景。
excelAllContent	Integer 或 String	PDF 转 Excel 选项。是否导出全部内容。0 表示偏表格输出，1 表示导出全部内容。
excelWorksheetOption	String	e_ForTable、e_ForPage 或 e_ForDocument。控制工作表组织方式。
htmlOption	String	e_SinglePage、e_SinglePageWithBookmark、e_MultiPage 或 e_MultiPageWithBookmark。
type	String 或 Integer	ComPDF Web 使用的 PDF 转 JSON 内容范围。0 表示文本，1 表示表格，2 表示全部。
imageFormat	String	输出图片格式。支持 JPG、JPEG、JPEG2000、PNG、BMP、TIFF、TGA、GIF、WEBP。
imageScaling	Number	PDF 转图片时的图像缩放比例。ComPDF Web 会按 DPI / 72 计算该值。
transparentText	Integer 或 String	可搜索/可编辑 PDF 选项。控制 OCR 文本是否以透明文本叠加在原页面图像上。
sourceType	String 或 Integer	非 PDF 转 PDF 的源类型标记。ComPDF Web 会传 1。
outputFileName	String	可选输出文件名。传入后会作为首选下载文件名。

请求示例

curl -X POST "http://localhost:8080/api/v1/process/pdf/xlsx" \
  -H "x-api-key: your_api_key_here" \
  -F "file=@/path/to/sample.pdf" \
  -F 'options={"enableAiLayout":"1","excelWorksheetOption":"e_ForTable","ocrRecognitionLang":"AUTO"}'