ストリーミング

Agents SDK は、モデルやその他の実行ステップからの出力を段階的に配信できます。ストリーミングは UI を応答性よく保ち、ユーザーを更新する前に最終的な実行結果のすべてを待つことを避けます。

ストリーミングの有効化

Runner.run() に { stream: true } オプションを渡すと、完全な実行結果ではなくストリーミングオブジェクトを取得します:

Enabling streaming

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Storyteller',
  instructions:
    'You are a storyteller. You will be given a topic and you will tell a story about it.',
});

const result = await run(agent, 'Tell me a story about a cat.', {
  stream: true,
});

ストリーミングが有効な場合、返される stream は AsyncIterable インターフェースを実装します。各 yield されるイベントは、その実行内で何が起きたかを記述するオブジェクトです。ストリームは 3 種類のイベントタイプを yield し、それぞれがエージェントの実行の異なる部分を表します。とはいえ、ほとんどのアプリケーションはモデルのテキストだけが必要なので、ストリームはヘルパーを提供します。

テキスト出力の取得

stream.toTextStream() を呼び出すと、出力されたテキストのストリームを取得できます。compatibleWithNodeStreams が true のとき、戻り値は通常の Node.js Readable です。process.stdout や他の出力先へ直接パイプできます。

Logging out the text as it arrives

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Storyteller',
  instructions:
    'You are a storyteller. You will be given a topic and you will tell a story about it.',
});

const result = await run(agent, 'Tell me a story about a cat.', {
  stream: true,
});

result
  .toTextStream({
    compatibleWithNodeStreams: true,
  })
  .pipe(process.stdout);

stream.completed の Promise は、実行と保留中のコールバックがすべて完了すると解決します。もう出力がないことを確実にしたい場合は、必ず待機してください。

すべてのイベントの受信

for await ループを使って、到着した各イベントを検査できます。役立つ情報として、低レベルのモデルイベント、任意のエージェント切り替え、そして SDK 固有の実行情報などがあります:

Listening to all events

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Storyteller',
  instructions:
    'You are a storyteller. You will be given a topic and you will tell a story about it.',
});

const result = await run(agent, 'Tell me a story about a cat.', {
  stream: true,
});

for await (const event of result) {
  // these are the raw events from the model
  if (event.type === 'raw_model_stream_event') {
    console.log(`${event.type} %o`, event.data);
  }
  // agent updated events
  if (event.type === 'agent_updated_stream_event') {
    console.log(`${event.type} %s`, event.agent.name);
  }
  // Agent SDK specific events
  if (event.type === 'run_item_stream_event') {
    console.log(`${event.type} %o`, event.item);
  }
}

ストリーミングのサンプルコード を参照してください。プレーンテキストのストリームと元のイベントストリームの両方を出力する、完成したスクリプトです。

イベントタイプ

ストリームは 3 種類のイベントタイプを yield します:

raw_model_stream_event

type RunRawModelStreamEvent = {
  type: 'raw_model_stream_event';
  data: ResponseStreamEvent;
};

例:

{
  "type": "raw_model_stream_event",
  "data": {
    "type": "output_text_delta",
    "delta": "Hello"
  }
}

run_item_stream_event

type RunItemStreamEvent = {
  type: 'run_item_stream_event';
  name: RunItemStreamEventName;
  item: RunItem;
};

ハンドオフのペイロード例:

{
  "type": "run_item_stream_event",
  "name": "handoff_occurred",
  "item": {
    "type": "handoff_call",
    "id": "h1",
    "status": "completed",
    "name": "transfer_to_refund_agent"
  }
}

agent_updated_stream_event

type RunAgentUpdatedStreamEvent = {
  type: 'agent_updated_stream_event';
  agent: Agent<any, any>;
};

例:

{
  "type": "agent_updated_stream_event",
  "agent": {
    "name": "Refund Agent"
  }
}

ストリーミング中の Human in the loop（人間の介入）

ストリーミングは、実行を一時停止するハンドオフ（たとえば、ツールに承認が必要な場合）と互換性があります。ストリームオブジェクト上の interruption フィールドで割り込みにアクセスでき、それぞれに対して state.approve() または state.reject() を呼び出して実行を継続できます。{ stream: true } で再実行すると、ストリーミング出力が再開します。

Handling human approval while streaming

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Storyteller',
  instructions:
    'You are a storyteller. You will be given a topic and you will tell a story about it.',
});

let stream = await run(
  agent,
  'What is the weather in San Francisco and Oakland?',
  { stream: true },
);
stream.toTextStream({ compatibleWithNodeStreams: true }).pipe(process.stdout);
await stream.completed;

while (stream.interruptions?.length) {
  console.log(
    'Human-in-the-loop: approval required for the following tool calls:',
  );
  const state = stream.state;
  for (const interruption of stream.interruptions) {
    const approved = confirm(
      `Agent ${interruption.agent.name} would like to use the tool ${interruption.name} with "${interruption.arguments}". Do you approve?`,
    );
    if (approved) {
      state.approve(interruption);
    } else {
      state.reject(interruption);
    }
  }

  // Resume execution with streaming output
  stream = await run(agent, state, { stream: true });
  const textStream = stream.toTextStream({ compatibleWithNodeStreams: true });
  textStream.pipe(process.stdout);
  await stream.completed;
}

ユーザーと対話するより完全な例は human-in-the-loop-stream.ts です。

ヒント

• すべての出力がフラッシュされることを確実にするため、終了前に stream.completed を待つことを忘れないでください
• 最初の { stream: true } オプションは、それを指定した呼び出しにのみ適用されます。RunState で再実行する場合は、もう一度オプションを指定する必要があります
• アプリケーションがテキスト結果だけを必要とする場合は、個々のイベントオブジェクトを扱わずに済むよう toTextStream() を優先してください

ストリーミングとイベントシステムを使えば、エージェントをチャットインターフェース、ターミナルアプリケーション、または段階的な更新がユーザーの利便になるあらゆる場所に統合できます。