> ## 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.

# 在飞书中使用 SoMark

> 在飞书多维表格工作流中使用「文档智能解析（转 markdown）」捷径解析文档

## 安装插件

<Steps>
  <Step title="安装插件">在飞书中打开 **插件市场**，搜索并安装 **文档智能解析（转 markdown）**。</Step>

  <Step title="准备 API 密钥">
    在多维表格工作流动作中需要填写 **API Key**。请提前准备您的 SoMark API Key。
    <Note>还没有 API Key？[前往 SoMark API 工作台获取 API Key](https://somark.tech/workbench/apikey)。免费额度无需领取，会自动发放到账户（每日 500 页、每月 2000 页）。</Note>
  </Step>
</Steps>

***

## 在多维表格工作流中使用插件

<Steps>
  <Step title="准备多维表格字段">在目标多维表格中准备一个用于上传/存放文件的 **附件** 字段；如需保存解析结果，再准备一个 **文本** 字段（可选）。</Step>
  <Step title="创建工作流">打开多维表格，进入 **工作流**，新建一个工作流。</Step>
  <Step title="配置触发器">选择触发方式（例如 **记录新增/更新** 或 **手动触发**），并确保触发器能提供包含附件字段的记录变量。</Step>
  <Step title="添加插件动作">在工作流动作中，选择并添加 **文档智能解析（转 markdown）**。</Step>

  <Step title="配置输入变量">
    在动作面板中完成以下配置：

    * **选择文档**：将文档绑定到触发器提供的附件字段（或上一节点输出的文件变量）。
    * **API Key**：粘贴您的 SoMark API 密钥，或点击输入框右侧的 **+** 选择工作流变量/密钥（推荐）。
    * （可选）按需配置 **输出格式**、**图片返回格式**、**公式返回格式**、**表格返回格式** 等参数；未填写时会使用默认值。不选择 **输出格式** 时，默认同时输出 `markdown` 和 `json`。具体含义见下方「输入参数」表。
          <img src="https://mintcdn.com/soulcode-aa7e5a93/SLE0uE2tuusHiywI/images/feishu-%E6%B7%BB%E5%8A%A0%E6%8F%92%E4%BB%B6.png?fit=max&auto=format&n=SLE0uE2tuusHiywI&q=85&s=b2c80f4dbf800d321edf5a2e042e7cb6" alt="dify-配置输入变量" width="1898" height="1280" data-path="images/feishu-添加插件.png" />
  </Step>

  <Step title="在下游动作使用输出">在后续动作中引用输出变量，例如将 `markdown` 写入多维表格的文本字段，或发送到群聊/私聊。</Step>
</Steps>

***

## 插件参数与输出

### 输入参数

| 参数        | 类型   | 说明                                        |
| --------- | ---- | ----------------------------------------- |
| 选择文档      | 附件字段 | 需要解析的文档                                   |
| API Key   | 文本   | SoMark API 密钥，建议在飞书工作流中配置变量后映射注入，不要在代码中写死 |
| 输出格式      | 多选   | 可填写 `Markdown`、`JSON`，默认 `Markdown,JSON`  |
| 图片返回格式    | 单选   | 支持 `URL`、`Base64`、`none`，默认 `URL`         |
| 公式返回格式    | 单选   | 支持 `LaTex`、`MathML`、`ASCII`，默认 `LaTex`    |
| 表格返回格式    | 单选   | 支持 `HTML`、`Markdown`、`Image`，默认 `HTML`    |
| 化学结构式返回格式 | 单选   | 当前仅支持 `Image`，默认 `Image`                  |
| 文字跨页拼接    | 单选   | 默认 `关闭`                                   |
| 表格跨页拼接    | 单选   | 默认 `关闭`                                   |
| 标题层级识别    | 单选   | 默认 `关闭`                                   |
| 保留文中图     | 单选   | 默认 `关闭`                                   |
| 保留表中图     | 单选   | 默认 `开启`                                   |
| 图片理解      | 单选   | 默认 `开启`                                   |
| 保留页眉页脚    | 单选   | 默认 `关闭`                                   |

### 返回结果

| 字段                      | 类型  | 说明          |
| ----------------------- | --- | ----------- |
| 任务 ID(`task_id`)        | 字符串 | 任务ID        |
| 任务状态(`status`)          | 字符串 | 任务状态        |
| Markdown 结果(`markdown`) | 字符串 | Markdown 结果 |
| JSON 结果(`json`)         | 字符串 | JSON 结果     |