API Reference
Session 类型与结果
Session 输入输出对象里最重要的字段和语义
Session 类型与结果
最常见的输入输出对象有：
AgentSessionRemoteAgentSessionAgentSessionSetInputAgentSessionPromptInputAgentSessionStopResultAgentSessionTurnHandleAgentSessionTurnResultSessionMutationSessionMessageSessionApprovalAgentSessionInfo
先按用途选择类型
| 你要做什么 | 应该消费的对象 |
|---|---|
| 首次加载、历史与重连恢复 | SessionMessagePage / SessionMessage |
| 实时文本、工具和标题 | SessionMutation |
| 等待一次执行结束 | AgentSessionTurnHandle / AgentSessionTurnResult |
| 展示或提交工具审批 | SessionApproval / SessionApprovalResult |
| 侧边栏与当前会话头部 | AgentSessionSummary / AgentSessionInfo |
AgentSessionPromptInput
核心字段：
query
AgentSessionTurnHandle
核心字段：
idresultfinished
AgentSessionTurnResult
核心字段：
turnIdsuccesserrortextassistantMessage（本地 session 通常可用）
对大多数用户来说，最常直接消费的是 text。如果你需要最终的结构化 assistant 结果，可以读取 assistantMessage；如果你需要在 finished 兑现前实时更新 UI，配合 session.subscribe() 返回的 SessionMutation 即可。
AgentSessionStopResult
核心字段：
stoppedturnIdcancelledQueuedPromptsreason
session.stop() 会停止当前 turn，并取消尚未被当前 turn 吸收的排队 prompt。空闲时调用不会抛错，会返回 stopped: false 和 reason: "idle"。
深入阅读
- 输入与 Turn：输入格式、steering 与排队语义。
- Message 与 Part：持久化线性历史、revision 与分页。
- 实时订阅：五类 Mutation 与客户端合并规则。
- 工具审批：Session 级审批与审批模式。
- Session 详情：摘要、标题与执行状态字段。