OpenAI の API の使い方
主に、テキスト生成に関する情報は、随時追加する予定です。また、エラーが出た場合の事例やその対処も随時追加する予定です。
理解できていない部分もあります。そのため、今後記事を修正する可能性があります。ご了承ください。
はじめに
はじめまして。現在、私は大学院生（修士課程）です。
この記事では、OpenAI の API の取得の流れと Python を使って、実装をしようと思います。
この記事が、「OpenAI の API を使った開発の手掛かりになった」などの貢献ができるように書かせていただきます。
アカウントの作成
OpenAI の API キーを作成するためには、OpenAI のアカウントを作る必要があります。以下のリンクから、アカウントを作ることができます。
API の取得
API Key のページにある「Create new secret key」をクリックすることで、取得することができます。
環境構築
Python バージョン
- Python >= 3.0.0
ライブラリ
openai
API の設定
以下の方法のいずれかを使って、API キーを設定してください。すべてのプロジェクトで API キーを適応したい場合は、MacOS あるいは Window を参照してください。一つのプロジェクトのみに適応したい場合は、Python を参照ください。
MacOS
- ターミナルを開きます
- Bash Profile を編集します
-
nano ~/.bash_profileあるいはnano ~/.zshrc
-
- 環境変数を追加します
-
export OPENAI_API_KEY='your-api-key-here'を Bash Profile に書きます（your-api-key-hereは自分が取得した API キーに変更します）
-
- Ctrl+O を押して変更を書き込み、Ctrl+X でエディタを閉じる
- 更新された Profile をロードします
-
source ~/.bash_profileあるいはsource ~/.zshrc
-
- ターミナルで
echo $OPENAI_API_KEYを実行すれば、API キーが確認できます
Windows
- コマンドプロンプトを開きます
- 現在のセッションの環境変数を追加します
-
setx OPENAI_API_KEY "your-api-key-here"（your-api-key-hereは自分が取得した API キーに変更します）
-
- コマンドプロンプトで
echo %OPENAI_API_KEY%を実行すれば、API キーが確認できます
Python
your-api-key-here は自分が取得した API キーに変更してください。
from openai import OpenAI
client = OpenAI(api_key="your-api-key-here")
Python を使って、リクエストする
from openai import OpenAI
client = OpenAI()
completion = client.chat.completions.create(
model="gpt-4o-mini",
messages=[
{"role": "system", "content": "You are a poetic assistant, skilled in explaining complex programming concepts with creative flair."},
{"role": "user", "content": "Compose a poem that explains the concept of recursion in programming."}
]
)
print(completion.choices[0].message)
model="gpt-4o" とすることで、GPT-4o が使えます。他にも、使うことができるモデルはありますが、基本的には、GPT-4o か GPT-4o mini を使えば良さそうです。
エラー
RateLimitError
上記に示したようなコードを実行した際に、人によってはこのようなエラーが出ます。
RateLimitError: Error code: 429 - {'error': {'message': 'You exceeded your current quota, please check your plan and billing details. For more information on this error, read the docs: https://platform.openai.com/docs/guides/error-codes/api-errors.', 'type': 'insufficient_quota', 'param': None, 'code': 'insufficient_quota'}}
原因は、クレジットの残高が足りないため、エラーが出ます。クレジットの残高を追加する場合は、「Setting」から「Billing」に移動してください。「Add to credit balance」という欄をクリックすることで、クレジットの残高を追加できます。
おわりに
この記事では、OpenAI の API の取得の流れと Python を使って、実装をしました。
この記事が、エンジニアとして活躍する皆様に貢献できたら幸いです。
参考記事