deepseek-harness/packages/api/session-controller/README.zh.md

description, kind

description	kind
Host 与 Client 会话控制：创建、恢复、提示、跟随历史并投影实时会话状态。	package-reference

Session Controller

English | 中文

概述

@deepseek-ai/dsh-api-session-controller 拥有 Host 的 ctx.sessionController 服务，以及生成的 Client session、skills 和 fileReferences Remote namespace。它提供 Session 生命周期与历史、Host generation 模型目录、工作区路径打开、用户可调用 skill 发现，以及面向 Agent 的文件引用 adapter。当 Client 需要按 Session 寻址的操作时，请通过 API Gateway 使用它。

目录

• 使用本包
• 配置
• 模型体验
• 已知限制与延期工作
• 开发备注

---

使用本包

历史页与 follow opening snapshot 为每个持久 Session event 携带一条 { type: 'event', event: SessionWireEvent } record。Client 把每条已接受 record 保留为一个持久 SessionEventLikeEntry；Assistant token 边界保留在 assistant/message 或 assistant/attempt 的紧凑 stream 内。工具参数、结果内容、失败信息和 tool/result.data.meta 原样通过；controller 不解析 Tool definition、不运行 presenter，也不附加 UI 数据。

每个 endpoint 都声明自己的激活策略。列表只读取持久化 header 与 projection cache row，绝不调用逐 Session stat 或打开冷 Session body。当前格式 cache identity 可以提供全部列表 hint；生命周期匹配的 predecessor cache 只能提供版本兼容的 title，作为可能过时的展示事实，绝不能作为权威 fold seed。搜索、附件、历史页、日志跟随、skill 发现和工作区路径打开可以在不激活 Agent 的情况下检查 persistence；canOpenWorkspacePath() 无需指定 Session 即可报告原生打开能力。queue 变更与取消要求 live 状态；模型、重命名、prompt 和文件引用操作可以解析或恢复普通 Session。只有 create 与 fork 会直接创建新 Agent。skill 目录则优先使用已有 live Agent，否则使用所记录 preset 的常驻 scope，因此列表查询绝不会启动 Agent。

Client adapter 提供 SessionEventStream，即绑定到一个普通 Session 或 direct subagent address 的 Gateway RemoteJournalStream。它在读取首个 page 前打开 follow，只发布连续的 replace、prepend 和 append 变更，并通过 tail page 修复重连或 seq 缺口。向后分页有两个动词：loadOlder() 拉一页 50 条 message，而 loadThrough(seq)——轮次跳转加载器——按 200 条 message 一页循环拉取直到窗口覆盖目标 seq，重复调用会下调共享目标，遇到无进展的页即停止，忙碌状态复用同一个 loadingOlder 快照位。Web adapter 显式选择接收无 cursor 的 Assistant frame：每个 opening 携带活跃 attempt 的 startedTime、startedAfterSeq、nextIndex 与紧凑 stream，每个 stream member 都成为排在持久 cursor 之间的 Client-only assistant/live-chunk 条目。Host 会随该 baseline 捕获 follower 本地到达序号，并抑制该 cut 及之前的 buffered frame；replacement Agent 可以从 revision 一重新开始。活跃 opening 之后到达的持久 assistant/message 或 assistant/attempt 只有在其 seq 晚于 startedAfterSeq 且 Turn 与 Step 匹配时才会保持暂存；匹配的 end type、seq 与 index 到达后再发布，而同一步骤中更早的 retry 保持可见。已知 attempt 的 revision、密集 index 或 settlement 缺口会重新打开 follow；若 controller 错过 start，则忽略 unknown-attempt frame，并正常发布其持久 settlement。Abandoned end 不发布持久 settlement。持久缺口修复 page 不携带 Assistant baseline，因此 held notification 会重新打开 follow 一次，以取得配对的 page 与 baseline。每条历史 record 只覆盖自身的 event seq。业务、persistence 或无法恢复的连续性错误会终止 stream，只有物理载体断开才触发自动恢复。SessionControlStream 是 Gateway RemoteSnapshotStream；每代都以完整的进程本地 baseline 开始，因此重连会替换 queue、jobs 和 projection 状态，而不会把瞬态值当作 durable event。

Session 对象还承载本地提交回显：session.beginSubmission 在调用方序列化与 prompt 之前，同步把一条回显写入 SessionSnapshot.pendingSubmissions，会话 UI 因此能在点击提交的当帧显示消息。Session 根据当前运行状态与请求的投递模式推导每条回显的 transcript、queued 或 steering 位置，并在序列化期间保留该位置。prompt 的 requestId 是关联标识：Host 把它回显为 durable user source 的 rpcId，queue occurrence 也把它投影为 SessionQueuedItem.rpcId。回显在观察到其 durable event 或 queue occurrence 后延迟一个动画帧退休，该延迟保证替代内容就绪前回显仍可渲染；带标识的 prompt 失败或被放弃时立即退休，销毁时按 failed 退休；每次退休恰好触发一次注册的 onRetire 回调。回显只存在于 Client 内存；刷新与重连只从 durable event 重建会话。

---

配置

字段	默认值	含义
nativeOpen	平台探测	是否能把 Session 工作区路径交给原生桌面打开器

生成的配置目录是所有受支持字段及其 JSDoc 的完整来源。

---

模型体验

无，因为被调用的 Agent 命令拥有任何模型可见效果。

KV Cache 影响

无直接影响；模型请求仍由 Agent 和 LLM 包拥有。

已知限制与延期工作

• Control baseline 表示进程本地状态，因此 Host 重启后无法重建 jobs。
• follow 恢复失败会对调用方可见，而不会无限重试。
• 文件引用补全使用共享 Agent lookup，因此可能恢复冷 Session；skills/list 目录是不激活 Agent 的 skill 元数据读取路径。

开发备注

维护者工作上下文——点击展开

无。

运行时不变式： 不发布伴生入口。每个分页与帧都会对照其指向的持久 Session 校验。