Skip to content

Latest commit

 

History

History
148 lines (109 loc) · 9.95 KB

File metadata and controls

148 lines (109 loc) · 9.95 KB
search
exclude
true

ストリーミング

ストリーミングを使用すると、エージェントの実行中に更新を購読できます。エンドユーザーに進捗状況の更新や部分的なレスポンスを表示する場合に役立ちます。

ストリーミングするには、[Runner.run_streamed()][agents.run.Runner.run_streamed] を呼び出します。これにより、[RunResultStreaming][agents.result.RunResultStreaming] が返されます。result.stream_events() を呼び出すと、以下で説明する [StreamEvent][agents.stream_events.StreamEvent] オブジェクトの非同期ストリームが返されます。

非同期イテレーターが終了するまで、result.stream_events() を消費し続けてください。ストリーミング実行は、イテレーターが終了するまで完了しません。また、セッションの永続化、承認の記録管理、履歴の圧縮などの後処理は、最後に表示されるトークンが到着した後に完了する場合があります。ループが終了すると、result.is_complete に最終的な実行状態が反映されます。

raw レスポンスイベント

[RawResponsesStreamEvent][agents.stream_events.RawResponsesStreamEvent] は、LLM から直接渡される raw イベントです。これらは OpenAI Responses API 形式であり、各イベントには型(response.createdresponse.output_text.delta など)とデータがあります。これらのイベントは、生成されたレスポンスメッセージをすぐにユーザーへストリーミングする場合に役立ちます。

コンピュータツールの raw イベントでは、保存された結果と同様に、プレビュー版と GA 版が区別されます。プレビュー版のフローでは、1 つの action を持つ computer_call 項目がストリーミングされます。一方、gpt-5.5 では、バッチ化された actions[] を持つ computer_call 項目をストリーミングできます。上位レベルの [RunItemStreamEvent][agents.stream_events.RunItemStreamEvent] インターフェースでは、このためにコンピュータ専用の特別なイベント名は追加されません。どちらの形式も引き続き tool_called として公開され、スクリーンショットの結果は computer_call_output 項目をラップする tool_output として返されます。

たとえば、次の例では LLM が生成したテキストをトークン単位で出力します。

import asyncio
from openai.types.responses import ResponseTextDeltaEvent
from agents import Agent, Runner

async def main():
    agent = Agent(
        name="Joker",
        instructions="You are a helpful assistant.",
    )

    result = Runner.run_streamed(agent, input="Please tell me 5 jokes.")
    async for event in result.stream_events():
        if event.type == "raw_response_event" and isinstance(event.data, ResponseTextDeltaEvent):
            print(event.data.delta, end="", flush=True)


if __name__ == "__main__":
    asyncio.run(main())

ストリーミングと承認

ストリーミングは、ツールの承認のために一時停止する実行にも対応しています。ツールに承認が必要な場合、result.stream_events() が終了し、保留中の承認が [RunResultStreaming.interruptions][agents.result.RunResultStreaming.interruptions] で公開されます。result.to_state() を使用して実行結果を [RunState][agents.run_state.RunState] に変換し、中断を承認または拒否してから、Runner.run_streamed(...) で再開します。

result = Runner.run_streamed(agent, "Delete temporary files if they are no longer needed.")
async for _event in result.stream_events():
    pass

if result.interruptions:
    state = result.to_state()
    for interruption in result.interruptions:
        state.approve(interruption)
    result = Runner.run_streamed(agent, state)
    async for _event in result.stream_events():
        pass

一時停止と再開の詳しい手順については、human-in-the-loop ガイドを参照してください。

現在のターン終了後のストリーミングキャンセル

ストリーミング実行を途中で停止する必要がある場合は、[result.cancel()][agents.result.RunResultStreaming.cancel] を呼び出します。デフォルトでは、実行は直ちに停止します。停止する前に現在のターンを正常に完了させるには、代わりに result.cancel(mode="after_turn") を呼び出します。

ストリーミング実行は、result.stream_events() が終了するまで完了しません。最後に表示されるトークンの後も、SDK がセッション項目を永続化したり、承認状態を確定したり、履歴を圧縮したりしている可能性があります。

[result.to_input_list(mode="normalized")][agents.result.RunResultBase.to_input_list] から手動で処理を継続している場合に、cancel(mode="after_turn") がツールターンの後で停止したときは、新しいユーザーターンをすぐに追加するのではなく、正規化された入力で result.last_agent を再実行して、その未完了のターンを継続してください。

  • ストリーミング実行がツールの承認のために停止した場合は、それを新しいターンとして扱わないでください。ストリームを最後まで消費し、result.interruptions を確認して、result.to_state() から再開してください。
  • 次回のモデル呼び出し前に、取得したセッション履歴と新しいユーザー入力をどのように統合するかをカスタマイズするには、[RunConfig.session_input_callback][agents.run.RunConfig.session_input_callback] を使用します。そのコールバック内で新しいターンの項目を書き換えた場合、そのターンでは書き換え後のバージョンが永続化されます。

実行項目イベントとエージェントイベント

[RunItemStreamEvent][agents.stream_events.RunItemStreamEvent] は、より上位レベルのイベントです。項目が完全に生成された時点を通知します。これにより、各トークン単位ではなく、「メッセージが生成された」「ツールが実行された」などの単位で進捗状況の更新を送信できます。同様に、[AgentUpdatedStreamEvent][agents.stream_events.AgentUpdatedStreamEvent] は、現在のエージェントが変更されたとき(ハンドオフの結果など)に更新を提供します。

実行項目のイベント名

RunItemStreamEvent.name では、次の固定された一連の意味的イベント名を使用します。

  • message_output_created
  • handoff_requested
  • handoff_occured
  • tool_called
  • tool_search_called
  • tool_search_output_created
  • tool_output
  • reasoning_item_created
  • mcp_approval_requested
  • mcp_approval_response
  • mcp_list_tools

handoff_occured は、後方互換性のために意図的にスペルミスのままになっています。

ホスト型ツール検索を使用すると、モデルがツール検索リクエストを発行したときに tool_search_called が生成され、Responses API が読み込まれたサブセットを返したときに tool_search_output_created が生成されます。

プログラムによるツール呼び出しでは、生成された program と、プログラムが所有する通常の子ツール呼び出しに対して tool_called が生成されます。子ツールの出力と対応する program_output に対しては、tool_output が生成されます。プログラムが所有するホスト型 MCP の mcp_approval_request 項目と mcp_list_tools 項目は例外です。これらはそれぞれ、[MCPApprovalRequestItem][agents.items.MCPApprovalRequestItem] と [MCPListToolsItem][agents.items.MCPListToolsItem] をラップする mcp_approval_requested および mcp_list_tools として生成されます。残りの項目を区別するには、raw 項目の type を確認してください。また、プログラムが所有する子呼び出しには caller も含まれ、その型は program で、呼び出し元 ID によって親プログラムが識別されます。

たとえば、次の例では raw イベントを無視し、ユーザーへの更新をストリーミングします。

import asyncio
import random
from agents import Agent, ItemHelpers, Runner
from agents.decorators import tool

@tool
def how_many_jokes() -> int:
    return random.randint(1, 10)


async def main():
    agent = Agent(
        name="Joker",
        instructions="First call the `how_many_jokes` tool, then tell that many jokes.",
        tools=[how_many_jokes],
    )

    result = Runner.run_streamed(
        agent,
        input="Hello",
    )
    print("=== Run starting ===")

    async for event in result.stream_events():
        # We'll ignore the raw responses event deltas
        if event.type == "raw_response_event":
            continue
        # When the agent updates, print that
        elif event.type == "agent_updated_stream_event":
            print(f"Agent updated: {event.new_agent.name}")
            continue
        # When items are generated, print them
        elif event.type == "run_item_stream_event":
            if event.item.type == "tool_call_item":
                print("-- Tool was called")
            elif event.item.type == "tool_call_output_item":
                print(f"-- Tool output: {event.item.output}")
            elif event.item.type == "message_output_item":
                print(f"-- Message output:\n {ItemHelpers.text_message_output(event.item)}")
            else:
                pass  # Ignore other event types

    print("=== Run complete ===")


if __name__ == "__main__":
    asyncio.run(main())