PythonでOpenAI APIを使いこなす：公式ライブラリ入門ガイド

openai/openai-python

ただ、ソフトウェアエンジニアの視点から、OpenAIの公式Pythonライブラリがどのように役立つか、導入方法やサンプルコードの例を、分かりやすく丁寧に解説します！

OpenAIの公式Pythonライブラリ、openai-pythonは、OpenAIが提供する強力なAPIを、Pythonを使って簡単に操作するためのツールです。

ソフトウェアエンジニアとして、このライブラリを使うことで、以下のようなメリットがあります。

開発効率の向上
APIを直接叩くのではなく、Pythonの使い慣れたオブジェクトやメソッドを通じてAPIにアクセスできます。これにより、APIリクエストの組み立てやレスポンスのパースといった面倒な作業から解放され、アプリケーションのロジック開発に集中できます。

堅牢性の確保
公式ライブラリなので、APIのバージョンアップや変更に迅速に対応してくれます。また、エラーハンドリングや再試行のロジックが組み込まれていることも多く、より堅牢なアプリケーションを構築できます。

豊富な機能
単なるAPIクライアントにとどまらず、ストリーミング処理や非同期処理、便利なヘルパー関数など、開発者が求めるさまざまな機能が提供されています。

これらのメリットを活かすことで、チャットボット、記事の自動生成ツール、要約サービスなど、AIを活用したアプリケーションを迅速かつ効率的に開発できます。

導入はとても簡単です。Pythonのパッケージ管理ツールであるpipを使ってインストールするだけです。

まず、ターミナルやコマンドプロンプトを開き、以下のコマンドを実行します。

pip install openai

これでインストールは完了です。

次に、APIを利用するためのキーを環境変数に設定します。セキュリティの観点から、コードに直接APIキーを書き込むのは避けましょう。

export OPENAI_API_KEY="あなたのAPIキーをここに貼り付けてください"

※Windowsの場合は、set OPENAI_API_KEY="あなたのAPIキーをここに貼り付けてください"となります。

では、実際に簡単なサンプルコードを見ていきましょう。ここでは、チャットモデルに質問を投げかける例を紹介します。

まずは必要なライブラリをインポートします。

from openai import OpenAI

OpenAIクラスをインスタンス化して、APIクライアントを作成します。環境変数にAPIキーを設定していれば、引数なしでOKです。

client = OpenAI()

client.chat.completions.createメソッドを使って、チャットモデルにリクエストを送信します。

completion = client.chat.completions.create(
  model="gpt-4", # 使用するモデルを指定
  messages=[
    {"role": "system", "content": "あなたは親切なアシスタントです。"},
    {"role": "user", "content": "自己紹介をお願いします。"}
  ]
)

messagesリストには、会話の履歴を辞書の形で渡します。roleはsystem、user、assistantなどがあり、それぞれの役割を定義します。

最後に、APIからのレスポンスを取得し、表示します。

print(completion.choices[0].message.content)

このコードを実行すると、AIが生成した自己紹介の文章が出力されます。

「はい、承知いたしました。私は、Googleによってトレーニングされた、大規模言語モデルです。」

いかがでしたか？