ガイド

このガイドでは、 OpenAI Agents SDK の realtime 機能を使用して音声対応の AI エージェントを構築する方法を詳しく説明します。

ベータ機能

Realtime エージェントはベータ版です。実装の改善に伴い、破壊的変更が発生する可能性があります。

概要

Realtime エージェントは、会話フローを可能にし、音声とテキスト入力をリアルタイムで処理し、リアルタイム音声で応答します。OpenAI の Realtime API との永続的な接続を維持し、低遅延で自然な音声会話と、割り込みへの柔軟な対応を実現します。

アーキテクチャ

コアコンポーネント

realtime システムは次の主要コンポーネントで構成されます:

RealtimeAgent: instructions、ツール、ハンドオフで構成されたエージェント。
RealtimeRunner: 構成を管理します。runner.run() を呼び出してセッションを取得できます。
RealtimeSession: 単一の対話セッション。通常、ユーザーが会話を開始するたびに作成し、会話が終了するまで存続させます。
RealtimeModel: 基盤となるモデルインターフェース（通常は OpenAI の WebSocket 実装）

セッションフロー

一般的な realtime セッションの流れは次のとおりです:

instructions、ツール、ハンドオフを使用して RealtimeAgent を作成 します。
エージェントと構成オプションで RealtimeRunner を設定 します。
await runner.run() を使用して セッションを開始 し、 RealtimeSession が返されます。
send_audio() または send_message() を使用して 音声またはテキストメッセージを送信 します。
セッションを反復処理して イベントをリッスン します。イベントには音声出力、書き起こし、ツール呼び出し、ハンドオフ、エラーが含まれます。
ユーザーがエージェントの発話に被せて話した場合の 割り込みを処理 します。これにより現在の音声生成は自動で停止します。

セッションは会話履歴を維持し、realtime モデルとの永続的な接続を管理します。

エージェント設定

RealtimeAgent は、通常の Agent クラスと同様に動作しますが、いくつか重要な違いがあります。完全な API の詳細は、RealtimeAgent の API リファレンスをご確認ください。

通常のエージェントとの主な違い:

モデルの選択はエージェントレベルではなく、セッションレベルで設定します。
structured outputs のサポートはありません（outputType はサポートされません）。
声質はエージェントごとに設定できますが、最初のエージェントが話し始めた後は変更できません。
ツール、ハンドオフ、instructions などのその他の機能は同様に動作します。

セッション設定

モデル設定

セッション設定では、基盤となる realtime モデルの動作を制御できます。モデル名（gpt-realtime など）、声質（alloy、echo、fable、onyx、nova、shimmer）およびサポートするモダリティ（テキストおよび/または音声）を設定できます。音声フォーマットは入力と出力の両方に設定でき、デフォルトは PCM16 です。

音声設定

音声設定は、セッションが音声入力と出力をどのように扱うかを制御します。Whisper などのモデルを使用した入力音声の書き起こし、言語設定、ドメイン固有用語の精度を高めるための書き起こしプロンプトを設定できます。発話区間検出（turn detection）の設定では、エージェントが応答を開始・終了するタイミングを制御でき、音声活動検出のしきい値、無音時間、検出された音声の前後に付与するパディングなどのオプションがあります。

ツールと関数

ツールの追加

通常のエージェントと同様に、realtime エージェントは会話中に実行される関数ツールをサポートします:

from agents import function_tool

@function_tool
def get_weather(city: str) -> str:
    """Get current weather for a city."""
    # Your weather API logic here
    return f"The weather in {city} is sunny, 72°F"

@function_tool
def book_appointment(date: str, time: str, service: str) -> str:
    """Book an appointment."""
    # Your booking logic here
    return f"Appointment booked for {service} on {date} at {time}"

agent = RealtimeAgent(
    name="Assistant",
    instructions="You can help with weather and appointments.",
    tools=[get_weather, book_appointment],
)

ハンドオフ

ハンドオフの作成

ハンドオフにより、専門化されたエージェント間で会話を引き継ぐことができます。

from agents.realtime import realtime_handoff

# Specialized agents
billing_agent = RealtimeAgent(
    name="Billing Support",
    instructions="You specialize in billing and payment issues.",
)

technical_agent = RealtimeAgent(
    name="Technical Support",
    instructions="You handle technical troubleshooting.",
)

# Main agent with handoffs
main_agent = RealtimeAgent(
    name="Customer Service",
    instructions="You are the main customer service agent. Hand off to specialists when needed.",
    handoffs=[
        realtime_handoff(billing_agent, tool_description="Transfer to billing support"),
        realtime_handoff(technical_agent, tool_description="Transfer to technical support"),
    ]
)

イベント処理

セッションはイベントをストリーミングし、セッションオブジェクトを反復処理してリッスンできます。イベントには、音声出力チャンク、書き起こし結果、ツール実行の開始・終了、エージェントのハンドオフ、エラーが含まれます。特に処理すべき主要イベントは次のとおりです:

audio: エージェントの応答からの生の音声データ
audio_end: エージェントの発話が完了
audio_interrupted: ユーザーによるエージェントの発話の割り込み
tool_start/tool_end: ツール実行のライフサイクル
handoff: エージェントのハンドオフが発生
error: 処理中にエラーが発生

完全なイベントの詳細は、RealtimeSessionEvent を参照してください。

ガードレール

Realtime エージェントでサポートされるのは出力用ガードレールのみです。これらのガードレールはデバウンスされ、リアルタイム生成中のパフォーマンス問題を避けるため、（単語ごとではなく）定期的に実行されます。デフォルトのデバウンス長は 100 文字ですが、設定可能です。

ガードレールは RealtimeAgent に直接アタッチするか、セッションの run_config を通じて提供できます。両方のソースのガードレールは併用して実行されます。

from agents.guardrail import GuardrailFunctionOutput, OutputGuardrail

def sensitive_data_check(context, agent, output):
    return GuardrailFunctionOutput(
        tripwire_triggered="password" in output,
        output_info=None,
    )

agent = RealtimeAgent(
    name="Assistant",
    instructions="...",
    output_guardrails=[OutputGuardrail(guardrail_function=sensitive_data_check)],
)

ガードレールがトリガーされると、guardrail_tripped イベントが生成され、エージェントの現在の応答を中断できます。デバウンス動作により、安全性とリアルタイム性能要件のバランスを取ります。テキストエージェントと異なり、realtime エージェントはガードレールが作動しても Exception は発生させません。

音声処理

session.send_audio(audio_bytes) を使用してセッションに音声を送信するか、session.send_message() を使用してテキストを送信します。

音声出力については、audio イベントをリッスンし、任意の音声ライブラリで音声データを再生してください。ユーザーがエージェントを割り込んだ場合に即座に再生を停止し、キューにある音声をクリアするため、audio_interrupted イベントも必ずリッスンしてください。

直接モデルアクセス

基盤となるモデルにアクセスして、カスタムリスナーを追加したり高度な操作を実行したりできます:

# Add a custom listener to the model
session.model.add_listener(my_custom_listener)

これにより、接続を低レベルで制御する必要がある高度なユースケース向けに、RealtimeModel インターフェースへ直接アクセスできます。

例

動作する完全な例は、examples/realtime ディレクトリを参照してください。UI コンポーネントの有無それぞれのデモが含まれています。