コンテンツにスキップ

音声エージェントの構築

音声の取り扱い

Section titled “音声の取り扱い”

デフォルトの OpenAIRealtimeWebRTC のような一部のトランスポート層は、音声の入出力を自動で処理します。OpenAIRealtimeWebSocket のような他のトランスポートでは、セッションの音声を自分で扱う必要があります:

import {
  RealtimeAgent,
  RealtimeSession,
  TransportLayerAudio,
} from '@openai/agents/realtime';


const agent = new RealtimeAgent({ name: 'My agent' });
const session = new RealtimeSession(agent);
const newlyRecordedAudio = new ArrayBuffer(0);


session.on('audio', (event: TransportLayerAudio) => {
  // play your audio
});


// send new audio to the agent
session.sendAudio(newlyRecordedAudio);

セッション設定

Section titled “セッション設定”

RealtimeSession のコンストラクター、または connect(...) 呼び出し時に追加オプションを渡すことで、セッションを設定できます。

import { RealtimeAgent, RealtimeSession } from '@openai/agents/realtime';


const agent = new RealtimeAgent({
  name: 'Greeter',
  instructions: 'Greet the user with cheer and answer questions.',
});


const session = new RealtimeSession(agent, {
  model: 'gpt-realtime',
  config: {
    inputAudioFormat: 'pcm16',
    outputAudioFormat: 'pcm16',
    inputAudioTranscription: {
      model: 'gpt-4o-mini-transcribe',
    },
  },
});

これらのトランスポート層は、セッション に一致する任意のパラメーターを受け取れます。

RealtimeSessionConfig に対応するパラメーターがまだ存在しない新しいパラメーターについては、providerData を使用できます。providerData に渡した内容は session オブジェクトの一部としてそのまま渡されます。

ハンドオフ

Section titled “ハンドオフ”

通常のエージェントと同様に、ハンドオフを使ってエージェントを複数のエージェントに分割し、それらの間をオーケストレーションしてエージェントのパフォーマンスを高め、問題の範囲を適切に絞り込めます。

import { RealtimeAgent } from '@openai/agents/realtime';


const mathTutorAgent = new RealtimeAgent({
  name: 'Math Tutor',
  handoffDescription: 'Specialist agent for math questions',
  instructions:
    'You provide help with math problems. Explain your reasoning at each step and include examples',
});


const agent = new RealtimeAgent({
  name: 'Greeter',
  instructions: 'Greet the user with cheer and answer questions.',
  handoffs: [mathTutorAgent],
});

通常のエージェントとは異なり、リアルタイムエージェントではハンドオフの挙動が少し異なります。ハンドオフが行われると、進行中のセッションは新しいエージェント設定で更新されます。このため、エージェントは進行中の会話履歴に自動的にアクセスでき、入力フィルターは現在適用されません。

さらに、ハンドオフの一部として voice や model を変更することはできません。接続できるのは他のリアルタイムエージェントのみです。別のモデル、たとえば gpt-5-mini のような推論モデルを使う必要がある場合は、ツールによる委譲 を使用できます。

ツール

Section titled “ツール”

通常のエージェントと同様に、リアルタイムエージェントはツールを呼び出してアクションを実行できます。通常のエージェントで使うのと同じ tool() 関数でツールを定義できます。

import { tool, RealtimeAgent } from '@openai/agents/realtime';
import { z } from 'zod';


const getWeather = tool({
  name: 'get_weather',
  description: 'Return the weather for a city.',
  parameters: z.object({ city: z.string() }),
  async execute({ city }) {
    return `The weather in ${city} is sunny.`;
  },
});


const weatherAgent = new RealtimeAgent({
  name: 'Weather assistant',
  instructions: 'Answer weather questions.',
  tools: [getWeather],
});

リアルタイムエージェントで使用できるのは 関数ツール のみで、これらのツールはリアルタイムセッションと同じ場所で実行されます。つまり、ブラウザでリアルタイムセッションを実行している場合、ツールもブラウザで実行されます。より機微な処理が必要な場合は、ツール内からバックエンド サーバー への HTTP リクエストを行ってください。

ツールの実行中、エージェントはユーザーからの新しいリクエストを処理できません。体験を改善する 1 つの方法は、ツールを実行しようとしていることをエージェントにアナウンスさせたり、ツールの実行時間を稼ぐための定型フレーズを話させたりすることです。

会話履歴へのアクセス

Section titled “会話履歴へのアクセス”

エージェントが特定のツールを呼び出した際の引数に加えて、リアルタイムセッションで追跡されている現在の会話履歴のスナップショットにもアクセスできます。これは、会話の現在の状態に基づいてより複雑なアクションを実行する必要がある場合や、委譲のためのツール を使う予定がある場合に有用です。

import {
  tool,
  RealtimeContextData,
  RealtimeItem,
} from '@openai/agents/realtime';
import { z } from 'zod';


const parameters = z.object({
  request: z.string(),
});


const refundTool = tool<typeof parameters, RealtimeContextData>({
  name: 'Refund Expert',
  description: 'Evaluate a refund',
  parameters,
  execute: async ({ request }, details) => {
    // The history might not be available
    const history: RealtimeItem[] = details?.context?.history ?? [];
    // making your call to process the refund request
  },
});

ツール実行前の承認

Section titled “ツール実行前の承認”

needsApproval: true でツールを定義すると、エージェントはツールを実行する前に tool_approval_requested イベントを発行します。

このイベントをリッスンすることで、ツール呼び出しの承認・拒否を ユーザー に促す UI を表示できます。

import { session } from './agent';


session.on('tool_approval_requested', (_context, _agent, request) => {
  // show a UI to the user to approve or reject the tool call
  // you can use the `session.approve(...)` or `session.reject(...)` methods to approve or reject the tool call


  session.approve(request.approvalItem); // or session.reject(request.rawItem);
});

ガードレール

Section titled “ガードレール”

ガードレールは、エージェントの発話が一連のルールに違反していないかを監視し、違反時に応答を即座に遮断する手段を提供します。これらのガードレールチェックはエージェントの応答の文字起こしに基づいて実行されるため、モデルのテキスト出力が有効である必要があります（デフォルトで有効）。

提供したガードレールは、モデル応答の返却中に非同期で実行され、あらかじめ定義した分類トリガー（例:「特定の禁止ワードに言及」）に基づいて応答を遮断できます。

ガードレールが発火すると、セッションは guardrail_tripped イベントを発行します。このイベントは、ガードレールをトリガーした itemId を含む details オブジェクトも提供します。

import { RealtimeOutputGuardrail, RealtimeAgent, RealtimeSession } from '@openai/agents/realtime';


const agent = new RealtimeAgent({
  name: 'Greeter',
  instructions: 'Greet the user with cheer and answer questions.',
});


const guardrails: RealtimeOutputGuardrail[] = [
  {
    name: 'No mention of Dom',
    async execute({ agentOutput }) {
      const domInOutput = agentOutput.includes('Dom');
      return {
        tripwireTriggered: domInOutput,
        outputInfo: { domInOutput },
      };
    },
  },
];


const guardedSession = new RealtimeSession(agent, {
  outputGuardrails: guardrails,
});

デフォルトでは、ガードレールは 100 文字ごと、または応答テキストの末尾で実行されます。音声での読み上げは通常より時間がかかるため、多くの場合、ユーザーが聞く前にガードレールが違反を検知できます。

この動作を変更したい場合は、outputGuardrailSettings オブジェクトをセッションに渡してください。

import { RealtimeAgent, RealtimeSession } from '@openai/agents/realtime';


const agent = new RealtimeAgent({
  name: 'Greeter',
  instructions: 'Greet the user with cheer and answer questions.',
});


const guardedSession = new RealtimeSession(agent, {
  outputGuardrails: [
    /*...*/
  ],
  outputGuardrailSettings: {
    debounceTextLength: 500, // run guardrail every 500 characters or set it to -1 to run it only at the end
  },
});

ターン検出 / 音声アクティビティ検出

Section titled “ターン検出 / 音声アクティビティ検出”

リアルタイムセッションは、ユーザーが話しているタイミングを自動検出し、組み込みの Realtime API の音声アクティビティ検出モード を使って新しいターンを開始します。

turnDetection オブジェクトをセッションに渡すことで、音声アクティビティ検出モードを変更できます。

import { RealtimeSession } from '@openai/agents/realtime';
import { agent } from './agent';


const session = new RealtimeSession(agent, {
  model: 'gpt-realtime',
  config: {
    turnDetection: {
      type: 'semantic_vad',
      eagerness: 'medium',
      createResponse: true,
      interruptResponse: true,
    },
  },
});

ターン検出の設定を調整することで、不要な割り込みや無音への対応を改善できます。各種設定の詳細は Realtime API ドキュメント を参照してください

割り込み

Section titled “割り込み”

組み込みの音声アクティビティ検出を使用している場合、エージェントの発話に被せて話すと、自動的に検知して、発話内容に基づいてコンテキストを更新します。同時に audio_interrupted イベントも発行します。これは、すべての音声再生を即時停止するために使用できます（WebSocket 接続にのみ適用）。

import { session } from './agent';


session.on('audio_interrupted', () => {
  // handle local playback interruption
});

UI に「停止」ボタンを用意するなど、手動で割り込みを行いたい場合は、interrupt() を手動で呼び出せます:

import { session } from './agent';


session.interrupt();
// this will still trigger the `audio_interrupted` event for you
// to cut off the audio playback when using WebSockets

いずれの場合も、リアルタイムセッションはエージェントの生成を中断し、ユーザーに話した内容の認識を切り捨て、履歴を更新します。

エージェントに WebRTC で接続している場合は、音声出力もクリアされます。WebSocket を使用している場合は、キューに入っている音声の再生停止を自前で処理する必要があります。

テキスト入力

Section titled “テキスト入力”

エージェントにテキスト入力を送信したい場合、RealtimeSession の sendMessage メソッドを使用できます。

エージェントとのインターフェースを 2 つのモダリティで有効にしたい場合や、会話に追加のコンテキストを提供したい場合に便利です。

import { RealtimeSession, RealtimeAgent } from '@openai/agents/realtime';


const agent = new RealtimeAgent({
  name: 'Assistant',
});


const session = new RealtimeSession(agent, {
  model: 'gpt-realtime',
});


session.sendMessage('Hello, how are you?');

会話履歴の管理

Section titled “会話履歴の管理”

RealtimeSession は history プロパティで会話履歴を自動的に管理します:

これを使って履歴をユーザーに表示したり、追加の処理を行ったりできます。会話の進行中は履歴が継続的に変化するため、history_updated イベントをリッスンできます。

履歴を変更したい場合（メッセージを完全に削除する、文字起こしを更新するなど）は、updateHistory メソッドを使用します。

import { RealtimeSession, RealtimeAgent } from '@openai/agents/realtime';


const agent = new RealtimeAgent({
  name: 'Assistant',
});


const session = new RealtimeSession(agent, {
  model: 'gpt-realtime',
});


await session.connect({ apiKey: '<client-api-key>' });


// listening to the history_updated event
session.on('history_updated', (history) => {
  // returns the full history of the session
  console.log(history);
});


// Option 1: explicit setting
session.updateHistory([
  /* specific history */
]);


// Option 2: override based on current state like removing all agent messages
session.updateHistory((currentHistory) => {
  return currentHistory.filter(
    (item) => !(item.type === 'message' && item.role === 'assistant'),
  );
});

制限事項

Section titled “制限事項”
  1. 現時点では、関数ツール呼び出しを後から更新・変更することはできません
  2. 履歴でのテキスト出力には、文字起こしとテキストモダリティの有効化が必要です
  3. 割り込みにより途中で打ち切られた応答には文字起こしがありません

ツールによる委譲

Section titled “ツールによる委譲”

ツールによる委譲

会話履歴とツール呼び出しを組み合わせることで、会話を別のバックエンド エージェントに委譲して、より複雑なアクションを実行し、その結果を ユーザー に返すことができます。

import {
  RealtimeAgent,
  RealtimeContextData,
  tool,
} from '@openai/agents/realtime';
import { handleRefundRequest } from './serverAgent';
import z from 'zod';


const refundSupervisorParameters = z.object({
  request: z.string(),
});


const refundSupervisor = tool<
  typeof refundSupervisorParameters,
  RealtimeContextData
>({
  name: 'escalateToRefundSupervisor',
  description: 'Escalate a refund request to the refund supervisor',
  parameters: refundSupervisorParameters,
  execute: async ({ request }, details) => {
    // This will execute on the server
    return handleRefundRequest(request, details?.context?.history ?? []);
  },
});


const agent = new RealtimeAgent({
  name: 'Customer Support',
  instructions:
    'You are a customer support agent. If you receive any requests for refunds, you need to delegate to your supervisor.',
  tools: [refundSupervisor],
});

以下のコードは サーバー 上で実行されます。この例では Next.js の Server Actions を使用しています。

// This runs on the server
import 'server-only';


import { Agent, run } from '@openai/agents';
import type { RealtimeItem } from '@openai/agents/realtime';
import z from 'zod';


const agent = new Agent({
  name: 'Refund Expert',
  instructions:
    'You are a refund expert. You are given a request to process a refund and you need to determine if the request is valid.',
  model: 'gpt-5-mini',
  outputType: z.object({
    reasong: z.string(),
    refundApproved: z.boolean(),
  }),
});


export async function handleRefundRequest(
  request: string,
  history: RealtimeItem[],
) {
  const input = `
The user has requested a refund.


The request is: ${request}


Current conversation history:
${JSON.stringify(history, null, 2)}
`.trim();


  const result = await run(agent, input);


  return JSON.stringify(result.finalOutput, null, 2);
}