MENU

OpenAI APIを初めて動かす手順|環境変数とサンプルコード

当ページのリンクには広告(PR)が含まれていることがあります。
OpenAI APIを初めて動かす手順|環境変数とサンプルコードのアイキャッチ

OpenAI APIを最初に試すときは、短い入力を1件だけ送り、返答を表示するところまでを目標にします。ファイル読込や定期実行を同時に足すと、環境設定と業務処理のどちらで失敗したのか分かりにくくなります。

ここではWindowsのPowerShellとPythonを使う例を示します。コードは公式のAPIクイックスタートにあるResponses APIの呼び方を基にしています。この記事の作成時には、実際のキーを使ったAPI通信や課金を伴う実行は行っていません。

目次

Pythonと実行場所を確認する

作業用フォルダを開き、次のコマンドでPythonが使えることを確認します。コマンドが見つからない場合は、先にPythonの導入を済ませます。

python --version
python -m pip --version
python -m venv .venv
.\.venv\Scripts\python.exe -m pip install openai

仮想環境を作り、そのPythonを直接指定する形です。PowerShellの実行ポリシーを変更したり、activateを実行したりする必要はありません。以降も同じPythonを使えば、別の環境にSDKを入れてしまう行き違いを避けられます。

キーとモデル名を環境変数で渡す

公式SDKはOPENAI_API_KEYという環境変数を読みます。キーの取得・登録は利用組織の承認された方法で行い、コードや共有メモへ値を書かないでください。設定後の確認でも、キーそのものを画面へ表示しません。

モデル名は利用できるモデルを公式資料と自分のプロジェクトで確認して選びます。次はモデル名だけを設定する記入例です。山括弧の部分を、使用するモデルのIDへ置き換えます。

$env:OPENAI_MODEL = "<使用するモデルID>"

PowerShellで設定した環境変数は、そのセッションと、そこから起動する子プロセスに引き継がれます。別のターミナルや既に起動中のエディターへ自動反映されるとは限りません。Microsoftの環境変数の説明も確認してください。

短い要求を1件送るサンプル

次をexample.pyとして保存します。値が未設定なら通信前に止まり、設定値自体は出力しません。

import os
from openai import OpenAI

def required_setting(name):
    value = os.environ.get(name, "").strip()
    if not value:
        raise RuntimeError(f"{name} が未設定です")
    return value

def ask_once(client, model):
    return client.responses.create(
        model=model,
        input="次の語をひらがなにしてください。入力: 確認",
        max_output_tokens=80,
        store=False,
    )

if __name__ == "__main__":
    required_setting("OPENAI_API_KEY")
    model = required_setting("OPENAI_MODEL")
    response = ask_once(OpenAI(), model)
    print(response.output_text)

出力上限を小さくした例ですが、モデルが対応するパラメーターや必要な出力枠は公式資料で確認します。store=Falseもすべてのデータ保持を無効にする指定ではありません。機密情報を含まない短い入力から始めます。

実行するとAPIへ要求が送られ、料金が発生し得ます。利用条件と上限を確認したうえで、次のように実行します。

.\.venv\Scripts\python.exe example.py

「かくにん」のような返答が想定例です。これは実行結果の引用ではなく、入力に対する期待する内容を示しています。

失敗したら確認する場所を絞る

ModuleNotFoundErrorなら実行しているPythonとSDKの導入先、未設定の例外なら環境変数の名前と起動元を調べます。APIからのエラーはHTTPコードとerror.codeを確認し、認証、モデルへのアクセス、課金、利用頻度を切り分けます。キーをログに貼って相談する必要はありません。

最初の成功後は、入力、使用モデル、確認日時、返答の妥当性、使用量を記録します。同じ要求を繰り返しても、毎回同じ文章になる保証はありません。

関連する内容は環境構築から始めるPython入門と長文要約で条件を伝える方法でも扱っています。

この記事を書いた人

Watanabeのアバター Watanabe サイト運営者

2020年よりブログ開始。
SEOが思いのほか性にあっていたようで現在に至る。
モットーは「勝率の高い選択をする」
AIは活用するが吉、最後は人間が息を吹き込む。
アートと科学を追求し、日々精進。
―――
収益:6~7桁をウゴウゴ。
サイト:ペラサイト~中規模サイトまで運営中。
案件:1000円以上の案件をメインに取組中。
打ち手:ブラックSEO~ホワイトSEOまで
―――

目次