このチュートリアルでは、OpenAI APIの使用準備方法を学ぶことができます。私は、APIキーの作成からOpenAIのNPMパッケージのインストールまで、必要なコンポーネントをすべて設定するプロセスを段階的に説明します。その後、アプリケーションでAPIをどのように使用するかを示します。さあ、始めましょう!
主なポイント
- OpenAI APIにアクセスするにはAPIキーが必要で、OpenAIプラットフォームで生成できます。
- API呼び出しを行うにはopenai-npmパッケージが必要です。
- すべてはNode.jsとJavaScriptで行われ、その構成方法も示します。
ステップバイステップガイド
成功裏にOpenAI APIを使用するために、以下の手順に従ってください:
1. OpenAIプラットフォームにアカウントを作成する
最初にOpenAIプラットフォームにアカウントを作成する必要があります。ブラウザを開き、platform.openai.comに移動します。 "サインアップ"をクリックして登録します。
メールアドレスを入力し、パスワードを選択します。Google、Microsoft、またはAppleアカウントを使用しても登録できます。
2. APIキーを生成する
アカウントを作成した後、設定に移動します。そこで「APIキー」項目を見つけます。ここでAPIキーを生成できます。
新しいAPIキーを作成するボタンをクリックします。名前を付けることができます。作成後、APIキーが表示されます。このキーをコピーして安全に保存します。アプリケーションのソースコード内または別のファイルに保存します。
このキーを失くさないように注意してください。ダイアログボックスを閉じると、キーを表示できなくなり、新しいキーを作成する必要があります。
3. トークンシステムを理解する
APIを使用するには、トークンまたはクレジットが必要です。各API呼び出しには一定数のトークンが消費されます。トークンは実際の単語数よりも多いことが多いため、注意が必要です。
通常、サインアップ時に、API呼び出しに使用できるクレジットが提供されます。常にキーを安全に保管し、いつでもアクセスできるようにしてください。
4. openai-npmパッケージをインストールする
次のステップは、openai-npmパッケージをインストールすることです。ターミナルに移動し、アプリケーションを作成したディレクトリに移動します。
パッケージをインストールするためにnpm install openaiコマンドを実行してください。
インストールが完了したら、package.jsonを確認して、パッケージが正常に追加されたことを確認します。
5. 必要なモジュールをインポートする
パッケージがインストールされたので、JavaScriptコードで必要なモジュールをインポートする必要があります。openaiパッケージからConfigurationとOpenAIモジュールをインポートしてください。
6. OpenAI APIの設定
APIの構成を行います。APIキーを含む新しい構成オブジェクトを作成します。
new Configuration()を呼び出し、APIキーオブジェクトを渡してください。
その後、new OpenAI({configuration})を使用してOpenAI APIを初期化します。
7. APIリクエストを準備する
次に、APIリクエストを準備してAPIコールを行う必要があります。APIリクエストが必要な非同期関数を作成します。
completeChat関数は、引数としてメッセージを受け取ります。OpenAIのcreateChatCompletionメソッドを呼び出し、モデル(たとえばgpt-3.5-turbo)や送信したすべてのメッセージなど、必要なパラメータを渡します。
8. APIのレスポンスを処理する
APIへのアクセスが成功した場合、処理が必要なレスポンスが返されます。レスポンスには、choicesなど、APIの生成された応答を含むデータが含まれています。
応答のコンテンツを保存し、アプリケーションで使用できるように返します。
9. 関数をテストする
関数をテストする時間です。ローカルサーバーを起動し、AIからの応答を確認してください。
Screenshot_567
複数回質問すると異なる回答が得られるはずであり、これはモデルとの通信が機能していることを示します。
要約
このガイドでは、OpenAI APIへのアクセスの準備方法について学びました。APIキーの生成から必要なnpmパッケージのインストール、APIリクエストの作成、応答の処理まで、すべての基本的なステップを経験しました。
よくある質問
APIキーとは何ですか?APIキーはOpenAI APIへのアクセスを提供するユニークなキーです。
サインアップ時にどれくらいのクレジットを受け取れますか?通常、数ドル(たとえば5ドル)分のクレジットが提供され、APIリクエストに使用できます。
APIキーを紛失した場合はどうすればよいですか?OpenAIプラットフォームの設定から新しいAPIキーを生成する必要があります。
トークンとは単語と同じですか?いいえ、トークンは単語の一部となることがあり、そのためテキスト内のトークン数は通常、単語数よりも多くなります。
APIを商業目的で使用できますか?はい、ただし現在のOpenAIの利用条件を確認することが推奨されます。