Streaming events

StreamEvent module-attribute

StreamEvent: TypeAlias = Union[RawResponsesStreamEvent, RunItemStreamEvent, AgentUpdatedStreamEvent]

来自agent的流式事件。

RawResponsesStreamEvent dataclass

来自LLM的流式事件。这些是“原始”事件，即它们直接从LLM传递过来。

Source code in agents/stream_events.py

@dataclass
class RawResponsesStreamEvent:
    """来自LLM的流式事件。这些是“原始”事件，即它们直接从LLM传递过来。"""

    data: TResponseStreamEvent
    """来自LLM的原始响应流事件。"""

    type: Literal["raw_response_event"] = "raw_response_event"
    """事件的类型。"""

data instance-attribute

data: TResponseStreamEvent

来自LLM的原始响应流事件。

type class-attribute instance-attribute

type: Literal['raw_response_event'] = 'raw_response_event'

事件的类型。

RunItemStreamEvent dataclass

包装了RunItem的流式事件。当agent处理LLM响应时，会为新消息、工具调用、工具输出、交接等生成这些事件。

Source code in agents/stream_events.py

@dataclass
class RunItemStreamEvent:
    """包装了`RunItem`的流式事件。当agent处理LLM响应时，会为新消息、工具调用、工具输出、交接等生成这些事件。"""

    name: Literal[
        "message_output_created",
        "handoff_requested",
        "handoff_occured",
        "tool_called",
        "tool_output",
        "reasoning_item_created",
        "mcp_approval_requested",
        "mcp_list_tools",
    ]
    """事件名称。"""

    item: RunItem
    """被创建的条目。"""

    type: Literal["run_item_stream_event"] = "run_item_stream_event"

name instance-attribute

name: Literal['message_output_created', 'handoff_requested', 'handoff_occured', 'tool_called', 'tool_output', 'reasoning_item_created', 'mcp_approval_requested', 'mcp_list_tools']

事件名称。

item instance-attribute

item: RunItem

被创建的条目。

AgentUpdatedStreamEvent dataclass

通知有新agent正在运行的事件。

Source code in agents/stream_events.py

@dataclass
class AgentUpdatedStreamEvent:
    """通知有新agent正在运行的事件。"""

    new_agent: Agent[Any]
    """新的agent。"""

    type: Literal["agent_updated_stream_event"] = "agent_updated_stream_event"

new_agent instance-attribute

new_agent: Agent[Any]

新的agent。