コンテンツにスキップ

音声エージェントの構築

音声の処理

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',
    },
  },
});

これらのトランスポート層では、session に一致する任意のパラメーターを渡せます。

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],
});

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

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

会話履歴へのアクセス

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

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

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 Session は、ユーザーが話しているタイミングを自動的に検出し、組み込みの 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

いずれの場合も、Realtime Session はエージェントの生成を割り込み、ユーザーに話した内容の認識を切り詰め、履歴を更新します。

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

テキスト入力

Section titled “テキスト入力”

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

これは、エージェントとのやり取りを両方のモダリティで ユーザー に許可したい場合や、会話に追加のコンテキストを提供したい場合に有用です。

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 “ツールによる委譲”

Delegation through tools

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

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);
}