API 参考

@blade-ai/agent-sdk 根包提供默认的 createAgent() 接触面，并采用服务端安全 默认值；传入 filesystem 时自动选择 local profile。框架集成从 /advanced 使用底层 Session API。浏览器端从 /browser 导入客户端、协议和常量； 服务端部署组件统一从 /server/infra 导入。

/server/infra 当前面向 Node.js 服务进程，不是 Edge Runtime 入口。PostgreSQL、 非内置 Provider adapter 与原生 Node 增强使用可选 peer dependency；部分依赖仍 可能由基础依赖间接安装。

包还提供 create-blade-agent 可执行文件。它通过 --preset <local|web|production> 选择生成项目的拓扑，--verify 负责安装后 验收；省略 --preset 时默认生成 local starter。该 CLI 不属于 JavaScript package export；通过 npm bin 调用。

包入口

入口	运行环境	说明
@blade-ai/agent-sdk	Node.js	默认 createAgent、工具定义和公共类型入口
@blade-ai/agent-sdk/browser	Browser-safe / Node	AgentClient、协议 schema、解析器、事件和常量
@blade-ai/agent-sdk/protocol	Browser-safe / Node	wire protocol schema 与解析器
@blade-ai/agent-sdk/server/infra	Node.js server	AgentServer、Worker 与 Runtime Store 契约
@blade-ai/agent-sdk/server/postgres	Node.js server	PostgresRuntimeStore adapter
@blade-ai/agent-sdk/advanced	Node.js	local/server Session、SessionRunner、ExecutionHost 和 Node adapter

旧 /node、/server、/core、/model、/session、/middleware、 /tools compatibility alias 已删除。可选 PostgreSQL adapter 位于 /server/postgres，避免 canonical 入口强制加载 pg。

函数

下表“逻辑模块”用于分类，不代表可导入的 package subpath。除特别标注的 Node-local 能力外，这些函数都从根入口导出；实际 subpath 以“包入口”表为准。

函数	逻辑模块	说明
createAgent	agent	通过三层 AgentOptions 创建 Agent
createSession	session	创建新会话
resumeSession	session	恢复会话
forkSession	session	分叉会话
prompt	session	一次性调用
defineTool	tools	使用 TypeBox 定义工具
getBuiltinTools	advanced	获取内置 Node 本地工具
memoryReadTool	advanced	静态 opt-in MemoryRead 工具
memoryWriteTool	advanced	静态 opt-in MemoryWrite 工具
tool	advanced	定义 MCP 工具
createSdkMcpServer	advanced	创建进程内 MCP Server
createContextSnapshot	runtime	创建上下文快照
mergeContext	runtime	合并上下文
hasFilesystemCapability	runtime	检查文件系统能力
createCompositePermissionHandler	permissions	组合多个权限处理器
createModePermissionHandler	permissions	基于权限模式创建处理器
createPathSafetyPermissionHandler	permissions	基于路径安全策略创建处理器
createRuleBasedPermissionHandler	permissions	基于规则创建处理器
collectToolExecution	root	消费工具执行并返回最终结果
completeToolExecution	root	将单个结果包装成工具执行
composeMiddleware	root	组合通用洋葱 middleware
definePlugin	root	定义声明式 Agent 插件
wrapModelService	root	使用模型 middleware 包装 ModelService
normalizeDeepSeekModel 等	root	DeepSeek 模型、base URL、缓存前缀和 strict schema 辅助函数
registerCleanup / gracefulShutdown	root	注册和执行进程级清理
getErrorMessage 等	root	安全提取未知错误信息

类 / 运行时对象

名称	来源	说明
FileSystemMemoryStore	advanced	文件系统 memory 适配器
MemoryManager	advanced	memory 编排层
SubagentRegistry	subagents	注册和发现子 Agent
AgentSessionRepository	subagents	子 Agent 会话的存储能力接口，可注入数据库实现以获得跨机恢复
SubagentExecutor	subagents	执行单个子 Agent
DurableExecutionLease	durable events	自动 heartbeat 的 Store-backed execution lease handle
executionFence	durable events	从 lease snapshot 提取不可变的下游 fence
DURABLE_EXECUTION_LEASE_FORMAT	durable events	lease sidecar 的持久化格式标识
JsonlDurableEventStore	advanced	支持同机多进程锁的 Node.js durable event JSONL adapter
DurableExecutionLeaseError	durable events	lease 冲突、失租、缺少 fence 或状态损坏错误
AgentServer	server/infra	多租户 command 调度、Session 管理和 Fetch-compatible HTTP/SSE transport
InProcessSessionExecutor	server/infra	SessionExecutor 的进程内参考实现，负责 Session 生命周期与 stream pump
SdkSessionRunner	advanced	在 worker fencing 下恢复并执行 durable SDK Session
ExecutionHostSessionRunner	advanced	在隔离 ExecutionHost 中 provision、执行、checkpoint 和恢复 workload
AgentWorker	server/infra	worker 注册、heartbeat、Session claim、lease 续期、恢复与 drain supervisor
AgentClient / RemoteAgentSession	browser	带 command 重试和 SSE cursor 重连的远程客户端
InMemoryAgentServerStore	server/infra	单进程控制面参考 Store；不用于多实例生产部署
PostgresRuntimeStore	server/postgres	共享 command、event、Session 状态、路由和 lease persistence
RuntimeStoreError	server/infra	Runtime Store 的稳定错误类型
TenantAdmissionController	server/infra	每 tenant 并发、队列和固定窗口限流
JsonlSessionRepository	advanced	Node.js transcript repository
SessionInputError	session	输入队列容量、请求匹配或活动请求选项错误
SessionHandoffError	session	handoff 配置、生命周期或活动后台工作前置条件错误
SdkError 及派生错误	root	类型化 SDK 错误层级

常量 / 枚举

名称	值
PermissionMode	DEFAULT / AUTO_EDIT / YOLO / PLAN
HookEvent	SessionStart / SessionEnd / UserPromptSubmit / PermissionRequest / PreToolUse / PostToolUse / PostToolUseFailure / TaskCompleted
ToolKind	ReadOnly / Write / Execute
InputPriority	NOW / NEXT / LATER
SessionStreamEventType	包含 TURN_INTERRUPTED / INPUT_APPLIED 及内容、工具、用量、结果事件
MessageRole	SYSTEM / USER / ASSISTANT / TOOL
PermissionDecision	ALLOW / DENY / ASK

类型

Agent

类型	说明
Agent	createAgent() 返回的高层 Agent 接口
AgentResponse	单次 send() 的共享响应，提供 text() / textStream() / on() / stream()
AgentResponseEvent / AgentResponseEventType / AgentResponseListener	按事件类型收窄的回调类型
AgentResponseSubmission	Response 对应的 started input submission
AgentOptions	必需字段、常用字段和 advanced 三层配置
AgentAdvancedOptions	基础设施、策略和低频配置
AgentProfile	'local' 或 'server'
AgentFilesystemOptions	local filesystem roots 与 cwd
AgentPermission / AgentPermissionPreset	单一权限字段及其预设
AgentPermissionRequest / AgentPermissionDecision	自定义权限回调契约
UserMessageContent	Agent、Session 与 wire command 共用的文本或多模态输入
InlineHooks / SessionHookEvent	进程内 callback hook 契约
SkillDefinition	advanced.skills 接受的 Session 私有数据 Skill
SkillActivationContext / SkillMetadata / SkillRegistryConfig	Skill 发现、过滤与 registry 配置类型

Session

类型	说明
ISession	Session 实例接口
SessionOptions	Session 创建选项
SessionRepository	transcript 的只读 projection 端口
SessionEventStore	transcript projection 原子写入端口
SessionRepositoryMessageMetadata / SessionRepositoryCompactionMetadata	repository 消息与 compaction append 元数据
SessionRepositorySubagentInfo / SessionRepositorySubagentRef	子 Agent transcript 归属与结果引用
SessionRepositoryHealth / SessionRepositoryStorageStats	repository 健康与容量统计
SendOptions	send() 选项
InputSubmission	输入被 started / steered / queued 的判别联合
PendingSessionInput	尚未应用的持久化输入
InputId / RequestId / SessionId	输入、活动请求与会话的 branded identifiers
MessageId / PartId / ToolUseId	transcript 消息、内容 part 与工具调用标识
EventId / EventSequence	event 标识与 Session 内单调序列
CommandId / TurnId / ModelAttemptId / ToolAttemptId / PermissionRequestId	durable command、turn、模型尝试、工具尝试与权限请求标识
WorkerId / ExecutionLeaseId / FencingToken	worker、租约和单调 fence 的 branded identifiers
TraceId / SpanId / TraceEventId	trace、span 与 trace event 标识
StreamOptions	stream() 选项
SessionStreamEvent	Session 流式消息联合类型
PromptResult	prompt() 返回结果
ResumeOptions	resume 选项
ForkOptions	fork 选项
ForkSessionOptions	Session fork 选项
ForkSessionResult	Session fork 结果
SessionHandoffResult	worker handoff 完成后的 journal head 与 recovery plan
SessionHandoffErrorCode	worker handoff 的稳定错误码

Server Runtime

导出	说明
AgentServerOptions / AgentServerSessionContext	认证、Session options、Store、遥测、准入和 transport 限制
SessionExecutor / SessionExecutorCommandContext	command transport 与 Session 执行面的稳定边界
InProcessSessionExecutorOptions	进程内 executor 的 Store、Session resolver、event publisher 与容量配置
SessionExecutorEventPublisher / SessionExecutorReadResult	executor 的事件输出与 Session read projection
AgentServerStore / AgentCommandClaim / AgentServerSessionRecord	command claim/seal/complete、tenant Session 和 event replay 端口
AgentServerTelemetry / AgentServerAuditRecord	payload-free metric 与审计端口
AgentClientOptions / AgentClientCommandOptions / AgentClientEventOptions	浏览器 transport、重试和 cursor 选项
AgentCommand / AgentCommandResult	protocol v1 command 与结果判别联合
AgentServerEvent / AgentEventCursor / AgentEventPage	单调 sequence 的远程事件与 cursor
AgentPrincipal / AgentServerScope	服务端认证主体与授权 scope
AgentProtocolCapabilities / AgentClientCapabilities	服务端与客户端能力描述
AgentInitializationData	initialize 响应，包含协商能力与 serverTime
AgentProtocolError / AgentProtocolErrorCode	稳定 wire error
AGENT_PROTOCOL_VERSION / AgentCommandType	协议版本与 command 常量
parseAgentCommand / parseAgentCommandResult	strict command envelope parser
parseAgentEventCursor / parseAgentServerEvent	strict event/cursor parser
agentInitializationDataSchema	strict initialize response schema
RuntimeStore / RuntimeTenantStore	共享 authority 与 tenant-scoped Session/durable adapter
RUNTIME_STORE_SCHEMA_VERSION	PostgreSQL schema 版本
RuntimeWorkerRecord / RuntimeWorkerRegistration	worker heartbeat、容量与 drain 状态
RuntimeSessionRoute / RuntimeSessionClaim / RuntimeSessionClaimOptions	Session 路由、领取与 execution lease
RuntimeSessionState / RuntimeSessionTransition / RuntimeSessionSettlement	含可重入 idle 的八态状态机与 fenced 更新
RuntimeRecoveryResult	过期 worker、Session 与 sealed command 恢复结果
AgentWorkerHealth / AgentWorkerMetrics / AgentWorkerSnapshot	Worker readiness、吞吐和运行快照
AgentWorkerTelemetry / AgentWorkerErrorMetric	可注入的 Worker 遥测端口
SessionRunner / SessionRunnerContext / SessionRunResult	单个 fenced Session 的执行边界
WorkerRuntimeStore / WorkerRuntimeError	worker 调度与恢复端口及稳定错误
完整部署约束见 Server Runtime 和
Runtime Store，worker 调度见
Worker Runtime，隔离执行见
Execution Host。

Execution Host

导出	说明
ExecutionHost	provision、exec、checkpoint、restore、terminate 执行端口
ExecutionProvisionRequest / ExecutionHandle	镜像、workspace、资源、网络与执行句柄
ExecutionExecRequest / ExecutionExecResult	单次 command 输入与有界输出
ExecutionCheckpoint / ExecutionRestoreRequest	workspace checkpoint 与恢复输入
ExecutionResourceLimits / ExecutionNetworkPolicy / ExecutionWorkspaceSource	CPU、内存、磁盘、PID、运行时、输出、网络及 workspace 约束
ExecutionHostError / ExecutionHostErrorCode	稳定的执行边界错误
ExecutionId / ExecutionCheckpointId	执行与 checkpoint 的 branded ID
DockerExecutionHost / DockerExecutionHostOptions	/advanced 导出的 Docker 参考实现

Durable Events

导出	说明
DurableEventStore	append/read/head 的持久化接口
DurableExecutionLeaseStore	显式配置的粘性 fencing Store，提供 acquire/renew/release/assert 与 withExecutionLease
DurableExecutionLeaseOptions	Session lease 的 owner、TTL、heartbeat 和可选 lease ID
DurableExecutionLeaseSnapshot / DurableExecutionFence	当前租约快照及传递给 Store/工具的 fence
DurableExecutionLeaseErrorCode	lease 配置、冲突、缺少 fence、失租、损坏与写入错误码
DurableEventSubscription	支持 replay/caught-up/live 阶段的可重连事件流
durableEventCursor / parseDurableEventCursor	创建和严格解析版本化恢复 cursor
DurableSessionJournal / DurableSessionJournalOptions	command-oriented 串行提交、CAS 重试与对账层
DurableSessionRecoveryCoordinator	Request/Turn rollover、权限消解及模型、工具与 Request 结果对账协调器
DurableSessionCommand / DurableCommandEventDraft	Journal command 与不含重复 commandId 的事件输入
DurableCommandCommitOptions	通过 expectedHeadSequence 固定状态派生 command 的前置 head
DurableCommandCommitResult / DurableCommandCommitStatus	committed / replayed / reconciled 提交结果
DurableSessionJournalError / DurableSessionJournalErrorCode	command、分页和 Store 返回值错误
DurableCommandConflictError	同一 commandId 被用于不同事件
DurableCommandOutcomeUnknownError	写入失败后无法确认 command 是否提交
DurableSessionRecoveryError / DurableSessionRecoveryErrorCode	恢复目标缺失或状态不满足恢复契约
DurableSessionRecoveryRequiredError	Session 恢复前需要输入、模型、权限或工具结果对账
SessionDurableRecorderError	Session runtime 观察到非法 durable 生命周期状态
DurableEventEnvelope / DurableEventDraft	已提交事件与待提交事件
DurableEventDataMap / DurableEventOfType / DurableEventError / DurableEventSchemaVersion / DurableTokenUsage	事件类型到严格 payload 的映射、类型提取、schema 版本及公共 payload
DurableModelResponse / DurableModelToolCall / DurableModelUsage	已完成模型响应、工具调用与用量的持久化结构
DurableInputPriority / DurablePermissionDecision	输入优先级与权限结果
DurableRequestInterruptReason / DurableTurnAbortReason / DurableModelRequestAbortReason	Request、Turn 与模型调用中断原因
DurableToolInterruptBehavior / DurableToolCancelReason / DurableToolOutcomeUnknownReason	工具中断、取消及未知结果原因
DurableSessionCloseReason	Session 关闭原因
DurableEventAppendOptions / DurableEventAppendResult	compare-and-append 参数与结果
DurableEventReadOptions / DurableEventPage	cursor 分页读取参数与结果
JsonlDurableEventStoreOptions	JSONL Store 时钟、事件 ID factory、lockTimeoutMs 与 operationTimeoutMs
DurableEventStoreTimeoutError	durable append/read/head 调用超过 deadline
DurableExecutionLeaseTimeoutError	lease Store 调用超过 deadline
DurableEventCursor / DURABLE_EVENT_CURSOR_VERSION	绑定 Session、sequence 和 event ID 的 cursor
DurableEventSubscriptionOptions / DurableEventSubscriptionMessage	订阅配置与 event/caught-up 消息
DurableEventSubscriptionError / DurableEventSubscriptionErrorCode	cursor、分页或订阅配置错误
DurableEventType / isDurableEventType	生命周期事件名及运行时类型判断
DurableSessionProjector / projectDurableSession	增量或一次性重建并校验 Session 生命周期
planDurableSessionRecovery / DurableSessionRecoveryPlan	分类未完成 Request、Turn、Tool 与 Permission
DurableSessionProjection / DurableSessionProjectionStatus	Session 当前 durable 状态及全局已对账输入
DurableRequestProjection / DurableRequestStatus	活动 Request 状态、已应用、待准备及已对账输入
DurableRequestRecoveryOrigin	continuation Request 的 source Request/Turn provenance
DurableRequestRecoveryKind	区分 active-Turn 与 synthetic pre-Turn recovery
DurableTurnProjection / DurableTurnStatus	活动 Turn 状态
DurableModelAttemptProjection / DurableModelAttemptStatus	当前 Turn 的模型调用尝试状态
DurableToolAttemptProjection / DurableToolAttemptStatus	当前 Turn 的工具尝试状态
DurablePermissionProjection / DurablePermissionStatus	工具权限状态
DurableSessionRecoveryAction	恢复动作判别值
DurableAcceptedRequestRecovery	可自动恢复且带完整执行快照的 accepted Request
DurableSessionResumeDecision	ready / resume_accepted_request / recovery_required 决策
DurableRequestRolloverCommand / DurableRequestRolloverResult	首个 Turn 前的原子 Request rollover 命令及结果
DurableRequestOutcomeReconciliation / DurableRequestOutcomeReconciliationCommand	Turn 后缺失 Request 终态时的显式对账输入
DurableModelOutcomeReconciliation / DurableModelOutcomeReconciliationCommand	未知模型调用结果的显式对账输入
DurableToolOutcomeReconciliation / DurableToolOutcomeReconciliationCommand	显式工具结果对账输入
DurableToolStartCommand	恢复执行前持久化 tool_started 的幂等命令
DurableTurnRecoveryCommand / DurableTurnRecoveryResult	原子 Turn rollover 命令及结果
DurablePermissionResolutionCommand	幂等权限消解输入
DurableRecoveryCommitResult	对账提交结果及更新后的 projection/recovery plan
DURABLE_EVENT_SCHEMA_VERSION / DURABLE_EVENT_LOG_FORMAT	wire schema 与日志格式版本
DurableEventProjectionError	生命周期事件顺序或关联关系非法
DurableEventSequenceConflictError	CAS 序列冲突错误
DurableEventStoreError / DurableEventStoreErrorCode	参数、I/O 和日志损坏错误
parseDurableEventDraft / parseDurableEventEnvelope	严格 schema 解析
parsePersistedDurableEventBatch / PersistedDurableEventBatch	JSONL batch 解析与类型

工具

类型	说明
BuiltinToolGroup	内置工具分组
ToolBehavior	工具行为配置
ToolSideEffect	工具副作用契约：pure / idempotent / non_idempotent
ToolEffect	工具副作用描述
ToolDefinition	工具定义接口
ToolDefinitionInput	defineTool() 接受的 TypeBox schema 与返回 JSON 数据的 async function
ToolDescription	工具描述（短描述/长描述/使用提示/示例）
ToolExecution	工具的异步生成器执行契约
ToolExecutionLifecycle	Request 级工具 scheduled / settled 持久化边界
ToolExecutionStartedLifecycle	最终执行输入与解析后副作用等级
ToolInvocationLifecycle	单次工具权限与副作用开始边界
ToolScheduledLifecycle / ToolSettledLifecycle	工具调度与终态 payload
ToolPermissionResolution	权限请求的 durable 决策 payload
ConfirmationDetails	确认请求详情；abortSignal 为当前 Request 的取消信号
ConfirmationHandler	交互式确认处理器
ConfirmationResponse	交互式确认结果
ToolYield	工具产生的结构化进度、展示消息或 effect
ToolProgress	可选包含计数、结构化数据和恢复令牌的进度事件
ToolMessage	面向用户界面的执行消息
ToolEffectYield	工具产生的运行时 effect 事件
ToolResult	工具执行的最终成功/失败结果
ToolModelContent	回写模型上下文的工具内容
ToolDisplayContent	展示给用户的工具内容
ExecutionContext	工具执行上下文
RuntimeAccess	工具执行期的租约校验与 fencing 能力
ToolServiceMap	defineTool 可按需声明的会话级服务映射
ToolServiceName	ToolServiceMap 的合法服务名联合
ToolExecutionRecord	工具调用记录
ToolExposureConfig	工具暴露配置
ToolExposureMode	工具暴露模式
ToolExecutionUpdate	工具执行过程更新事件

ToolBehavior.sideEffect 必须显式声明并决定 started tool 是否可在恢复时重放。 ToolBehavior.interruptBehavior 默认为 block。只有能够观察 AbortSignal 并可靠清理资源的工具才应声明为 cancel。 ToolInvocation 是 Pipeline 内部类型，不从包入口导出；Hook 或权限处理器改写参数后 会重新执行 prepare()。

工具来源策略

类型	说明
ToolSourcePolicy	工具来源策略（按来源类型和信任级别过滤）
ToolSourceKind	工具来源类型（builtin / custom / mcp / session）
ToolTrustLevel	工具信任级别（trusted / workspace / remote）
WebFetchSecurityPolicy	WebFetch 主机白名单、黑名单与私网访问策略

Memory

类型	说明
Memory	Memory 记录类型
MemoryInput	Memory 写入输入类型
MemoryStore	Memory 后端抽象接口
MemoryType	Memory 类型（user / feedback / project / reference）

memoryReadTool 和 memoryWriteTool 是静态 Tool。通过 SessionOptions.memoryManager 启用后，Session Registry 会注册这两个工具，并仅 向它们注入指定的 Memory Manager。

Provider

类型	说明
ProviderRegistry	实例级 Provider adapter Registry
ProviderRegistryError	Registry 配置与查找错误
ProviderRegistryErrorCode	Registry 错误码
ProviderAdapter	自定义 provider adapter 契约
ProviderConnectionConfig	Provider 配置
BuiltinProviderType	内置 Provider adapter 类型字面量
ProviderType	内置或自定义 Provider adapter 类型
PROVIDER_TYPES / isBuiltinProviderType	内置 Provider catalog 与类型守卫
ModelConfig	Registry 中可注册、可切换的模型描述
ModelServiceConfig	传给 Provider adapter 的模型请求配置
ModelService	Provider adapter 返回的聊天服务契约
ModelMessage / ModelContent / ModelToolCall	Provider 无关的模型请求负载与工具调用
ConversationMessage	Agent/Session 消息信封，包含来源、关联、遥测和扩展字段
ConversationMessageSource	受控的会话消息来源类型
CONVERSATION_MESSAGE_SOURCES / isConversationMessageSource	消息来源枚举与类型守卫
ModelTextContent / ModelImageContent	文本与图片内容 part
ModelToolCallDelta / ModelStreamToolCall	流式工具调用增量与聚合类型
ModelResponse / ModelStreamChunk	非流式响应与流式增量
ModelToolDefinition	传给模型的函数定义
ModelProviderOptions / ModelMessageProviderOptions / ModelSideQueryOptions	配置级、消息级 Provider 扩展和 side query 选项
ModelRetryConfig / ModelRetryEvent / QuerySource	模型重试策略、可观察事件与查询来源
ModelIdentity	生成 assistant 消息的 Provider、API adapter 与模型身份
ModelUsage	Provider 返回的原始 token 用量
ModelInfo	模型信息
TokenUsage	Agent/Session 聚合后的 token 预算视图
resolveModelIdentity	从规范化配置解析模型身份
normalizeModelUsage	把 Provider usage 转成 Agent/Session 用量

上述 Provider 无关契约可从 @blade-ai/agent-sdk 单独导入。类型所有权和 边界转换规则见类型架构。

MCP

类型	说明
McpServerConfig	MCP 服务器配置
McpServerStatus	MCP 服务器状态
McpToolInfo	MCP 工具信息
McpToolCallResponse	MCP 工具调用响应
McpToolDefinition	MCP 工具定义
McpToolResponse	MCP 工具响应（ToolResponse 别名）
SdkTool	SDK MCP 工具
SdkMcpServerHandle	通过 type: 'in-process' 判别的进程内 MCP Server 句柄

权限

类型	说明
PermissionResult	权限判定结果
PermissionHandler	底层权限处理器接口
PermissionHandlerRequest	权限处理请求
PermissionRuleValue	权限规则值
PermissionsConfig	Session 权限规则配置
PermissionUpdate	权限更新

Hooks

类型	说明
HookCallback	Hook 回调函数类型
HookInput	Hook 输入
HookOutput	Hook 输出

HookEvent、AgentOptions.advanced.hooks 与 SessionOptions.hooks 接受 SessionStart、SessionEnd、UserPromptSubmit、PermissionRequest、 PreToolUse、PostToolUse、PostToolUseFailure 和 TaskCompleted 这 8 个 内联事件。

Middleware 与插件

类型	说明
Middleware / MiddlewareNext	通用洋葱中间件契约
AgentMiddlewareConfig	Session 级模型与工具 middleware 配置
AgentPlugin	声明式 middleware、hooks 与工具集合
ModelMiddleware	模型调用包装器集合
ModelChatRequest / ModelSideQueryRequest	非流式模型请求
ModelStreamRequest / ModelRetryRequest	流式与重试可见请求
ToolMiddleware / ToolMiddlewareRequest	流式工具执行中间件

详见 Middleware 与插件。

运行时

类型	说明
RuntimeContext	运行时上下文
RuntimePatch	运行时补丁（Skill 激活等场景使用）
RuntimePatchScope	运行时补丁作用域（turn / session）
RuntimePatchSkillInfo	运行时补丁的 Skill 信息
RuntimeToolPolicyPatch	工具策略补丁
RuntimeToolDiscoveryPatch	工具发现补丁
RuntimeModelOverride	模型覆盖配置
RuntimeHookEvent	运行时 Hook 事件
RuntimeHookRegistration	运行时 Hook 注册
RuntimeContextPatch	运行时上下文补丁
ContextSnapshot	上下文快照
OutputFormat	输出格式约束
SandboxSettings	沙箱配置

子 Agent

类型	说明
AgentDefinition	子 Agent 定义
SubagentInfo	子 Agent 信息
SubagentConfig	子 Agent 配置（含 contextOmissions 字段）
SubagentContext	子 Agent 执行上下文
SubagentResult	子 Agent 执行结果
SubagentSource	子 Agent 来源类型
SubagentColor	子 Agent 颜色标识

日志

类型	说明
AgentLogger	日志接口
LogEntry	日志条目
LogLevelName	日志级别

Observability 与错误

类型	说明
ObservabilityOptions	Trace 开关、payload 捕获和 sink 配置
AgentTrace / TraceEvent / TraceSpan	一次 Agent 请求的结构化执行轨迹
TracePayloadSummary / TraceSink	Trace 摘要与输出接口
TraceSpanKind / TraceStatus	Span 类型与状态
SdkErrorOptions / SessionInputErrorCode / HookTimeoutErrorCode / ModelTimeoutErrorCode	SDK 错误元数据
TokenBudgetConfig / TokenBudgetSnapshot	跨轮次 token 预算配置与快照

错误、生命周期与标识符

导出	说明
SdkError / AbortError / ConfigError	SDK 基础错误、中止错误与配置错误
HookTimeoutError	inline hook 事件总时限错误
ModelTimeoutError	非流式模型请求或流式空闲超时错误
ProviderRegistryError	Provider adapter 注册、查找或构造错误
PermissionDeniedError / ToolExecutionError	权限与工具执行错误
getErrorCode / getErrorMessage / getErrorName / toError	未知错误规范化辅助函数
registerCleanup / gracefulShutdown / resetCleanupRegistry	进程级清理生命周期
CleanupFn / CleanupHandle / GracefulShutdownOptions	清理生命周期类型
AgentId / MessageId / ToolUseId	Agent、消息和工具调用 branded identifiers
JsonObject / JsonValue	严格 JSON 类型
lazySingleton	惰性单例辅助函数

DeepSeek 辅助 API

函数与运行时值：

• normalizeDeepSeekModel
• optimizeDeepSeekCachePrefix
• resolveDeepSeekBaseUrl
• sanitizeDeepSeekStrictSchema
• DEEPSEEK_BETA_BASE_URL
• DEEPSEEK_DEFAULT_BASE_URL
• DEEPSEEK_DEFAULT_MODEL

类型：

• DeepSeekCacheOptimizationOptions
• DeepSeekProviderOptions

工具错误

• ToolError
• ToolErrorType