クイックスタート

プロジェクトの作成

このクイックスタートでは、ブラウザで使える音声エージェントを作成します。新しいプロジェクトを試す場合は、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 接続を確立できます。このキーは短時間しか有効ではないため、再生成が必要になります

最初のエージェントの作成

新しい RealtimeAgent の作成は、通常の エージェント の作成にとてもよく似ています

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 エージェントのコードを含むページにアクセスします。マイクへのアクセス許可を求めるリクエストが表示されるはずです。許可すると、エージェントと会話を開始できます
Terminal window
```
npm run dev
```

次のステップ

ここからは、独自の音声エージェントの設計と構築を始められます。音声エージェントには通常のエージェントと同じ機能が多く含まれますが、独自の機能もいくつかあります。

音声エージェントに次を持たせる方法
さまざまなトランスポート層の詳細