はじめに
OpenAI APIを使用することで、GPT-4などの強力な言語モデルを自分のアプリケーションに組み込むことができます。最近になってOpenAIの学習を始めたため、自分用の備忘録も兼ねて、APIの設定から基本的な使用方法まで順を追って説明していきます。なお、本記事の内容は2025年2月時点の情報です。APIの仕様は変更される可能性があるため、最新の仕様については本家のドキュメントをご参照ください。
1. APIキーの取得と管理
まず最初のステップは、OpenAIからAPIキーを取得することです。これは以下の手順で行えます：
- OpenAIのウェブサイトにアクセス
- APIキーを生成し、安全な場所に保管
- APIキーは極めて重要な認証情報なので、公開レポジトリ等には保管しない
2. 環境設定
APIキーを利用するため、以下の2つの方法があります：
方法1：環境変数の使用
OSの環境変数としてAPIキーを設定する方法です。MacやWindowsそれぞれの設定方法があります。詳細については、ドキュメントを参照してください。
①Mac
export OPENAI_API_KEY="your_api_key_here"
②Windows
setx OPENAI_API_KEY "your_api_key_here"
方法2：.envファイルの使用
より柔軟で管理しやすい.envファイルを使用する方法です。python-dotenvライブラリを使用することで、簡単に環境変数を管理できます。.envという名前のファイルを作成し、以下の内容を記載します。
OPENAI_API_KEY=your_api_key_here
3. 必要なライブラリのインストール
OpenAI APIを使用するために必要な主なライブラリは以下の通りです：
- openai - OpenAIの公式Python SDK
- python-dotenv - 環境変数管理用
pip install openai python-dotenv
4. 基本的な使用例
OpenAI APIでは、テキスト生成から画像認識まで、様々なタスクを実行できます。APIキーによるOpenAI APIへのアクセスが可能かどうか、以下のような簡単なPythonコードで確認します。応答が返ってきたら成功です。
import os
from dotenv import load_dotenv
from openai import OpenAI
# .envファイルの内容を読み込む
load_dotenv()
# 環境変数からAPIキーを取得
api_key = os.getenv("OPENAI_API_KEY")
# OpenAIクライアントの初期化
client = OpenAI(api_key=api_key)
# OpenAI APIに質問を送信
chat_completion = client.chat.completions.create(
messages=[
{
"role": "user",
"content": "Hi there!", # ユーザーからのメッセージ
}
],
model="gpt-4o-mini", # 使用するモデル名
)
# 応答を取得して表示
response = chat_completion.choices[0].message.content
print(f"ChatGPT: {response}")