> ## Documentation Index
> Fetch the complete documentation index at: https://docs.somark.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# 在 Dify 中使用 SoMark

> 通过 Dify 插件市场将「SoMark 文档解析」接入工作流

## 安装并配置插件

<Steps>
  <Step title="安装插件">
    登录您的 Dify 平台，前往 **工具** → **插件市场**，搜索 **SoMark** 插件并添加。
  </Step>

  <Step title="配置插件参数">
    安装完成后进入插件配置页面：

    * **Base URL**：使用 SoMark API 时填写 `https://somark.tech/api/v1`; 私有化部署时填写本地部署的 Base URL。
    * **API Key**：使用 SoMark API 时填写；私有化部署无需填写。

    <Note>
      还没有 API Key？[前往 SoMark 工作台领取免费额度](https://somark.tech/workbench/purchase)。
    </Note>

    <Warning>
      Dify 的插件运行环境需要能够访问您配置的 **Base URL**。请检查网络、代理和 DNS。不要在 **Base URL** 后追加具体接口路径，插件会自动调用对应接口。
    </Warning>
  </Step>

  <Step title="保存配置">
    填写完成后点击**保存**，插件即可在工作流中使用。

    <img src="https://mintcdn.com/soulcode-aa7e5a93/mqnfzKMhfEvy3I3O/images/dify-SoMark%E5%B7%A5%E5%85%B7%E6%8E%88%E6%9D%83%E9%85%8D%E7%BD%AE.png?fit=max&auto=format&n=mqnfzKMhfEvy3I3O&q=85&s=18f3fc7b10bcc5ff69df75165d9a3e6b" alt="dify-SoMark工具授权配置" width="1232" height="972" data-path="images/dify-SoMark工具授权配置.png" />
  </Step>
</Steps>

***

## 在工作流中使用 SoMark 插件

<Steps>
  <Step title="添加 SoMark 文档解析工具节点">
    在 Dify 工作流编辑器中，点击 **+** 添加新节点，选择**工具**，找到并添加 **SoMark > SoMark 文档解析** 节点。

    <img src="https://mintcdn.com/soulcode-aa7e5a93/mqnfzKMhfEvy3I3O/images/dify-%E6%B7%BB%E5%8A%A0SoMark%E5%B7%A5%E5%85%B7%E8%8A%82%E7%82%B9.png?fit=max&auto=format&n=mqnfzKMhfEvy3I3O&q=85&s=15da0b5bca2be70c456a281c7483e900" alt="dify-添加SoMark工具节点" width="1714" height="922" data-path="images/dify-添加SoMark工具节点.png" />
  </Step>

  <Step title="配置输入变量">
    在 **文件** 输入框中点击变量图标 **`{x}`**，选择上游节点中定义的文件变量（例如开始节点的 `sys.files`）。
    你也可以按需配置其他可选参数（例如 **输出格式**、**图片格式**、**表格格式** 等）；未填写时会使用默认值。具体含义见下方「输入参数」表。
    **Base URL** 和 **API Key** 由插件配置自动注入，此处无需填写。

    <img src="https://mintcdn.com/soulcode-aa7e5a93/rxyqA7fo56mP0TxQ/images/dify-%E9%85%8D%E7%BD%AE%E8%BE%93%E5%85%A5%E5%8F%98%E9%87%8F.png?fit=max&auto=format&n=rxyqA7fo56mP0TxQ&q=85&s=e508a26c4a6cd4c7e6159fa6332f3f96" alt="dify-配置输入变量" width="2428" height="1278" data-path="images/dify-配置输入变量.png" />
  </Step>

  <Step title="在下游节点引用输出">
    节点执行完成后，其输出变量可在所有下游节点（LLM、文本分割、代码节点等）中使用。在任意下游节点的输入框中点击 **`{x}`**，即可选择 SoMark 文档解析节点的输出变量。
  </Step>
</Steps>

***

## 插件参数与输出

### 输入参数

| 参数      | 类型           | 必填 | 说明                                                                                                                          |
| :------ | :----------- | :- | :-------------------------------------------------------------------------------------------------------------------------- |
| 文件      | 文件           | ✅  | 支持的文件：PDF、PNG、JPG、JPEG、BMP、TIFF、JP2、DIB、PPM、PGM、PBM、GIF、HEIC、HEIF、WEBP、XPM、TGA、DDS、XBM、DOC、DOCX、PPT、PPTX。最大 200 MB / 300 页。 |
| 输出格式    | 单选           | ❌  | 选择输出格式。支持：`Markdown`、`JSON`、`“Markdown”和“JSON”`。默认值： `“Markdown”和“JSON”`。                                                   |
| 图片格式    | 单选           | ❌  | 图片输出格式。支持：`URL`、`Base64`、`None`。默认值：`URL`。                                                                                  |
| 公式格式    | 单选           | ❌  | 公式输出格式。支持：`LaTeX`、`MathML`、`ASCII`。默认值：`LaTeX`。                                                                             |
| 表格格式    | 单选           | ❌  | 表格输出格式。支持：`HTML`、`Markdown`、`Image`。默认值：`HTML`。在 Markdown 模式下，合并单元格会被拆分为独立单元格，并填充相同内容。                                      |
| 化学结构式格式 | 单选           | ❌  | 化学结构式输出格式。支持：`Image`。默认值：`Image`。                                                                                           |
| 文字跨页拼接  | True / False | ❌  | 将跨页文本合并为连续段落。默认值：`False`。                                                                                                   |
| 表格跨页拼接  | True / False | ❌  | 将跨页表格合并为连续表格。默认值：`False`。                                                                                                   |
| 标题层级识别  | True / False | ❌  | 识别标题层级结构，例如 H1/H2/H3。默认值：`False`。                                                                                           |
| 返回文中图   | True / False | ❌  | 返回文字段落中的图片。默认值：`False`。                                                                                                     |
| 返回表中图   | True / False | ❌  | 返回表格单元格中的图片。默认值：`True`。                                                                                                     |
| 图片理解    | True / False | ❌  | 对文档中的图片进行语义理解和结构化描述。默认值：`True`。                                                                                             |
| 保留页眉页脚  | True / False | ❌  | 保留页眉页脚而不是默认过滤掉。默认值：`False`。                                                                                                 |

### 输出变量

| 变量         | 说明                                                           |
| ---------- | ------------------------------------------------------------ |
| `markdown` | 解析后的文档内容（Markdown 格式），保留原始版面结构，包含标题、表格、列表、公式和图片              |
| `json_str` | 解析结果的 JSON 字符串，包含文本块、表格、公式、图片、坐标位置和页码等结构化信息，适合在代码节点中解析后做高级处理 |
| `text`     | Dify 内置变量，本插件不填充                                             |
| `files`    | Dify 内置变量，本插件不填充                                             |