🦔

ChatGPTを使ってChatアプリを作る

kat

2023/09/13に公開

はじめに

ChatGPTのAPI※1を使った簡単なサンプルを作ってみたくなったのでやってみました。
※1 ・・・正確にはOpenAI社のChat completions APIと言います。

方針

基本的にChatGPTの出したコードで実行します。
書き直しはChatGPTに依頼します。

ChatGPTとのやりとりは最後に載せておきます。

環境

コーディング環境：ChatGPT　４
実行環境：VS Code

※無料版のChatGPT3.5だと厳しいです。動かないコードを出してくる事や、意図したコードを提示してくれなかったり、修正のためのやりとりが数倍発生します。

完成版

アプリケーションの動作イメージ

完成版のコードを載せておきます。

openai_chat_app.py

import tkinter as tk
from tkinter import scrolledtext, ttk
import os
import openai

# 環境変数からAPIキーを取得
api_key = os.environ.get('OPENAI_API_KEY')

# APIキーが設定されているか確認
if not api_key:
    raise ValueError("OPENAI_API_KEY environment variable not set")

openai.api_key = api_key

messages = [
    {"role": "system", "content": "You are a helpful assistant."}
]


def send_message():
    user_message = user_input.get()
    chat_area.insert(tk.END, f"You: {user_message}\n")
    user_input.delete(0, tk.END)

    messages.append({"role": "user", "content": user_message})

    selected_model = model_combobox.get()
    max_tokens_val = int(max_tokens_input.get())

    # OpenAI APIを呼び出して回答を取得
    response = openai.ChatCompletion.create(
        model=selected_model,
        messages=messages,
        max_tokens=max_tokens_val
    )

    ai_message = response['choices'][0]['message']['content']
    chat_area.insert(tk.END, f"AI: {ai_message}\n")
    messages.append({"role": "assistant", "content": ai_message})


# GUIの設定
root = tk.Tk()
root.title("OpenAI Chat")
root.geometry("500x600")

chat_area = scrolledtext.ScrolledText(root, wrap=tk.WORD)
chat_area.pack(pady=15)

model_label = tk.Label(root, text="Select Model:")
model_label.pack(pady=5)
available_models = ["gpt-4", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0613",
                    "gpt-3.5-turbo", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-16k-0613"]
model_combobox = ttk.Combobox(root, values=available_models, state="readonly")
model_combobox.set("gpt-3.5-turbo")
model_combobox.pack(pady=5)

max_tokens_label = tk.Label(root, text="Max Tokens:")
max_tokens_label.pack(pady=5)
max_tokens_var = tk.StringVar()
max_tokens_var.set("1000")
max_tokens_input = tk.Spinbox(
    root, from_=1, to=1500, width=7, textvariable=max_tokens_var)
max_tokens_input.pack(pady=5)

user_input = tk.Entry(root, width=50)
user_input.pack(pady=10)

send_button = tk.Button(root, text="Send", command=send_message)
send_button.pack(pady=20)

root.mainloop()

セットアップ・実行

# gitクローン
git clone https://github.com/KaT0819/openai-chat-sample.git

# venv環境設定
cd openai-chat-sample
python -m venv openai_chat_env

source openai_chat_env/bin/activate

# 環境変数にOpenAIのAPIキーを設定
export OPENAI_API_KEY=your_api_key

# 必要なパッケージをインストール
pip install -r requirement.txt

# 実行
python openai_chat_app.py

上記でほぼ全量ですが、セットアップ手順含めたソースのリポジトリです。

ChatGPTとのやりとり

上記のコードになるまでのChatGPTとのやりとりを示します。
途中、解説的なものは下記の注釈で示します。

[私] 導入

open aiのAPIを用いたチャットツールをデスクトップアプリケーションで作りたいのでコードを書いて

[GPT]

OpenAIのAPIを使用して、デスクトップアプリケーションのチャットツールを作成するためのシンプルなコード例を提供します。ここではPythonを使用し、TkinterをGUIライブラリとして使用します。

まず、必要なライブラリをインストールします：

pip install openai tkinter

次に、以下のPythonコードを使用してデスクトップアプリケーションを作成します：

import tkinter as tk
from tkinter import scrolledtext
import openai

# OpenAIのAPIキーを設定
openai.api_key = 'YOUR_OPENAI_API_KEY'

def send_message():
    user_message = user_input.get()
    chat_area.insert(tk.END, f"You: {user_message}\n")
    user_input.delete(0, tk.END)

    # OpenAI APIを呼び出して回答を取得
    response = openai.Completion.create(
        engine="davinci",
        prompt=f"{user_message}\nAI:",
        max_tokens=150
    )

    ai_message = response.choices[0].text.strip()
    chat_area.insert(tk.END, f"AI: {ai_message}\n")

# GUIの設定
root = tk.Tk()
root.title("OpenAI Chat")
root.geometry("400x500")

chat_area = scrolledtext.ScrolledText(root, wrap=tk.WORD)
chat_area.pack(pady=15)

user_input = tk.Entry(root, width=50)
user_input.pack(pady=20)

send_button = tk.Button(root, text="Send", command=send_message)
send_button.pack(pady=20)

root.mainloop()

このコードを保存して実行すると、Tkinterのウィンドウが表示され、ユーザーはメッセージを入力してOpenAIのAPIに問い合わせることができます。

注意点:

この例は基本的なものであり、エラーハンドリングなどの多くの側面がカバーされていません。
実際に本番環境で使用する場合、APIキーをコード内にハードコードしないようにしてください。安全な方法でキーを管理する必要があります。
また、APIコールのコストに注意してください。大量のメッセージや高頻度での使用はコストがかかります。

このコードをベースに、さらなる機能やカスタマイズを追加することができます。

[私] 仮想環境化の依頼

先にvenvで仮想環境を定義したいです。

[GPT]

了解しました。Pythonのvenvを使用して仮想環境を設定し、その上で先程のデスクトップアプリケーションを作成する手順を示します。

まず、仮想環境を作成します。

python -m venv openai_chat_env

作成した仮想環境をアクティベートします。

Linux/macOSの場合：

source openai_chat_env/bin/activate

Windowsの場合：

openai_chat_env\Scripts\activate

アクティベートされた仮想環境上で必要なライブラリをインストールします。

pip install openai tkinter

以前提供したPythonコードを保存します。例として、openai_chat_app.pyという名前で保存しましょう。
保存したコードを実行します。

python openai_chat_app.py

これで、venvでの仮想環境上でOpenAI APIを使用したデスクトップアプリケーションが動作します。

作業が終了したら、仮想環境をデアクティベートするには以下のコマンドを実行します。

deactivate

注意: 仮想環境を使うことで、グローバルなPython環境を汚染せずに必要なライブラリや依存関係をインストールすることができます。

[私] エラーの解決を依頼

tkinterのインストールで
以下のエラーが出ました。原因と対策を書いて

pip install openai tkinter
Collecting openai
  Downloading openai-0.28.0-py3-none-any.whl (76 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 76.5/76.5 kB 2.7 MB/s eta 0:00:00
ERROR: Could not find a version that satisfies the requirement tkinter (from versions: none)
ERROR: No matching distribution found for tkinter

[notice] A new release of pip is available: 23.1.2 -> 23.2.1
[notice] To update, run: pip install --upgrade pip

[GPT]

tkinterはPythonの標準ライブラリの一部であり、通常はPythonとともに自動的にインストールされます。そのため、pipを使用して外部からインストールすることはできません。上記のエラーメッセージは、pipがtkinterを公式のPython Package Index (PyPI) で見つけられなかったことを示しています。

対策：

まず、tkinterが既にインストールされているかどうかを確認します。Pythonインタープリタで以下のコードを実行してみてください。

import tkinter
print(tkinter.TkVersion)

エラーが発生しなければ、tkinterは正しくインストールされています。

もし1のステップでエラーが発生する場合、Pythonを再インストールすることを考慮してください。再インストール時にtkinterが含まれるようにするために、正しいインストールオプションを選択する必要があります。これは、使用しているOSやPythonのディストリビューションによって異なる場合があります。
仮想環境に問題がある場合、新しい仮想環境を作成して再試行することも考慮してください。

また、pipのアップデートに関する通知が表示されていますので、以下のコマンドを実行してpipをアップデートすることをおすすめします。

pip install --upgrade pip

しかし、tkinterの問題とは無関係ですので、まずtkinterの問題を解決してからpipのアップデートを行っても構いません。

[私] 秘密情報の秘匿化を依頼

openai.api_keyは環境変数から受け取るように書き換えて

[GPT]

もちろん、Pythonで環境変数を読み取るには、osモジュールを使用します。以下はopenai.api_keyを環境変数から受け取る方法です。

最初に、osモジュールをインポートします。
os.environを使用して環境変数を読み取ります。ここでは、環境変数の名前としてOPENAI_API_KEYを使用しますが、お好みに合わせて名前を変更することができます。

以下は具体的なコードです：

import os
import openai

# 環境変数からAPIキーを取得
api_key = os.environ.get('OPENAI_API_KEY')

# APIキーが設定されているか確認
if not api_key:
    raise ValueError("OPENAI_API_KEY environment variable not set")

openai.api_key = api_key

# 以降、OpenAIのAPIを使用するコード

このコードを使用する前に、環境変数OPENAI_API_KEYを設定しておく必要があります。

コマンドラインから環境変数を設定する場合の例：

export OPENAI_API_KEY=your_openai_api_key_here

上記のコードはUNIX系のシステム（LinuxやMac）での例です。Windowsの場合は、環境変数の設定方法が異なる場合があります。

この段階でアプリを実行できるようになりました。
export OPENAI_API_KEY=your_openai_api_key_here
でOpenAIのAPIキーを設定し、python openai_chat_app.pyで実行できます。

おおお？？？
Youが私で、AIがAPIが返した回答です。
英語なのは一旦置いといて、とんでもない回答が来てますね。
最後の東大生とか全く関係ないですし。

ちなみに、max_tokensの値を増やすと返信の文字数が増えます。
返信の文字数を増やして、このモデルで色々質問してみたところ、かなり意味不明な文が返され、若干恐怖を感じました。
これはこれで面白いですが。

API呼び出し部分を見るとモデルが古いもののようなので、もっと賢いモデルに変えてもらいます。

    # OpenAI APIを呼び出して回答を取得
    response = openai.Completion.create(
        engine="davinci",   ←　この部分
        prompt=f"{user_message}\nAI:",
        max_tokens=150
    )

[私] 賢いモデルに変更を依頼

もっと賢いモデルに書き換えて

[GPT]

あなたのコードをもっと高性能なモデル、例えば "gpt-3.5-turbo" でアップグレードすることは賢い選択です。また、新しいChat APIエンドポイントを使用して、継続的な会話をより効果的に行うことができます。以下のように変更してください：

import tkinter as tk
from tkinter import scrolledtext
import os
import openai

# 環境変数からAPIキーを取得
api_key = os.environ.get('OPENAI_API_KEY')

# APIキーが設定されているか確認
if not api_key:
    raise ValueError("OPENAI_API_KEY environment variable not set")

openai.api_key = api_key

messages = [
    {"role": "system", "content": "You are a helpful assistant."}
]

def send_message():
    user_message = user_input.get()
    chat_area.insert(tk.END, f"You: {user_message}\n")
    user_input.delete(0, tk.END)

    messages.append({"role": "user", "content": user_message})

    # OpenAI APIを呼び出して回答を取得
    response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo",
        messages=messages
    )

    ai_message = response['choices'][0]['message']['content']
    chat_area.insert(tk.END, f"AI: {ai_message}\n")
    messages.append({"role": "assistant", "content": ai_message})


# GUIの設定
root = tk.Tk()
root.title("OpenAI Chat")
root.geometry("400x500")

chat_area = scrolledtext.ScrolledText(root, wrap=tk.WORD)
chat_area.pack(pady=15)

user_input = tk.Entry(root, width=50)
user_input.pack(pady=20)

send_button = tk.Button(root, text="Send", command=send_message)
send_button.pack(pady=20)

root.mainloop()

この変更で行ったこと：

グローバル変数messagesを作成して、会話のコンテキストを格納し、これをAPIリクエスト時に利用しています。
openai.Completion.createメソッドをopenai.ChatCompletion.createに変更し、モデルを "gpt-3.5-turbo" に設定しています。
ユーザーとアシスタントのメッセージを適切にmessagesリストに追加しています。
APIからの応答を処理する方法を変更しています。

これで、アプリケーションは前回のメッセージを記憶し、前のコンテキストを利用してより自然な会話を行うことが可能になります。

素晴らしいですね。修正版のコードだけでなく、修正した内容を解説してくれています。
雑な質問でも、文脈を理解しているので、適切な回答が得られるのがGPT3.5と４の大きな違いだと感じます。

についてはAPIドキュメントを確認したところ、openai.Completion.createはレガシーとなっており、今後はopenai.ChatCompletion.createを用いるのが良いようです。

変更前に使用していたAPI
https://platform.openai.com/docs/api-reference/completions
変更後のAPI
https://platform.openai.com/docs/api-reference/chat

また、messagesとして、会話の内容を配列で持つように変わりました。
これにより、APIとのやりとりにおいて、これまでの会話内容が含まれるmessagesをAPIに渡すことで、会話が継続的に行われるようになり、前の質問や回答を踏まえた回答をしてくれるようになります。

次は、GPT4を使うように書き換えてもらいます。

[私] 最新情報の取得について

gpt4を使う形に書き換えて

[GPT]

2023年8月の時点での情報に基づくと、GPT-4の詳細や実装に関する公式情報はOpenAIから公開されていません。したがって、具体的なAPIのエンドポイントやモデル名などの情報は提供できません。しかし、もしGPT-4が公開され、それに関するAPIエンドポイントやモデル名が提供されている場合、以下のようにコードを変更することで利用することができるでしょう。

import tkinter as tk
from tkinter import scrolledtext
import os
import openai

# 環境変数からAPIキーを取得
api_key = os.environ.get('OPENAI_API_KEY')

# APIキーが設定されているか確認
if not api_key:
    raise ValueError("OPENAI_API_KEY environment variable not set")

openai.api_key = api_key

messages = [
    {"role": "system", "content": "You are a helpful assistant."}
]

def send_message():
    user_message = user_input.get()
    chat_area.insert(tk.END, f"You: {user_message}\n")
    user_input.delete(0, tk.END)

    messages.append({"role": "user", "content": user_message})

    # OpenAI APIを呼び出して回答を取得
    response = openai.ChatCompletion.create(
        model="gpt-4.0-turbo",  # GPT-4の適切なモデル名に変更する
        messages=messages
    )

    ai_message = response['choices'][0]['message']['content']
    chat_area.insert(tk.END, f"AI: {ai_message}\n")
    messages.append({"role": "assistant", "content": ai_message})


# GUIの設定
root = tk.Tk()
root.title("OpenAI Chat with GPT-4")
root.geometry("400x500")

chat_area = scrolledtext.ScrolledText(root, wrap=tk.WORD)
chat_area.pack(pady=15)

user_input = tk.Entry(root, width=50)
user_input.pack(pady=20)

send_button = tk.Button(root, text="Send", command=send_message)
send_button.pack(pady=20)

root.mainloop()

変更点:

modelの値を "gpt-4.0-turbo"（想定されるGPT-4のモデル名）に変更しました。
ウィンドウのタイトルを "OpenAI Chat with GPT-4" に変更しました。

これは仮のコードであり、実際のGPT-4のAPI仕様に基づいて適切な変更を行う必要があります。公式のドキュメントやリリースノートを確認して、正確な情報を元にコードを変更してください。

ChatGPTのモデルは、2021年9月時点の情報を学習データに使用しているため、GPT4の情報はやはり持っていないようですね。
2023年8月の時点での情報と言っていますが、この辺はハルシネーションぽいですね。
ちなみに、gpt-3.5-turboが公開されたのは今年だと思いますが、これはどうやって知ったんですかねぇ。。。

アカウントを持っていないとみれませんが、下記のページなど見るとGPT4系として、
gpt-4,gpt-4-0314,gpt-4-0613の3つが使えるようです。
https://platform.openai.com/account/rate-limits

なので、modelにgpt-4を設定することで、GPT4系を利用することが可能です。

実際に利用した履歴を見てみると、gpt-4を指定しているのですが、gpt-4-0613が使われているようです。

最後にモデルや他のパラメータについても選択できるように書き換えてもらいます。

[私] アプリの機能拡張を依頼

他のモデルを選択したり、APIの他のパラメータを画面から指定できるように書き換えて

[GPT]

了解しました。以下のコードでは、モデルの選択およびAPIの他のパラメータ（例えば、max_tokens）を指定できるように画面を拡張しています。

import tkinter as tk
from tkinter import scrolledtext, ttk
import os
import openai

# 環境変数からAPIキーを取得
api_key = os.environ.get('OPENAI_API_KEY')

# APIキーが設定されているか確認
if not api_key:
    raise ValueError("OPENAI_API_KEY environment variable not set")

openai.api_key = api_key

messages = [
    {"role": "system", "content": "You are a helpful assistant."}
]

def send_message():
    user_message = user_input.get()
    chat_area.insert(tk.END, f"You: {user_message}\n")
    user_input.delete(0, tk.END)

    messages.append({"role": "user", "content": user_message})

    selected_model = model_combobox.get()
    max_tokens_val = int(max_tokens_input.get())

    # OpenAI APIを呼び出して回答を取得
    response = openai.ChatCompletion.create(
        model=selected_model,
        messages=messages,
        max_tokens=max_tokens_val
    )

    ai_message = response['choices'][0]['message']['content']
    chat_area.insert(tk.END, f"AI: {ai_message}\n")
    messages.append({"role": "assistant", "content": ai_message})

# GUIの設定
root = tk.Tk()
root.title("OpenAI Chat")
root.geometry("500x600")

chat_area = scrolledtext.ScrolledText(root, wrap=tk.WORD)
chat_area.pack(pady=15)

model_label = tk.Label(root, text="Select Model:")
model_label.pack(pady=5)
available_models = ["gpt-3.5-turbo", "davinci", "curie", "babbage", "ada"]
model_combobox = ttk.Combobox(root, values=available_models, state="readonly")
model_combobox.set("gpt-3.5-turbo")
model_combobox.pack(pady=5)

max_tokens_label = tk.Label(root, text="Max Tokens:")
max_tokens_label.pack(pady=5)
max_tokens_input = tk.Spinbox(root, from_=1, to=1500, width=7)
max_tokens_input.pack(pady=5)

user_input = tk.Entry(root, width=50)
user_input.pack(pady=10)

send_button = tk.Button(root, text="Send", command=send_message)
send_button.pack(pady=20)

root.mainloop()

このコードでは、ttk.Comboboxを使用して利用可能なモデルを選択するUIを提供します。さらに、max_tokensを指定するためのtk.Spinboxも追加されています。ユーザーはこれらのオプションを使ってAPIの呼び出しをカスタマイズできます。

モデルの変更と返却するトークン数を選択できるようになりました。
アプリは起動しますが、追加されたモデルを指定するとエラーになります。
実は、記述してくれたモデルの中で、gpt-3.5-turbo以外のモデルはChatCompletionでは使えません。
各API毎に使えるモデルについては以下にリスト化されていました。わかりやすい。
https://platform.openai.com/docs/models/model-endpoint-compatibility

ChatCompletionに該当するAPIは/v1/chat/completionsです。
ChatCompletion使えるモデル的にはgpt-3.5-turbo系とgpt-4系なので、ChatGPTに聞いても答えを返してくれなそうなので、ここは上のサイトの内容を元に自前で書き換えます。

# 変更前
available_models = ["gpt-3.5-turbo", "davinci", "curie", "babbage", "ada"]
# 変更後
available_models = ["gpt-4", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-16k-0613"]

gpt-4-32k, gpt-4-32k-0613については、まだ使えないようでした。
https://help.openai.com/en/articles/7102672-how-can-i-access-gpt-4

選択して実行した場合のエラー

penai.error.InvalidRequestError: The model `gpt-4-32k` does not exist or you do not have access to it. Learn more: https://help.openai.com/en/articles/7102672-how-can-i-access-gpt-4.

また、max_tokensの初期値が1トークンと少なすぎなので、初期値を1000くらいにしておきます。

# 変更前
max_tokens_input = tk.Spinbox(root, from_=1, to=1500, width=7)
# 変更後
max_tokens_var = tk.StringVar()
max_tokens_var.set("1000")
max_tokens_input = tk.Spinbox(
    root, from_=1, to=1500, width=7, textvariable=max_tokens_var)

NG集

# initialで設定
max_tokens_input = tk.Spinbox(root, from_=1, to=1500, width=7, initial=1000)
　> _tkinter.TclError: unknown option "-initial"　というエラーが出ます。
  Spinboxにinitialという引数は存在しない。

# setで設定
max_tokens_input.set(1000)
　> AttributeError: 'Spinbox' object has no attribute 'set'. Did you mean: 'get'?　というエラーが出ます。
   Spinboxにsetメソッドは存在しない。

公式情報
https://docs.python.org/ja/3/library/tkinter.ttk.html#spinbox

終わりに

Pythonのライブラリが充実しているのでかなり簡単な実装でOpenAIのAPIを使うことができました。
最初に出力されたdavinci版でのチャットでは正直使い物にならないと感じましたが、
GPT３.5との違いは学習に用いたパラメータ数だけという話もあるので、モデルの違いによっての進化の過程を垣間見ることができました。
ファインチューニングも興味あるので近いうちに試したいと思います。

ちなみに、第3代内閣総理大臣は山縣有朋でした。

レスキューナウテックブログPublication

日本で唯一の危機管理情報を専門に取り扱う防災・BCPの専門企業、(株)レスキューナウです。当社で活躍するエンジニアの技術ブログを中心に公開していきます。

はじめに

方針

環境

完成版

openai_chat_app.py

セットアップ・実行

ChatGPTとのやりとり

[私] 導入

[GPT]

[私] 仮想環境化の依頼

[GPT]

[私] エラーの解決を依頼

[GPT]

対策：

[私] 秘密情報の秘匿化を依頼

[GPT]

[私] 賢いモデルに変更を依頼

[GPT]

[私] 最新情報の取得について

[GPT]

[私] アプリの機能拡張を依頼

[GPT]

終わりに

Discussion