クイックスタート
-
プロジェクトの作成
このクイックスタートでは、ブラウザで使える音声エージェントを作成します。新しいプロジェクトを試す場合は、
Next.jsやViteを利用できます。Terminal window npm create vite@latest my-project -- --template vanilla-ts -
Agents SDK をインストール(Zod v4 が必要)
Terminal window npm install @openai/agents zod代わりにスタンドアロンのブラウザ用パッケージである
@openai/agents-realtimeをインストールすることもできます。 -
クライアントの一時トークンを生成
このアプリケーションは ユーザー のブラウザで動作するため、Realtime API を通じてモデルに安全に接続する必要があります。そのために、バックエンド サーバー で生成すべき ephemeral client key を使用できます。テスト目的であれば、
curlと通常の OpenAI API キーを使ってキーを生成することも可能です。Terminal window export OPENAI_API_KEY="sk-proj-...(your own key here)"curl -X POST https://api.openai.com/v1/realtime/client_secrets \-H "Authorization: Bearer $OPENAI_API_KEY" \-H "Content-Type: application/json" \-d '{"session": {"type": "realtime","model": "gpt-realtime"}}'レスポンスにはトップレベルに “value” 文字列が含まれ、“ek_” プレフィックスで始まります。この一時キーを使って後で WebRTC 接続を確立できます。なお、このキーの有効期間は短いため、再生成が必要です。
-
最初のエージェントを作成
新しい
RealtimeAgentの作成は、通常のAgentの作成と非常によく似ています。import { RealtimeAgent } from '@openai/agents/realtime';const agent = new RealtimeAgent({name: 'Assistant',instructions: 'You are a helpful assistant.',}); -
セッションの作成
通常のエージェントと違い、Voice Agent は
RealtimeSession内で継続的に稼働し、時間をかけてモデルとの会話と接続を処理します。このセッションは、音声処理や中断、その他多くのライフサイクル機能も扱います。これらについては後ほど説明します。import { RealtimeSession } from '@openai/agents/realtime';const session = new RealtimeSession(agent, {model: 'gpt-realtime',});RealtimeSessionのコンストラクターは最初の引数としてagentを受け取ります。このエージェントが ユーザー が最初に対話できるエージェントになります。 -
セッションに接続
セッションに接続するには、先ほど生成したクライアントの一時トークンを渡します。
await session.connect({ apiKey: 'ek_...(put your own key here)' });これにより、ブラウザで WebRTC を使って Realtime API に接続し、音声の入出力用にマイクとスピーカーを自動的に構成します。
RealtimeSessionをバックエンド サーバー(たとえば Node.js)で実行している場合、SDK は自動的に接続として WebSocket を使用します。異なるトランスポート層の詳細は、リアルタイムトランスポート ガイドをご覧ください。 -
すべてをまとめる
import { RealtimeAgent, RealtimeSession } from '@openai/agents/realtime';export async function setupCounter(element: HTMLButtonElement) {// ....// for quickly start, you can append the following code to the auto-generated TS codeconst agent = new RealtimeAgent({name: 'Assistant',instructions: 'You are a helpful assistant.',});const session = new RealtimeSession(agent);// Automatically connects your microphone and audio output in the browser via WebRTC.try {await session.connect({// To get this ephemeral key string, you can run the following command or implement the equivalent on the server side:// curl -s -X POST https://api.openai.com/v1/realtime/client_secrets -H "Authorization: Bearer $OPENAI_API_KEY" -H "Content-Type: application/json" -d '{"session": {"type": "realtime", "model": "gpt-realtime"}}' | jq .valueapiKey: 'ek_...(put your own key here)',});console.log('You are connected!');} catch (e) {console.error(e);}} -
エンジンを起動して話してみる
Web サーバー を起動し、新しい Realtime Agent のコードを含むページに移動します。マイクアクセスの許可を求めるリクエストが表示されるはずです。アクセスを許可すると、エージェントに話しかけられるようになります。
Terminal window npm run dev
次のステップ
Section titled “次のステップ”ここからは、独自の音声エージェントの設計と構築を始められます。音声エージェントは通常のエージェントと多くの共通機能を持ちつつ、独自の機能も備えています。
-
音声エージェントに以下を追加する方法を学ぶ
-
さまざまなトランスポート層についてさらに学ぶ