はじめに
OpenAIリアルタイムAPI Next.jsは、Next.jsフレームワークをベースとしたオープンソースプロジェクトです。このプロジェクトは、OpenAIのリアルタイムAPIとWebRTC技術を統合し、モダンなUIコンポーネントと機能を呼び出すツールを提供します。このテンプレートを使用することで、開発者は多言語ローカライズによるリアルタイムの音声会話をサポートする音声AIアプリケーションを簡単に作成することができます。このプロジェクトには、コードの品質と保守性を確保するための厳格なTypeScriptの型安全性とeslintルールも含まれています。
機能一覧
- Next.jsフレームワークNext.jsを使ったサーバーサイドレンダリングとAPIルーティング。
- 近代化されたUITailwind CSSとFramer Motion、shadcn/uiコンポーネントを使用したアニメーションデザイン。
- WebRTCのサポートWebRTC の処理を抽象化し、リアルタイムオーディオダイアログの実装を簡単にするフックを提供します。
- ツールコールリアルタイムAPIと連動したクライアントサイドツールの使用方法を示す5つのサンプル関数が含まれています。
- 多言語ローカリゼーション文字列とボイスエージェントが適用される言語(英語、スペイン語、フランス語、中国語)の選択をサポート。
- タイプセーフティTypeScriptを使用し、厳格なeslintルールに従うこと。
ヘルプの使用
設置プロセス
- クローン倉庫
git clone https://github.com/cameronking4/openai-realtime-api-nextjs.git
cd openai-realtime-api-nextjs
- 環境設定 ルート・ディレクトリに
環境
ファイルを作成し、OpenAI API キーを追加します:
OPENAI_API_KEY=your-openai-api-key
- 依存関係のインストール Node.jsを使用している場合:
npmインストール
Denoを使用する場合:
デノインストール
- アプリケーションの実行 Node.jsを使用している場合:
npm run dev
Denoを使用する場合:
denoタスクスタート
アプリケーションはhttp://localhost:3000
.
使用方法
- アプリケーションを開く ブラウザで開く
http://localhost:3000
. - 音声を選択 音声を選択し、オーディオセッションを開始します。
- ツールコール このプロジェクトでは、クライアント側でツールを呼び出す方法を示す5つのサンプル関数を提供している:
現在時刻
現在時刻を取得します。パーティーモード
パーティーモードに切り替える。変更背景
背景を変更します。ローンチウェブサイト
サイトを立ち上げる。コピー・トゥ・クリップボード
クリップボードにコピー
- 多言語サポート アプリケーション文字列と音声エージェントの多言語ローカリゼーションは、異なる言語を選択することで実現できます。
ヴェルセルへの配備
- ワンクリック配備 Vercelプラットフォームを使えば、アプリケーションはワンクリックでデプロイできる。
- 環境変数の設定 Vercelのプロジェクト設定で、OpenAIのAPIキーを追加します。
ライセンス
このプロジェクトはMITライセンスの下でオープンソースである。詳細はLICENSEファイルを参照のこと。
礼状
APIとモデルを提供してくれたOpenAI、Next.jsフレームワーク、スタイリングしてくれたTailwind CSS、インスピレーションを与えてくれたSimon Willisonのブログに感謝する。