Skip to content

Commit b101ef3

Browse files
committed
feat: change doc
1 parent dcf0c31 commit b101ef3

5 files changed

Lines changed: 100 additions & 100 deletions

File tree

‎docs/memory/memory-cli-guide.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -113,18 +113,18 @@ bl memory --help
113113

114114
以下参数在记忆命令中通用,后续命令手册不再逐条列出:
115115

116-
| 参数 | 类型 | 说明 |
117-
| --------------------- | ------ | ------------------------------------------------------------ |
118-
| `--output <format>` | string | 输出格式:`text`(默认)或 `json` |
119-
| `--api-key <key>` | string | DashScope API Key |
120-
| `--base-url <url>` | string | API 基地址;不能用来切换 Memory 的 Workspace 网关 |
121-
| `--timeout <seconds>` | number | 请求超时秒数 |
122-
| `--quiet` | switch | 与 text 使用同一套摘要;同时指定 json 时仍输出文本摘要 |
123-
| `--verbose` | switch | 详细模式。`add` 轮询进度写到 stderr |
124-
| `--dry-run` | switch | 预览 endpoint、method 和 request,不发送 Memory 业务请求 |
125-
| `--introspect` | switch | 输出当前命令范围的结构化能力说明,无需凭证 |
126-
| `--config <name>` | string | 使用指定配置 profile 执行命令 |
127-
| `--workspace-id <id>` | string | Workspace ID |
116+
| 参数 | 类型 | 说明 |
117+
| --------------------- | ------ | -------------------------------------------------------- |
118+
| `--output <format>` | string | 输出格式:`text`(默认)或 `json` |
119+
| `--api-key <key>` | string | DashScope API Key |
120+
| `--base-url <url>` | string | API 基地址;不能用来切换 Memory 的 Workspace 网关 |
121+
| `--timeout <seconds>` | number | 请求超时秒数 |
122+
| `--quiet` | switch | 与 text 使用同一套摘要;同时指定 json 时仍输出文本摘要 |
123+
| `--verbose` | switch | 详细模式。`add` 轮询进度写到 stderr |
124+
| `--dry-run` | switch | 预览 endpoint、method 和 request,不发送 Memory 业务请求 |
125+
| `--introspect` | switch | 输出当前命令范围的结构化能力说明,无需凭证 |
126+
| `--config <name>` | string | 使用指定配置 profile 执行命令 |
127+
| `--workspace-id <id>` | string | Workspace ID |
128128

129129
> 命令手册中的参数表只列出该命令特有的参数。
130130
@@ -157,14 +157,14 @@ bl memory add --introspect
157157

158158
`memory add` 提交异步任务并在进程内轮询。默认 `--wait 120`(秒),间隔 3 秒。这是轮询预算,不是整个进程的严格时限。`--wait 0` 只返回提交回执。
159159

160-
| 状态 | 处理方式 |
161-
| ---------- | ------------------------------------------------------- |
162-
| PENDING | 继续轮询 |
163-
| RUNNING | 继续轮询 |
164-
| SUCCEEDED | 成功终态;`result` 为空表示这次没有记忆变化 |
165-
| SUCCESS | CLI 兼容的成功拼写,与 SUCCEEDED 同一类终态 |
166-
| UNRECORDED | 终态。CLI 展示状态,不把它当作已写入成功 |
167-
| FAILED | 失败终态。已完成的部分会先输出,然后命令以非零状态退出 |
160+
| 状态 | 处理方式 |
161+
| ---------- | ------------------------------------------------------ |
162+
| PENDING | 继续轮询 |
163+
| RUNNING | 继续轮询 |
164+
| SUCCEEDED | 成功终态;`result` 为空表示这次没有记忆变化 |
165+
| SUCCESS | CLI 兼容的成功拼写,与 SUCCEEDED 同一类终态 |
166+
| UNRECORDED | 终态。CLI 展示状态,不把它当作已写入成功 |
167+
| FAILED | 失败终态。已完成的部分会先输出,然后命令以非零状态退出 |
168168

169169
一个 `event_id` 可以包含多项任务。部分失败时,成功部分可能已经落地。超时只表示 CLI 停止等待,后台任务仍可能继续。当前没有独立的事件查询命令,稍后用 `list`、`search` 或 `profile get` 核对。
170170

@@ -469,20 +469,20 @@ bl memory skill export --node-id <id> [flags]
469469

470470
## 附录:命令速查表
471471

472-
| 命令 | 功能 | 关键参数 |
473-
| ---------------------------- | -------------- | ------------------------------------------------------------------------ |
474-
| `bl memory add` | 异步抽取 | `--user-id`, `--content`/`--messages`, `--wait`, `--profile-schema` |
475-
| `bl memory list` | 分页列出节点 | `--user-id`, `--project-id`, `--page`, `--page-size` |
476-
| `bl memory search` | 语义检索 | `--user-id`, `--query`/`--messages`, `--memory-types`, `--plan-version` |
477-
| `bl memory node show` | 节点详情 | `--node-id` |
478-
| `bl memory update` | 更新节点 | `--node-id`, `--content`, `--meta-data` |
479-
| `bl memory delete` | 删除节点 | `--node-id`, `--yes` |
480-
| `bl memory profile create` | 创建画像模板 | `--name`, `--attributes`, `--plan-version`, `--extract-scene` |
481-
| `bl memory profile list` | 列出模板 | `--page`, `--page-size`, `--library-id` |
482-
| `bl memory profile show` | 模板详情 | `--schema-id` |
483-
| `bl memory profile update` | 更新模板 | `--schema-id`, `--attributes-operations` |
484-
| `bl memory profile delete` | 删除模板 | `--schema-id`, `--yes` |
485-
| `bl memory profile get` | 读取用户画像 | `--schema-id`, `--user-id` |
486-
| `bl memory skill export` | 导出 Skill 正文 | `--node-id` |
472+
| 命令 | 功能 | 关键参数 |
473+
| -------------------------- | --------------- | ----------------------------------------------------------------------- |
474+
| `bl memory add` | 异步抽取 | `--user-id`, `--content`/`--messages`, `--wait`, `--profile-schema` |
475+
| `bl memory list` | 分页列出节点 | `--user-id`, `--project-id`, `--page`, `--page-size` |
476+
| `bl memory search` | 语义检索 | `--user-id`, `--query`/`--messages`, `--memory-types`, `--plan-version` |
477+
| `bl memory node show` | 节点详情 | `--node-id` |
478+
| `bl memory update` | 更新节点 | `--node-id`, `--content`, `--meta-data` |
479+
| `bl memory delete` | 删除节点 | `--node-id`, `--yes` |
480+
| `bl memory profile create` | 创建画像模板 | `--name`, `--attributes`, `--plan-version`, `--extract-scene` |
481+
| `bl memory profile list` | 列出模板 | `--page`, `--page-size`, `--library-id` |
482+
| `bl memory profile show` | 模板详情 | `--schema-id` |
483+
| `bl memory profile update` | 更新模板 | `--schema-id`, `--attributes-operations` |
484+
| `bl memory profile delete` | 删除模板 | `--schema-id`, `--yes` |
485+
| `bl memory profile get` | 读取用户画像 | `--schema-id`, `--user-id` |
486+
| `bl memory skill export` | 导出 Skill 正文 | `--node-id` |
487487

488488
当前没有这些命令:事件状态查询、记忆库管理、片段规则管理、直接编辑画像值项、清空某个用户的全部记忆或全部画像。

0 commit comments

Comments
 (0)