クイックスタート

プロジェクトの作成

このクイックスタートでは、ブラウザで使える音声エージェントを作成します。新しいプロジェクトを試したい場合は、Next.js や Vite を試せます。
Terminal window
```
npm create vite@latest my-project -- --template vanilla-ts
```
Agents SDK のインストール
Terminal window
```
npm install @openai/agents zod@3
```
代わりに、スタンドアロンのブラウザ用パッケージである @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 接続を確立できます。このキーは短時間しか有効でないため、再生成が必要になります。

最初の Agent を作成

新しい 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 code

  const 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 .value
      apiKey: 'ek_...(put your own key here)',
    });
    console.log('You are connected!');
  } catch (e) {
    console.error(e);
  }
}

エンジンを起動して話し始める

Web サーバーを起動し、新しい Realtime Agent のコードを含むページに移動します。マイクへのアクセス許可を求めるリクエストが表示されるはずです。許可すると、エージェントと話し始めることができます。
Terminal window
```
npm run dev
```

次のステップ

ここからは、独自の音声エージェントの設計と構築を開始できます。音声エージェントには通常のエージェントと共通する機能が多くありますが、独自の機能もあります。

音声エージェントに以下を追加する方法を学ぶ
さまざまなトランスポート層についてさらに学ぶ