OpenAI platform 1.x : Get Started : クイックスタート (Python) (翻訳/解説)

翻訳 : クラスキャット セールスインフォメーション
作成日時 : 11/14/2023 (v1.2.3)

* 本ページは、以下のドキュメントを翻訳した上で適宜、補足説明したものです：

• Get Started : Quickstart

* サンプルコードの動作確認はしておりますが、必要な場合には適宜、追加改変しています。
* ご自由にリンクを張って頂いてかまいませんが、sales-info@classcat.com までご一報いただけると嬉しいです。

 

 

OpenAI platform 1,x : Get Started : クイックスタート (Python)

OpenAI API は、開発者が OpenAI の最先端モデルで強化された、アプリケーションで知能 (intelligence) の層を作成するための単純なインターフェイスを提供します。Chat Completions は ChatGPT を強化し、入力としてテキストを受け取り、GPT-4 のようなモデルを使用して出力を生成する簡単な方法を提供します。

このクイックスタートはローカル開発環境のセットアップをして最初の API リクエストを送信するのに役立つように設計されています。貴方が経験豊かな開発者である場合や OpenAI API をすぐに使用したい場合は、GPT ガイド の API リファレンス が良い開始点です。このクイックスタートを通じて、以下を学習します :

• 開発環境をセットアップする方法
• 最新の SDK をインストールする方法
• OpenAI API の基本的なコンセプトの幾つか
• 最初の API リクエストを送信する方法

始めるにあたり課題や困難に出会ったり、質問があれば、開発者フォーラム に参加してください。

 

アカウントのセットアップ

最初に、OpenAI アカウント を作成するか サインイン します。次に、API キーページ に移動して “Create new secret key” を実行します、オプションでキーに名前をつけます。これをどこか安全な場所に保存し、それを誰とも共有しないようにしてください。

 

Step 1: Python のセットアップ

OpenAI Python ライブラリのインストール

Python 3.7.1 またはそれ以降をインストールして (オプションで) 仮想環境をセットアップしたら、OpenAI Python ライブラリをインストールできます。端末 / コマンドラインから、以下を実行します :

pip install --upgrade openai

これが完了すると、”pip list” の実行は現在の環境にインストールした Python ライブラリを表示し、これは OpenAI Python ライブラリが正常にインストールされたことを検証するはずです。

 

Step 2: API キーのセットアップ

単一プロジェクトのための API キーのセットアップ

API キーを単一プロジェクトだけにアクセス可能にしたい場合は、API キーを含むローカル .env ファイルを作成してから以下のステップで示されるようにその API キーを Python コードで明示的に使用することができます。

まず .env ファイルを作成したいプロジェクトフォルダに進みます。

In order for your .env file to be ignored by version control, create a .gitignore file in the root of your project directory. Add a line with .env on it which will make sure your API key or other secrets are not accidentally shared via version control.

端末や統合開発環境 (IDE) を使用して .gitignore と .env ファイルを作成したら、秘密 API キーをコピーしてそれを .env ファイルで OPENAI_API_KEY として設定します。まだ秘密キーを作成していない場合は、API キーページ でそれを行なうことができます。

.env ファイルは以下のようなものです :

# Once you add your API key below, make sure to not share it with anyone! The API key should remain private.
OPENAI_API_KEY=abc123

API キーは以下のコードを実行してインポートできます :

from openai import OpenAI

client = OpenAI()
# defaults to getting the key using os.environ.get("OPENAI_API_KEY")
# if you saved the key under a different environment variable name, you can do something like:
# client = OpenAI(
#   api_key=os.environ.get("CUSTOM_ENV_NAME"),
# )

 

Step 3: 最初の API リクエストの送信

API リクエストを行なう

Python を構成して API キーをセットアップしたら、最後のステップは Python ライブラリを使用して OpenAI API にリクエストを送信することです。これを行なうため、端末か IDE を使用して openai-test.py という名前のファイルを作成します。

ファイル内に、以下のサンプルの一つをコピー&ペーストしてください :

ChatCompletions

from openai import OpenAI
client = OpenAI()

completion = client.chat.completions.create(
  model="gpt-3.5-turbo",
  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)

Embeddings

from openai import OpenAI
client = OpenAI()

response = client.embeddings.create(
  model="text-embedding-ada-002",
  input="The food was delicious and the waiter..."
)

print(response)

Images

from openai import OpenAI
client = OpenAI()

response = client.images.generate(
  prompt="A cute baby sea otter",
  n=2,
  size="1024x1024"
)

print(response)

コードを実行するには、端末 / コマンドラインに “python openai-test.py” を入力します。Chat Completions サンプルはモデルの強みの一つの領域: 創造力だけを強調しています。上手く整形された詩で再帰 (プログラミングのトピック) を説明することは、ベストな開発者と詩人の両者が苦労するものです。この場合、gpt-3.5-turbo がそれを苦もなく行います。

以上