⛳
ChatGPTのAPIを使ったサンプルコード作成
以下では、Visual Studio Code (VS Code) で Python を使い、OpenAI API を呼び出す最も基本的なプログラムを作る手順をステップバイステップで紹介します。まずは本当に最小限のコードと設定で、APIを動かすという「第1歩」を踏むことが目標です。
1. 事前準備
1-1. Pythonのインストール
- 公式サイトからダウンロード: Python公式サイト
- インストール時に
Add Python to PATH
にチェックを入れてください。
1-2. VS Codeのインストール
- まだインストールしていない場合は Visual Studio Code公式サイト から入手します。
1-3. OpenAIアカウントの作成 & APIキーの取得
- OpenAIのページ にアクセスし、アカウントを作成・ログイン。
- 右上の「View API keys」または「Manage Account」から「API Keys」を選択して新規キーを作成。
例:sk-XXXXXXXXXXXXXX...
セキュリティ上の注意
APIキーは秘密情報なので、GitHubなどのリポジトリに直接記載しないように注意してください。
2. VS Code でのプロジェクト作成
2-1. フォルダを作成
任意の場所(例: デスクトップ)にフォルダを作成します。名前は openai-sample
など、わかりやすい名前にしてください。
2-2. VS Code でフォルダを開く
- VS Code を起動し、「ファイル」→「フォルダを開く」から先ほど作成したフォルダを開きます。
2-3. Python 拡張機能をインストール (必要に応じて)
- VS Code 左の拡張機能タブ(四つの正方形のアイコン)から「Python」と検索し、Microsoft公式のPython拡張機能をインストールします。
3. OpenAIライブラリのインストール
3-1. ターミナルを開く
- VS Code メニュー上部から「ターミナル」→「新しいターミナル」をクリック。
3-2. pip で OpenAI ライブラリをインストール
以下のコマンドをターミナルで実行します。
pip install openai
補足: もしAnacondaやvenv(仮想環境)などを使っている場合、その環境上で同コマンドを実行してください。
4. サンプルコード作成
4-1. Pythonファイルを作成
- フォルダ内に「main.py」というファイルを作成します。
4-2. サンプルコードを書いてみる
import os
import openai
# 【推奨】環境変数 OPENAI_API_KEY にキーが設定されているか確認してください
openai.api_key = os.getenv("OPENAI_API_KEY")
def chat_completion_sample():
# 新しい呼び出し方: openai.chat.completions.create(...)
response = openai.chat.completions.create(
model="gpt-3.5-turbo",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Hello, how are you?"}
],
temperature=0.7 # 必要に応じてパラメータ調整
)
# レスポンスのメッセージを返す
return response.choices[0].message.content
if __name__ == "__main__":
result = chat_completion_sample()
print("ChatGPTからの応答:")
print(result)
ポイント
openai.api_key
は、本番運用などでは環境変数や設定ファイルから読み込むようにし、ソースコード内に直接書かない方が安全です。
5. プログラムの実行
5-1. APIキーの設定
もし【方法2】の環境変数にした場合は、以下のようにターミナルでキーをセットしてください(例はWindowsの場合)。
set OPENAI_API_KEY="sk-xxxxxxxxxx..."
Mac や Linux の場合は:
export OPENAI_API_KEY="sk-xxxxxxxxxx..."
5-2. Pythonスクリプトを実行
python main.py
VS Code のターミナル上でこのコマンドを実行すると、ChatGPT からの応答が表示されれば成功です。
6. うまく動かない場合のチェックポイント
- Pythonバージョン: 3.7以上であることを確認してください。
-
ライブラリのインストール:
pip list
でopenai
が入っているかを確認してください。 -
APIキーが正しいか:
openai.error.AuthenticationError
のようなエラーが出た場合、APIキーが間違っている可能性があります。 - ネットワーク: 社内ネットワークなどで制限がある場合、リクエストが弾かれることがあります。
- 課金/Free Trial: OpenAI の無料枠が終了していたり、請求先情報が設定されていないとエラーになる場合があります。
7. 今後の発展
-
プロンプトの設計
システムの役割(system role)や、ユーザの要求をどのように与えるかによって応答が大きく変わります。より複雑な要求や複数ターンの会話管理を行う場合は、messages配列を工夫してください。 -
チェーンプロンプト
複数ステップで出力をつなぐ場合はLangChainなどのフレームワークを使用すると便利です。 -
APIの別のエンドポイント
Embeddingsを使う、ファインチューニングをするなど、OpenAIには他にも多くの機能があります。目的に応じて公式ドキュメントを参照してください。 -
GitHubへのプッシュ
実装したサンプルをGitHubリポジトリにアップして共有すると、共同開発がしやすくなります。
以上が、VS Code上でPythonを使いOpenAI APIを呼び出す「最初の一歩」としての手順です。まずはこのサンプルを動かしてみて、レスポンスが返ってくることを確認してください。その後、要望に応じてプロンプトを複雑にしたり、処理を追加したりして拡張していくことで、複雑なシステムのベースを構築できます。
Discussion