Python で ChatGPT を OpenAI API で接続する

🖥実施環境

OpenAI API

API リファレンス

OpenAI API

An API for accessing new AI models developed by OpenAI

https://platform.openai.com/docs/api-reference

Chat API 使用料

https://openai.com/pricing#image-models

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

pip install openai

openai · PyPI

Python client library for the OpenAI API

https://pypi.org/project/openai/

インストール前状況

インストール後状況

いろいろな関連モジュールがインストールされました。（2023/03/18時点）

Package            Version
------------------ ---------
aiohttp            3.8.4    
aiosignal          1.3.1    
async-timeout      4.0.2    
attrs              22.2.0   
certifi            2022.12.7
charset-normalizer 3.1.0    
colorama           0.4.6
frozenlist         1.3.3
idna               3.4
multidict          6.0.4
openai             0.27.2
pip                23.0.1
requests           2.28.2
setuptools         67.6.0
tqdm               4.65.0
urllib3            1.26.15
wheel              0.40.0
yarl               1.8.2

APIキー の取得

OpenAI API 使用するにあたって、認証に必要なAPIキーを取得します。

下記API keysページにて + Create new secret key ボタンを押すとAPIキーが表示されるので、それをコピーしておきます。

※忘れてしまうと再度表示確認する事は出来ません（新しいAPIキーを発行する）※

OpenAI API

An API for accessing new AI models developed by OpenAI

https://platform.openai.com/account/api-keys

APIキーの設定

直接記述するパターンや環境変数に入れるパターン等があるかと思います。

当環境ではFlaskの環境変数 → Configを利用しています。

※直接記述する場合は【OPENAI_API_KEY】部分をご自身のAPIキーに置き換えてください※

config.py
# OpenAI
OPENAI_API_KEY = os.environ.get('OPENAI_API_KEY')

チャット接続

※当環境はFlaskを使用して確認しています※

OpenAI API

An API for accessing new AI models developed by OpenAI

https://platform.openai.com/docs/api-reference/chat

サンプルに記載あるものをまずはそのまま動かしてみます。

import openai

openai.api_key = current_app.config['OPENAI_API_KEY']

    completion = openai.ChatCompletion.create(
        model="gpt-3.5-turbo",
        messages=[
            {"role": "user", "content": "Hello!"}
        ]
    )

    print(completion.choices[0].message)

-- 結果 --
{
  "content": "\n\nHi there! How may I assist you today?",
  "role": "assistant"
}

返答があったので、接続は無事成功です。
では中身を細かく見ていきます。

使用メソッド：openai.ChatCompletion.create

model

モデルエンドポイントの互換性表

messages

メッセージ オブジェクトの配列である必要がある。

オブジェクトにはrole( system user assistant ) と content (メッセージのコンテンツ) がある。

roleとcontentを設定すれば良いようだ

messages=[
    {"role": "system or user or assistant", "content": "内容"}
]

roleの各違いは何か？

completion = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "ピノキオとは？"}
    ]
)
print(completion.choices[0].message['content'])

-- 結果 --
ピノキオは、イタリアの作家カルロ・コッローディによって書かれた児童文学作品『ピノッキオの冒険』に登場する架空の人物です。
物語の主人公であるピノキオは、木から作られた人形で、口を開けばうそをついてしまうという癖があります。
ストーリーでは、ピノキオが様々な冒険を経験し、うそをつくことの悪影響を理解して、最終的に本物の人間になるために頑張る姿が描かれています。
ピノキオは現代でも、子どもたちに人間の良心や品格を教えるための有名なキャラクターの一つとして親しまれています。

completion = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "user", "content": "ピノキオとは？"}
    ]
)
print(completion.choices[0].message['content'])

-- 結果 --
ピノキオは、イタリアの作家、カルロ・コッローディによって創作された童話の主人公で、木製の人形が本体である。
物語では、尻尾が伸びる嘘をつく癖があるために、鼻が長く伸びてしまう。ピノキオは、彼の聡明さ、勇気、そして善良さを証明するために、多くの試練を克服しながら成長する。
ピノキオという名前は、イタリア語で「松の木」という意味がある。

completion = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "assistant", "content": "ピノキオとは？"}
    ]
)
print(completion.choices[0].message['content'])

-- 結果 --
ピノキオとは、イタリアの作家カルロ・コッローディによって書かれた児童小説『ピノッキオの冒険』の主人公である人形の名前です。
物語は、悪戯好きのピノキオが魔法使いによって人間になるための冒険をする姿を描いています。
ピノキオは、ウソをつくと鼻が伸びる、火にかけられると足が燃える、猫やイタチに騙されるなど、様々なトラブルに巻き込まれますが、最後には誠実さと勇気を学び、人間になることができます。

結果はそれぞれ微妙に回答が違いました。

completion = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."}, # 助っ人として活躍していますね。
        {"role": "user", "content": "Who won the world series in 2020?"}, # 2020年のワールドシリーズを制したのは？
        {"role": "assistant", "content": "The Los Angeles Dodgers won the World Series in 2020."}, # 2020年、ロサンゼルス・ドジャースがワールドシリーズを制覇した。
        {"role": "user", "content": "Where was it played?"} # どこで行われたのですか？
    ]
)

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

-- 結果 --
The 2020 World Series was played at a neutral location, Globe Life Field in Arlington, Texas.
# 2020年のワールドシリーズは、中立地であるテキサス州アーリントンのグローブライフ・フィールドで行われました。

現時点での見解

日本語で送信した時は「completion.choices[0].message」で取得するとユニコードとなる

下記サンプルのようにユニコードで返却されます。

上記テストのように completion.choices[0].message['content'] で直接表示すると日本語で表示する事が可能です。

completion = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "ピノキオとは？"}
    ]
)
print(completion.choices[0].message)

-- 結果 --
{
  "content": "\n\n\u30d4\u30ce\u30ad\u30aa\uff08Pinocchio\uff09\u306f\u3001\u30a4\u30bf\u30ea\u30a2\u306e\u4f5c\u5bb6\u30ab\u30eb\u30ed\u30fb\u30b3\u30c3\u30ed\u30fc\u30c7\u30a3\u304c1883\u5e74\u306b\u767a\u8868\u3057\u305f\u5150\u7ae5\u5c0f\u8aac\u3067\u3042\u308b\u3002\u4e3b\u4eba\u516c\u306e\u30d4\u30ce\u30ad\u30aa\u306f\u3001\u6728\u304b\u3089\u4f5c\u3089\u308c\u305f\u4eba\u5f62\u3067\u3001\u9f3b\u304c\u5618\u3092\u3064\u304f\u5ea6\u306b\u9577\u304f\u4f38\u3073\u308b\u3068\u3044\u3046\u7279\u5fb4\u304c\u3042\u308b\u3002\u30d4\u30ce\u30ad\u30aa\u306f\u3001\u4eba\u9593\u306b\u306a\u308b\u305f\u3081\u306b\u5192\u967a\u3092\u7e70\u308a\u8fd4\u3057\u3001\u3055\u307e\u3056\u307e\u306a\u8a66\u7df4\u3092\u4e57\u308a\u8d8a\u3048\u306a\u304c\u3089\u6210\u9577\u3057\u3066\u3044\u304f\u7269\u8a9e\u3067\u3042\u308b\u3002\u3053\u306e\u7269\u8a9e\u306f\u4e16\u754c\u4e2d\u3067\u611b\u3055\u308c\u3001\u30a2\u30cb\u30e1\u3084\u6620\u753b\u5316\u3055\u308c\u305f\u308a\u3001\u5e7e\u5ea6\u3082\u821e\u53f0\u5316\u3055\u308c\u305f\u308a\u3057\u3066\u3044\u308b\u3002",
  "role": "assistant"
}