claude agent sdk 指南

消息枚举值

本文是参考卡片,不用顺读。写消息分发、判断块类型或停止原因时来查。

正文见纯聊天。

枚举值

消息类型

枚举值 含义
assistant 助手完整消息(含 message 正文)
user 用户消息(含输入或工具结果回传;含 replay)
result 一轮 query() 结束结果(成功或错误,细节看 subtype)
system 系统/会话事件(初始化、状态、hook、任务、通知等,细节看 subtype)
stream_event 流式增量事件(includePartialMessages 开启时)
tool_progress 工具执行进度
tool_use_summary 工具调用摘要
auth_status 鉴权状态变更
rate_limit_event 限流相关事件
prompt_suggestion 提示词/后续提问建议
conversation_reset 会话被重置(如 /clear)

内容块类型

枚举值 含义
thinking 可读的扩展思考过程
redacted_thinking 被安全脱敏的思考块,仅含不透明 data,无可读文本
text 最终可见文本回复
tool_use 客户端工具调用(需由本地/宿主执行并回传 tool_result)
server_tool_use 服务端工具调用(由 Anthropic 侧执行)
web_search_tool_result 网页搜索工具的结果块
web_fetch_tool_result 网页抓取工具的结果块
code_execution_tool_result 代码执行工具的结果块
bash_code_execution_tool_result Bash 代码执行工具的结果块
text_editor_code_execution_tool_result 文本编辑器类代码执行工具的结果块
tool_search_tool_result 工具搜索的结果块
mcp_tool_use MCP 工具调用
mcp_tool_result MCP 工具执行结果
container_upload 容器上传相关内容块
compaction 上下文压缩相关内容块
advisor_tool_result Advisor 工具结果块
fallback 兼容/回退用内容块

停止原因

枚举值 含义
null 流式未结束或尚未给出停止原因
end_turn 模型自然结束本轮回复
max_tokens 触达请求的 max_tokens 或模型输出上限
stop_sequence 命中自定义停止串;具体字符串见 message.stop_sequence
tool_use 模型发起客户端工具调用,等待工具结果
pause_turn 长回合被暂停,可将响应原样回传以继续
refusal 策略/分类器介入,拒绝继续生成
model_context_window_exceeded 超出模型上下文窗口
compaction (beta)发生上下文压缩相关停止