ほぼテク6月17日ChatGPTの活用ガイド！AIをあなたのプロジェクトに取り入れる方法徹底解説？

AI生成AIChatGPTGPTAPI組み込み

6月17日

著者裕太我妻

ほぼテク読者の皆様、いつもありがとうございます！
我妻裕太です。

本日も情報発信いたします。
本日は6月17日、静岡県伊東から原稿執筆しております！

富士山が見えて快晴です！縁起がいい・・・”(-“”-)”
本日もよろしくお願いします。

今回のテーマはやっぱり大好きChatGPTを自分のプロジェクトに組み込むには？をテーマに実際にChatGPTを組み込む手順をご紹介いたします。
何かの参考になれば幸いです(*’▽’)

それではどうぞ↓

念のためChatGPTとは？

ChatGPTは、自社サービスやみなさんのアプリケーションに人間のようなテキスト対話能力を追加するのに役立つ、OpenAIによって開発された強力な自然言語理解AIです。
その機能を最大限に活用するためには、まずはその基本的な使用方法を理解することが必要です！

今回は、そのためのガイドを提供していきますよー。
※今回はPythonを想定しておりますので、ご了承ください。

ChatGPTのセットアップ

まず最初に、ChatGPTのライブラリをインストールするところからスタートします。Pythonとpip（Pythonのパッケージ管理システム）が既にインストールされていることを確認します。
以下のコマンドを使ってOpenAIのPythonクライアントをインストールします。

これでライブラリのインストールが完了します。

pip install openai

APIキーの設定

OpenAIのAPIを使用するためには、APIキーが必要です。
これはOpenAIのウェブサイトで取得できます。

APIキーを取得したら、環境変数として設定することができます。
Unix系のシステムでは以下のコマンドを使用します。

export OPENAI_API_KEY='your-api-key

これで使用する準備ができました！とっても簡単ですね。

ChatGPTを使用したシンプルな対話生成

それではさっそく試してみましょう。
ここではChatGPTを使用してシンプルな対話を生成する基本的な方法について見ていきます。

以下のコードスニペットでは、ユーザーからのプロンプトに対するChatGPTのレスポンスを生成しています。

import openai

openai.api_key = 'your-api-key'
response = openai.ChatCompletion.create(
  model=" gpt-3.5-turbo-0613 ",
  messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Who won the world series in 2020?"},
    ]
)
print(response['choices'][0]['message']['content'])

このコードは、まず初めにOpenAIのAPIキーを設定します。
その後、ChatCompletion.createメソッドを使ってChatGPTとの会話を開始します。
メッセージはリスト形式で渡され、それぞれのメッセージは役割（"system"、"user"、"assistant"）と内容を持つ辞書型です。

ここでちょっと詳細な説明をします。

ChatGPTによる対話モデルでは、メッセージはそれぞれ役割（"system"、"user"、"assistant"）を持っています。
それぞれの役割は以下のような意味を持ちます。

System
システム役割は対話の開始時に一度だけ使われます。
このメッセージは、アシスタント（ChatGPT）の振る舞いを設定するために使われます。
たとえば、システムメッセージが"You are an assistant that speaks like Shakespeare."であれば、ChatGPTはシェイクスピアのような言葉遣いで応答します。
User
ユーザー役割は、アシスタントに命令を出すか質問をするために使われます。
ユーザーからのメッセージはChatGPTが反応する内容を決定します。
Assistant
アシスタント役割は、ChatGPT自身の発言を表します。
アシスタントのメッセージは一般的にAPIの応答の一部であり、ユーザーからの前のメッセージに基づいています。
ただし、対話を継続するためには、前回のアシスタントのメッセージを次のAPI呼び出しに含めることが推奨されます。

これらの役割を理解することで、ChatGPTとの対話をより効果的に制御できます。

最後に応答から内容を取得して出力します。
ChatGPTからの応答は通常、JSON形式で返されます。

注意点として、model="gpt-3.5-turbo-0613"はGPTの特定のバージョンを指していますが、利用可能なモデルに変更する必要があります。
また、必ず自身のAPIキーを設定してください。

また、プログラムが具体的に何をすべきか、または特定の問題を解決するためにどのようにChatGPTを使用するかについては、あなた自身のプロジェクトの要件に大きく依存します。
より具体的なアドバイスを提供するためには、より具体的な情報が必要となります。

この時点でこんなエラーが出た場合は？

ちなみにここらへんで以下のようなエラーに遭遇する方がいるかもしれません！私は遭遇したので、参考までに記載しておきます！

openai.error.InvalidRequestError: The model `gpt-4.0-turbo` does not exist

エラーメッセージを見ると、指定したモデルが存在しないという問題が発生しているようです。
OpenAIのGPT-4のモデルがリリースされていない、または別の名前でリリースされている可能性があります。

OpenAIのAPIドキュメントを参照するか、以下のコードを使用してOpenAIの利用可能なモデルのリストを取得して確認することができます。

import openai

openai.api_key = 'your-api-key'
print(openai.Model.list())

このコードは、OpenAIのすべての利用可能なモデルのリストを表示します。
その中から適切なモデルを選択し、それを使用してAPIリクエストを作成します。
GPT-3を使用することもできます。その場合、モデル名はtext-davinci-003などとなります。

さらにもう一つエラーがでました(汗)

openai.error.RateLimitError: You exceeded your current quota, please check your plan and billing details.

エラーメッセージによると、現在のAPI利用量の上限（quota）を超えてしまっているようです。
OpenAI APIは各プランにより、時間あたりまたは月あたりのリクエスト数に制限（rate limit）を設けています。以下のような理由でこのエラーが発生する可能性があります。

APIキーに関連づけられたアカウントが許可されたAPIリクエスト数を超えてしまった。
OpenAIのAPIを同時に使用するための並列リクエストの上限を超えてしまった。

これを解決するためには以下の手順を試してみてください。

OpenAIのダッシュボードを確認
OpenAIのダッシュボードであなたのAPI使用状況を確認してみてください。
これにより、使用量が上限に達しているかどうか、またはどの程度使用しているかを把握できます。
プランのアップグレード
OpenAI APIの使用量が多い場合、あなたのプランがAPIの使用量をカバーできないかもしれません。
その場合、プランをアップグレードすることを検討してみてください。
リクエストの頻度を減らす
リクエストの頻度が高すぎる場合は、リクエストの間隔を少し広げてみてください。
OpenAIに連絡する
上記の手段で問題が解決しない場合は、OpenAIのサポートに連絡してみてください。

今回は無料クレジットをすべて使い切ってしまっていたようです。
すぐに自分のクレジットカード情報を追加して復旧しました(*’▽’)

では寄り道しましたが、また戻りたいと思います。

ChatGPTを活用した進行中の対話

ChatGPTは対話を続けるために、過去のメッセージを利用して新しいメッセージを生成することができます。
以下のようなイメージです。

import openai

openai.api_key = 'your-api-key'
response = openai.ChatCompletion.create(
  model=" gpt-3.5-turbo-0613 ",
  messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Tell me a joke."},
    ]
)
# 得られた応答を保存
message_from_chat_gpt = response['choices'][0]['message']['content']

# 保存した応答を新しいメッセージに利用
response = openai.ChatCompletion.create(
  model="gpt-3.5-turbo-0613",
  messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Tell me a joke."},
        {"role": "assistant", "content": message_from_chat_gpt},
        {"role": "user", "content": "That was funny! Tell me another one."},
    ]
)
print(response['choices'][0]['message']['content'])

このコードでは、最初にChatGPTにジョークを教えてもらい、その応答を保存します。
その後、同じ対話を続けるためにその応答を次のメッセージ生成リクエストに渡します。

ChatGPTの最適化（temperature、max_tokens）

生成されるテキストの性質を調整するためには、temperatureとmax_tokensという2つのパラメータがあります。

temperature
この値は0から1までの数値で、出力のランダム性を制御します。
値が高いほど出力はランダムになり、値が低いほど出力は確定的になります。

max_tokens
この値は出力の長さを制御します。
大きな値を設定すると、より長いテキストが生成されますが、それによってコストが増加する可能性もあります。

これらのパラメータを使って、以下のようにChatGPTの動作を最適化することができます。

response = openai.ChatCompletion.create(
  model=" gpt-3.5-turbo-0613",
  messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Tell me a joke."},
    ],
  temperature=0.6,
  max_tokens=60
)