Claude Code Agent SDK 入门

实时流式输出

6 分钟阅读

实时流式传输响应

当文本和工具调用流入时，从 Agent SDK 获取实时响应

默认情况下，Agent SDK 在 Claude 完成生成每个响应后会产生完整的 AssistantMessage 对象。要在文本和工具调用生成时接收增量更新，请通过在选项中将 include_partial_messages（Python）或 includePartialMessages（TypeScript）设置为 true 来启用部分消息流式传输。

本页面涵盖输出流式传输（实时接收Token）。有关输入模式（如何发送消息），请参阅向智能体发送消息。您也可以通过 CLI 使用 Agent SDK 流式传输响应。

启用流式输出

要启用流式传输，请在选项中将 include_partial_messages（Python）或 includePartialMessages（TypeScript）设置为 true。这会导致 SDK 产生包含原始 API 事件的 StreamEvent 消息，这些事件在到达时产生，除了通常的 AssistantMessage 和 ResultMessage 之外。

您的代码需要：

检查每条消息的类型以区分 StreamEvent 和其他消息类型
对于 StreamEvent，提取 event 字段并检查其 type
查找 content_block_delta 事件，其中 delta.type 是 text_delta，这些事件包含实际的文本块

下面的示例启用流式传输并在文本块到达时打印它们。注意嵌套的类型检查：首先是 StreamEvent，然后是 content_block_delta，最后是 text_delta：

from claude_agent_sdk import query, ClaudeAgentOptions
from claude_agent_sdk.types import StreamEvent
import asyncio


async def stream_response():
    options = ClaudeAgentOptions(
        include_partial_messages=True,
        allowed_tools=["Bash", "Read"],
    )

    async for message in query(prompt="List the files in my project", options=options):
        if isinstance(message, StreamEvent):
            event = message.event
            if event.get("type") == "content_block_delta":
                delta = event.get("delta", {})
                if delta.get("type") == "text_delta":
                    print(delta.get("text", ""), end="", flush=True)


asyncio.run(stream_response())

StreamEvent 参考

启用部分消息后，您会收到包装在对象中的原始 Claude API 流式事件。该类型在每个 SDK 中有不同的名称：

Python: StreamEvent（从 claude_agent_sdk.types 导入）
TypeScript: SDKPartialAssistantMessage，其中 type: 'stream_event'

两者都包含原始 Claude API 事件，而不是累积的文本。您需要自己提取和累积文本增量。以下是每种类型的结构：

@dataclass
class StreamEvent:
    uuid: str  # 此事件的唯一标识符
    session_id: str  # 会话标识符
    event: dict[str, Any]  # 原始 Claude API 流事件
    parent_tool_use_id: str | None  # 始终为 None

parent_tool_use_id 字段在 Python 中始终为 None，在 TypeScript 中始终为 null。流事件仅针对主会话发出；来自子智能体的Token级增量不会被转发。要将输出归属于子智能体，请使用完整消息，这些消息携带 parent_tool_use_id。请参阅检测子智能体调用。

event 字段包含来自 Claude API 的原始流事件。常见的事件类型包括：

事件类型	描述
`message_start`	新消息的开始
`content_block_start`	新内容块的开始（文本或工具使用）
`content_block_delta`	内容的增量更新
`content_block_stop`	内容块的结束
`message_delta`	消息级别的更新（停止原因、使用情况）
`message_stop`	消息的结束

消息流

启用部分消息后，您会按以下顺序接收消息：

StreamEvent (message_start)
StreamEvent (content_block_start) - 文本块
StreamEvent (content_block_delta) - 文本块...
StreamEvent (content_block_stop)
StreamEvent (content_block_start) - tool_use 块
StreamEvent (content_block_delta) - 工具输入块...
StreamEvent (content_block_stop)
StreamEvent (message_delta)
StreamEvent (message_stop)
AssistantMessage - 包含所有内容的完整消息
... 工具执行 ...
... 下一轮的更多流事件 ...
ResultMessage - 最终结果

未启用部分消息（Python 中的 include_partial_messages，TypeScript 中的 includePartialMessages）时，您会收到除 StreamEvent 之外的所有消息类型。常见类型包括 SystemMessage（会话初始化）、AssistantMessage（完整响应）、ResultMessage（最终结果）和指示何时压缩对话历史的紧凑边界消息（TypeScript 中的 SDKCompactBoundaryMessage；Python 中的 SystemMessage，子类型为 "compact_boundary"）。

流式传输文本响应

要在生成文本时显示它，请查找 content_block_delta 事件，其中 delta.type 是 text_delta。这些包含增量文本块。下面的示例在每个块到达时打印它：

from claude_agent_sdk import query, ClaudeAgentOptions
from claude_agent_sdk.types import StreamEvent
import asyncio


async def stream_text():
    options = ClaudeAgentOptions(include_partial_messages=True)

    async for message in query(prompt="Explain how databases work", options=options):
        if isinstance(message, StreamEvent):
            event = message.event
            if event.get("type") == "content_block_delta":
                delta = event.get("delta", {})
                if delta.get("type") == "text_delta":
                    # 在每个文本块到达时打印它
                    print(delta.get("text", ""), end="", flush=True)

    print()  # 最后的换行符


asyncio.run(stream_text())

流式传输工具调用

工具调用也会增量流式传输。您可以跟踪工具何时开始、在生成时接收其输入，以及查看它们何时完成。下面的示例跟踪当前被调用的工具并在流式传输时累积 JSON 输入。它使用三种事件类型：

content_block_start：工具开始
content_block_delta，带有 input_json_delta：输入块到达
content_block_stop：工具调用完成

from claude_agent_sdk import query, ClaudeAgentOptions
from claude_agent_sdk.types import StreamEvent
import asyncio


async def stream_tool_calls():
    options = ClaudeAgentOptions(
        include_partial_messages=True,
        allowed_tools=["Read", "Bash"],
    )

    # 跟踪当前工具并累积其输入 JSON
    current_tool = None
    tool_input = ""

    async for message in query(prompt="Read the README.md file", options=options):
        if isinstance(message, StreamEvent):
            event = message.event
            event_type = event.get("type")

            if event_type == "content_block_start":
                # 新工具调用开始
                content_block = event.get("content_block", {})
                if content_block.get("type") == "tool_use":
                    current_tool = content_block.get("name")
                    tool_input = ""
                    print(f"Starting tool: {current_tool}")

            elif event_type == "content_block_delta":
                delta = event.get("delta", {})
                if delta.get("type") == "input_json_delta":
                    # 在流式传输时累积 JSON 输入
                    chunk = delta.get("partial_json", "")
                    tool_input += chunk
                    print(f"  Input chunk: {chunk}")

            elif event_type == "content_block_stop":
                # 工具调用完成 - 显示最终输入
                if current_tool:
                    print(f"Tool {current_tool} called with: {tool_input}")
                    current_tool = None


asyncio.run(stream_tool_calls())

构建流式 UI

此示例将文本和工具流式传输结合到一个有凝聚力的 UI 中。它跟踪智能体当前是否正在执行工具（使用 in_tool 标志）以显示状态指示器，如 [Using Read...]，同时工具运行。当不在工具中时文本正常流式传输，工具完成会触发"完成"消息。此模式对于需要在多步骤智能体任务期间显示进度的聊天界面很有用。

from claude_agent_sdk import query, ClaudeAgentOptions, ResultMessage
from claude_agent_sdk.types import StreamEvent
import asyncio
import sys


async def streaming_ui():
    options = ClaudeAgentOptions(
        include_partial_messages=True,
        allowed_tools=["Read", "Bash", "Grep"],
    )

    # 跟踪我们当前是否在工具调用中
    in_tool = False

    async for message in query(
        prompt="Find all TODO comments in the codebase", options=options
    ):
        if isinstance(message, StreamEvent):
            event = message.event
            event_type = event.get("type")

            if event_type == "content_block_start":
                content_block = event.get("content_block", {})
                if content_block.get("type") == "tool_use":
                    # 工具调用开始 - 显示状态指示器
                    tool_name = content_block.get("name")
                    print(f"\n[Using {tool_name}...]", end="", flush=True)
                    in_tool = True

            elif event_type == "content_block_delta":
                delta = event.get("delta", {})
                # 仅在不执行工具时流式传输文本
                if delta.get("type") == "text_delta" and not in_tool:
                    sys.stdout.write(delta.get("text", ""))
                    sys.stdout.flush()

            elif event_type == "content_block_stop":
                if in_tool:
                    # 工具调用完成
                    print(" done", flush=True)
                    in_tool = False

        elif isinstance(message, ResultMessage):
            # 智能体完成所有工作
            print(f"\n\n--- Complete ---")


asyncio.run(streaming_ui())

已知限制

结构化输出：JSON 结果仅出现在最终 ResultMessage.structured_output 中，而不是作为流式增量。有关详细信息，请参阅结构化输出。

后续步骤

现在您可以实时流式传输文本和工具调用，请探索这些相关主题：

交互式与一次性查询：为您的用例选择输入模式
结构化输出：从智能体获取类型化的 JSON 响应
权限：控制智能体可以使用哪些工具