query() 默认每次调用启动一个全新的会话。通过 options 里几个字段,可以指定会话 ID、恢复历史会话、或从已有会话分叉。
概念
一个 session 对应 CLI 端持久化的一条对话历史(含上下文、工具调用记录、压缩边界等),由 UUID 标识。系统消息init 里包含本次的 session_id,也是后续 resume / fork 的锚点。
下面示例中的 auth: accessTokenFromEnv() 也可以替换成你项目里使用的其他认证方式,参见 SDK 认证。
新建会话
默认
不传任何会话相关字段,每次新建:指定 session ID
让调用方决定 session 的 UUID(适合 host 自己管理 session 索引):恢复会话
按 ID 恢复
恢复最近一次
不知道 session ID 时,用continue: true 接上最近修改过的会话:
resume 和 continue 不要同时传。
分叉会话
从已有会话派生一条新会话,保留原上下文但获得新的 session ID。原会话不受影响:字段速查
| 字段 | 类型 | 行为 |
|---|---|---|
sessionId | string | 单独使用:用此 ID 新建;与 forkSession 同用:分叉后新会话的 ID |
resume | string | 要恢复的 session ID |
continue | boolean | true 表示恢复最近一次会话 |
forkSession | boolean | 配合 resume 使用,分叉而非接续 |
拿到当前 session ID
监听init 消息:
生成会话标题
当宿主应用需要给已有会话生成一个短标题时,可以调用q.generateSessionTitle():
ai-title transcript entry 仍可通过 session list 相关 API 读取。
读取 subagent transcript
Subagent 会在父会话下写入自己的 transcript。父会话完成后,先用listSubagents() 获取 subagent ID,再用 getSubagentMessages() 读取某个 subagent 的消息链:
getSubagentMessages() 会沿 subagent transcript 的 parent 链回溯,并按时间顺序返回 user / assistant 消息。