Skip to content

Commit 7acf64c

Browse files
docs: add v2 api version to docs fetch examples (#891)
Change-Id: I130e6e02c0b7594a05bdda6c9bf552fb15572791
1 parent 52e0129 commit 7acf64c

11 files changed

Lines changed: 19 additions & 19 deletions

File tree

skill-template/domains/doc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ Drive Folder (云空间文件夹)
8686

8787
## 重要说明:画板编辑
8888
> **⚠️ lark-doc skill 不能直接编辑已有画板内容,但 `docs +update` 可以新建空白画板**
89-
### 场景 1:已通过 docs +fetch 获取到文档内容和画板 token
90-
如果用户已经通过 `docs +fetch` 拉取了文档内容,并且文档中已有画板(返回的 markdown 中包含 `<whiteboard token="xxx"/>` 标签),请引导用户:
89+
### 场景 1:已通过 docs +fetch --api-version v2 获取到文档内容和画板 token
90+
如果用户已经通过 `docs +fetch --api-version v2` 拉取了文档内容,并且文档中已有画板(返回的 markdown 中包含 `<whiteboard token="xxx"/>` 标签),请引导用户:
9191
1. 记录画板的 token
9292
2. 查看 [`../lark-whiteboard/SKILL.md`](../lark-whiteboard/SKILL.md) 了解如何编辑画板内容
9393
### 场景 2:刚创建画板,需要编辑
@@ -115,4 +115,4 @@ Drive Folder (云空间文件夹)
115115
- 用户说“给文档加评论”“查看评论”“回复评论”“给评论加表情 / reaction”“删除评论表情 / reaction”,**不要留在 `lark-doc`**,直接切到 `lark-drive` 处理。
116116

117117
## 补充说明
118-
`docs +search` 除了搜索文档 / Wiki,也承担“先定位云空间对象,再切回对应业务 skill 操作”的资源发现入口角色;当用户口头说“表格 / 报表”时,也优先从这里开始。
118+
`docs +search` 除了搜索文档 / Wiki,也承担“先定位云空间对象,再切回对应业务 skill 操作”的资源发现入口角色;当用户口头说“表格 / 报表”时,也优先从这里开始。

skill-template/domains/drive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Drive Folder (云空间文件夹)
101101

102102
| 操作 | 需要的 Token | 说明 |
103103
|------|-------------|------|
104-
| 读取文档内容 | `file_token` / 通过 `docs +fetch` 自动处理 | `docs +fetch` 支持直接传入 URL |
104+
| 读取文档内容 | `file_token` / 通过 `docs +fetch --api-version v2` 自动处理 | `docs +fetch --api-version v2` 支持直接传入 URL |
105105
| 添加局部评论(划词评论) | `file_token` |`--block-id` 时,`drive +add-comment` 会创建局部评论;仅支持 `docx`,以及最终解析为 `docx` 的 wiki URL |
106106
| 添加全文评论 | `file_token` | 不传 `--block-id` 时,`drive +add-comment` 默认创建全文评论;支持 `docx`、旧版 `doc` URL,以及最终解析为 `doc`/`docx` 的 wiki URL |
107107
| 下载文件 | `file_token` | 从文件 URL 中直接提取 |

skills/lark-doc/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ metadata:
1010

1111
# docs (v2)
1212

13-
> **⚠️ API 版本:本 skill 使用 v2 API。所有 `docs +create``docs +fetch``docs +update` 命令必须携带 `--api-version v2`**
13+
> **⚠️ API 版本:本 skill 使用 v2 API。所有 `docs +create --api-version v2``docs +fetch --api-version v2``docs +update --api-version v2` 命令必须携带 `--api-version v2`**
1414
1515
```bash
1616
# 常用示例
@@ -23,7 +23,7 @@ lark-cli docs +update --api-version v2 --doc "文档URL或token" --command appen
2323

2424
**CRITICAL — 执行对应操作前,MUST 先用 Read 工具读取以下文件,缺一不可:**
2525
1. [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md) — 认证、权限处理、全局参数(所有操作通用)
26-
2. **读取文档(`docs +fetch`** → 必读 [`lark-doc-fetch.md`](references/lark-doc-fetch.md)`--scope` / `--detail` 选择、局部读取策略、`<fragment>` / `<excerpt>` 输出结构)
26+
2. **读取文档(`docs +fetch --api-version v2`** → 必读 [`lark-doc-fetch.md`](references/lark-doc-fetch.md)`--scope` / `--detail` 选择、局部读取策略、`<fragment>` / `<excerpt>` 输出结构)
2727
3. **创建或编辑文档内容** → 必读 [`lark-doc-xml.md`](references/lark-doc-xml.md)(XML 语法规则,仅当用户明确要求 Markdown 时改读 [`lark-doc-md.md`](references/lark-doc-md.md));从零创建时加读 [`lark-doc-create-workflow.md`](references/style/lark-doc-create-workflow.md);编辑已有文档时加读 [`lark-doc-update-workflow.md`](references/style/lark-doc-update-workflow.md)
2828

2929
**未读完以上文件就执行相应操作会导致参数选择错误、格式错误或样式不达标。**
@@ -49,7 +49,7 @@ lark-cli docs +update --api-version v2 --doc "文档URL或token" --command appen
4949
| `<bitable token="..." table-id="...">` | `token` -> app_token, `table-id` | [`lark-base`](../lark-base/SKILL.md) |
5050
| `<cite type="doc" file-type="sheets" token="..." sheet-id="...">` |`<sheet>` | [`lark-sheets`](../lark-sheets/SKILL.md) |
5151
| `<cite type="doc" file-type="bitable" token="..." table-id="...">` |`<bitable>` | [`lark-base`](../lark-base/SKILL.md) |
52-
| `<synced_reference src-token="..." src-block-id="...">` | `src-token` -> doc_token, `src-block-id` -> block_id |`docs +fetch` 读取 src-token 文档,定位 block |
52+
| `<synced_reference src-token="..." src-block-id="...">` | `src-token` -> doc_token, `src-block-id` -> block_id |`docs +fetch --api-version v2` 读取 src-token 文档,定位 block |
5353

5454
**补充:** 云空间资源发现统一走 [`drive +search`](../lark-drive/references/lark-drive-search.md);当用户口头说"表格/报表/最近我编辑过的 xxx"时,也优先从 `drive +search` 开始。老的 `docs +search` 只在沿用 `--filter` JSON 的存量脚本里保留,后续会下线。
5555

skills/lark-doc/references/lark-doc-fetch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ lark-cli docs +fetch --api-version v2 --doc Z1Fj...tnAc \
130130

131131
## 嵌入电子表格 / 多维表格
132132

133-
返回中可能含 `<sheet>``<bitable>``<cite file-type="sheets|bitable">`。内部数据无法通过 `docs +fetch` 获取,提取 `token` 等属性后切到 [`lark-sheets`](../../lark-sheets/SKILL.md) / [`lark-base`](../../lark-base/SKILL.md) 下钻,详见 [SKILL.md 快速决策](../SKILL.md) 路由表。
133+
返回中可能含 `<sheet>``<bitable>``<cite file-type="sheets|bitable">`。内部数据无法通过 `docs +fetch --api-version v2` 获取,提取 `token` 等属性后切到 [`lark-sheets`](../../lark-sheets/SKILL.md) / [`lark-base`](../../lark-base/SKILL.md) 下钻,详见 [SKILL.md 快速决策](../SKILL.md) 路由表。
134134

135135
## 参考
136136

skills/lark-doc/references/lark-doc-md.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Markdown 格式参考
22

3-
`docs +fetch / +create / +update` 使用 `--doc-format markdown` 时适用。
3+
`docs +fetch --api-version v2` / `docs +create --api-version v2` / `docs +update --api-version v2` 使用 `--doc-format markdown` 时适用。
44

55
## 转义规则
66

@@ -34,14 +34,14 @@
3434
- `$...$` 数学公式内部,符号为 LaTeX 语法,不受 Markdown 转义影响
3535

3636
**导出已转义,不要反转义:**
37-
`docs +fetch --doc-format markdown` 导出的内容中,特殊字符**已经被转义过了**(例如 `\[``\|``\\` 等)。这些 `\` 是有意义的——去掉会导致后续写入时字符被 Markdown 语法吞掉。**不要反转义或去掉 `\`**
37+
`docs +fetch --api-version v2 --doc-format markdown` 导出的内容中,特殊字符**已经被转义过了**(例如 `\[``\|``\\` 等)。这些 `\` 是有意义的——去掉会导致后续写入时字符被 Markdown 语法吞掉。**不要反转义或去掉 `\`**
3838

3939
**写入时必须转义:**
4040
使用 `docs +create``docs +update``--doc-format markdown` 写入内容时,字面文本中的特殊字符同样必须转义。`--pattern` 参数中也必须使用转义形式才能正确匹配。
4141

4242
**导出 → 更新 工作流示例:**
4343

44-
1. `docs +fetch` 导出得到 `C:\\Users\\test\[1\]`
44+
1. `docs +fetch --api-version v2` 导出得到 `C:\\Users\\test\[1\]`
4545
2.`str_replace --pattern 'C:\\Users\\test\[1\]'` 匹配(直接使用导出的转义形式)
4646
3. `--content` 中的替换内容也要保持转义:`C:\\Users\\prod\[2\]`
4747

skills/lark-doc/references/lark-doc-update.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
> - **局部精修**`str_replace` / `block_insert_after` / `block_replace` / `block_delete` / `block_move_after`):优先使用 XML(默认)。XML 能稳定表达 block 结构和样式,精准编辑更可控;不要因为 Markdown 写起来更简单就自行切换。
1616
> - **整段写入**`append` / `overwrite`):XML 和 Markdown 都可以。用户提供 `.md` 本地文件或明确要求 Markdown 时直接用 Markdown;否则默认 XML。
1717
>
18-
> **Markdown 局限 & block ID 前提:** Markdown 不携带 block ID,也无样式(颜色、对齐、callout 等)。需要按 block ID 定位(`block_*` 指令的 `--block-id`)时,先 `docs +fetch --detail with-ids` **配合 `--scope``outline` / `range` / `keyword` / `section`)局部获取**目标段落,不要全量 fetch。拿到 block ID 后 `--content` 仍可用 Markdown,只是写入内容不带样式。
18+
> **Markdown 局限 & block ID 前提:** Markdown 不携带 block ID,也无样式(颜色、对齐、callout 等)。需要按 block ID 定位(`block_*` 指令的 `--block-id`)时,先 `docs +fetch --api-version v2 --detail with-ids` **配合 `--scope``outline` / `range` / `keyword` / `section`)局部获取**目标段落,不要全量 fetch。拿到 block ID 后 `--content` 仍可用 Markdown,只是写入内容不带样式。
1919
2020
## 参数
2121

@@ -221,7 +221,7 @@ lark-cli docs +update --api-version v2 --doc "<doc_id>" --command str_replace \
221221

222222
## 画板处理
223223

224-
> **`docs +update` 不能直接编辑已有画板的内容。** 本命令只能**新增**画板块;要修改已有画板,先用 `docs +fetch` 取到 `<whiteboard token="...">`,再切到 [`lark-whiteboard`](../../lark-whiteboard/SKILL.md)`whiteboard +update` 写入。
224+
> **`docs +update` 不能直接编辑已有画板的内容。** 本命令只能**新增**画板块;要修改已有画板,先用 `docs +fetch --api-version v2` 取到 `<whiteboard token="...">`,再切到 [`lark-whiteboard`](../../lark-whiteboard/SKILL.md)`whiteboard +update` 写入。
225225
226226
画板的语法选型与插入示例见 [`lark-doc-style.md`](style/lark-doc-style.md) 的「画板语法与插入」章节。
227227

skills/lark-doc/references/lark-doc-whiteboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
| 场景 | 入口 |
1717
|------|------|
1818
| 文档中需要插入新画板 | 继续步骤 2 |
19-
| 已有画板需要更新内容 |`docs +fetch` 获取 `board_token`,跳至步骤 3 |
19+
| 已有画板需要更新内容 |`docs +fetch --api-version v2` 获取 `board_token`,跳至步骤 3 |
2020
| 只查看 / 下载已有画板 | 切换至 `lark-whiteboard`,不走本流程 |
2121

2222
### 步骤 2:在文档中创建空白画板

skills/lark-doc/references/style/lark-doc-create-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
### 第三波 — 整合审查 + 画板意图识别(串行)
3535

36-
5. `docs +fetch --detail with-ids` 获取文档,审查整体效果
36+
5. `docs +fetch --api-version v2 --detail with-ids` 获取文档,审查整体效果
3737
6. 评估样式达标(富 block 密度、元素多样性、连续 `<p>` 数量)
3838
7. **画板意图识别**:逐章节扫描,按 `lark-doc-style.md`「画板意图识别」表判断是否有段落适合用图表达。记录需要插图的章节及推荐的画板类型
3939

skills/lark-drive/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Drive Folder (云空间文件夹)
117117

118118
| 操作 | 需要的 Token | 说明 |
119119
|------|-------------|------|
120-
| 读取文档内容 | `file_token` / 通过 `docs +fetch --api-version v2` 自动处理 | `docs +fetch` 支持直接传入 URL |
120+
| 读取文档内容 | `file_token` / 通过 `docs +fetch --api-version v2` 自动处理 | `docs +fetch --api-version v2` 支持直接传入 URL |
121121
| 添加局部评论(划词评论) | `file_token` |`--block-id` 时,`drive +add-comment` 会创建局部评论;`docx` 支持文本定位或 block_id,`slides` 仅支持 block_id,且都支持最终解析到对应类型的 wiki URL |
122122
| 添加全文评论 | `file_token` | 不传 `--block-id` 时,`drive +add-comment` 默认创建全文评论;支持 `docx`、旧版 `doc` URL,以及最终解析为 `doc`/`docx` 的 wiki URL |
123123
| 下载文件 | `file_token` | 从文件 URL 中直接提取 |

skills/lark-vc/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ lark-cli schema drive.metas.batch_query
6060
# 批量获取文档基本信息: 一次最多查询 10 个文档
6161
lark-cli drive metas batch_query --data '{"request_docs": [{"doc_type": "docx", "doc_token": "<doc_token>"}], "with_url": true}'
6262
```
63-
3. 需要获取文档内容时,使用 `lark-cli docs +fetch`
63+
3. 需要获取文档内容时,使用 `lark-cli docs +fetch --api-version v2`
6464
```bash
6565
# 获取文档内容
6666
lark-cli docs +fetch --api-version v2 --doc <doc_token> --doc-format markdown
@@ -79,7 +79,7 @@ lark-cli vc meeting get --params '{"meeting_id":"<meeting_id>","with_participant
7979
| 用户意图 | 推荐命令 | 所在 skill |
8080
|---------|---------|--------|
8181
| 参会人快照(谁参加过、何时入/离会,任意时点)| `vc meeting get --with-participants` | 本 skill |
82-
| 已结束会议的发言内容 | `vc +notes``verbatim_doc_token``docs +fetch` | 本 skill |
82+
| 已结束会议的发言内容 | `vc +notes``verbatim_doc_token``docs +fetch --api-version v2` | 本 skill |
8383
| **进行中会议**的实时事件流(转写、聊天、共享、会中加入/离开)| `vc +meeting-events` | [`lark-vc-agent`](../lark-vc-agent/SKILL.md) |
8484
| **Agent 真实入会 / 离会** | `vc +meeting-join` / `vc +meeting-leave` | [`lark-vc-agent`](../lark-vc-agent/SKILL.md) |
8585

0 commit comments

Comments
 (0)