SFの世界を実現するFunction Callingを丁寧に解説！【ChatGPT神アプデ】

import openai
openai.api_key = 'your-api-key'
response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo-0613",
        messages=[
            {"role": "user", "content": "PythonでHello worldと出力するプログラムを書いて"},
        ])
print(response['choices'][0]['message']['content'])

import openai
openai.api_key = 'your-api-key'
response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo-0613",
        messages=[
        //プロンプト：ボストンの天気は何ですか？
            {"role": "user", "content": "What's the weather like in Boston?"},
        ],
        //追加されたパラメータ1
　　　　　functions=[
            {
               //ここに呼び出す関数情報を記述する。
            }
        ],
        //追加されたパラメータ2
        function_call="auto",
)
print(response['choices'][0]['message']['content'])

import openai
openai.api_key = 'your-api-key'
response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo-0613",
        messages=[
        # プロンプト：ボストンの天気は何ですか？
            {"role": "user", "content": "What's the weather like in Boston?"},
        ],
        # 追加されたパラメータ1
        functions=[
            {
                #  天気APIを実行する関数の情報を記載
            },
            {
                # Google Trend APIを実行する関数の情報を記載
            }
        ],
        # 追加されたパラメータ2
        function_call="auto",
        )
#本来必要な処理は省略している。
print(response['choices'][0]['message']['content'])

import openai
import json
# 6. 天気情報を取得する関数を定義します。
# 本来ならAPIを使いますが、デモのためダミーデータを使います。
def get_current_weather(location, unit="fahrenheit"):
    """Get the current weather in a given location"""
    weather_info = {
        "location": location,
        "temperature": "72", # APIで気温は動的に得られる
        "unit": unit,
        "forecast": ["sunny", "windy"], # APIで天気は動的に得られる
    }
    return json.dumps(weather_info)
def run_conversation():
    # 2. OpenAIのチャットモデルに対するAPIリクエストの作成
    # GPTへの質問文をmessagesという変数に格納している
    messages = [{"role": "user", "content": "What's the weather like in Boston?"}]
    # functionsという変数に、呼ぶ関数情報を設定している。
    functions = [
        {
            # 呼び出す関数の名前や説明
            "name": "get_current_weather", #関数名
            "description": "Get the current weather in a given location", #関数の説明
            # 関数の引数について設定している
            "parameters": {
                "type": "object", # 関数が受け取るパラメータは、JSON形式
                # 引数について設定している。今回は、location と unit の２種類
                "properties": {
                    "location": {# location 引数は、string 型。description は具体例.
                        "type": "string",
                        "description": "The city and state, e.g. San Francisco, CA",
                    },
                    "unit": { #unit 引数は、string 型。
                        "type": "string", 
                        "enum": ["celsius", "fahrenheit"] #許容される文字列２種類を指定
                        },
                },
                "required": ["location"], #location 引数は必須であることを指定
            },
        }
    ]
    # 格納した変数を使い、function calling機能を使った会話リクエストを作る
    response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo-0613",
        messages=messages,
        functions=functions,
        function_call="auto",  
    )
    # 3. APIレスポンスからメッセージを取得します
    response_message = response["choices"][0]["message"]
    # 4. メッセージに関数呼び出しが含まれているかどうかを確認
    if response_message.get("function_call"):
        # 関数呼び出し（function_call）がされていたら、関数を呼び出すための処理を実行する
        # 実行される関数を動的に選ぶための処理。
        # 入力規則は以下。
        # functionsで入力したnameパラメータ（文字列型） :　def で定義した関数名(関数型)
        available_functions = {
            "get_current_weather": get_current_weather,
        }
        # GPTが呼び出すと判断した関数の情報を取得します。
        # 今回の場合は、get_current_weather()関数
        function_name = response_message["function_call"]["name"]
        # 引数情報を取得
        function_args = json.loads(response_message["function_call"]["arguments"])
        # functin_to_call に関数型が値が代入される
        fuction_to_call = available_functions[function_name]
        # そのため以下は、get_current_weather()関数が実行されたときと同じ挙動をする。
        function_response = fuction_to_call(
            location=function_args.get("location"),
            unit=function_args.get("unit"),
        )
        # 関数呼び出しで取得した値を　messages変数（GPTへの質問文）に追加
        # ここでは、関数呼び出しを行い、質問、回答を持ち合わせている状態
        messages.append(response_message) 
        messages.append(
            {
                "role": "function",
                "name": function_name,
                "content": function_response,
            }
        )  
        #5. 前段までで準備した情報をGPT-3.5 モデルに入力する。
        # こうすることで質問に対しての回答を整理するイメージ
        second_response = openai.ChatCompletion.create(
            model="gpt-3.5-turbo-0613",
            messages=messages,
        ) 
        # 7. 最後に、json形式なので、「ボストンの天気」情報に絞った要素を
        return second_response["choices"][0]["message"]["content"] 
# 1. run_conversation()関数を呼び出し、その出力を表示します。
print(run_conversation())

# 1. run_conversation()関数を呼び出し、その出力を表示します。
print(run_conversation())

def run_conversation():
    # 2. OpenAIのチャットモデルに対するAPIリクエストの作成
    # GPTへの質問文をmessagesという変数に格納している
    messages = [{"role": "user", "content": "What's the weather like in Boston?"}]
    # functionsという変数に、呼ぶ関数情報を設定している。
    functions = [
        {
            # 呼び出す関数の名前や説明
            "name": "get_current_weather", #関数名
            "description": "Get the current weather in a given location", #関数の説明
            # 関数の引数について設定している
            "parameters": {
                "type": "object", # 関数が受け取るパラメータは、JSON形式
                # 引数について設定している。今回は、location と unit の２種類
                "properties": {
                    "location": {# location 引数は、string 型。description は具体例.
                        "type": "string",
                        "description": "The city and state, e.g. San Francisco, CA",
                    },
                    "unit": { #unit 引数は、string 型。
                        "type": "string", 
                        "enum": ["celsius", "fahrenheit"] #許容される文字列２種類を指定
                        },
                },
                "required": ["location"], #location 引数は必須であることを指定
            },
        }
    ]
    # 格納した変数を使い、function calling機能を使った会話リクエストを作る
    response = openai.ChatCompletion.create(
        model="gpt-3.5-turbo-0613",
        messages=messages,
        functions=functions,
        function_call="auto",  
    )

# 3. APIレスポンスからメッセージを取得します
message = response["choices"][0]["message"]

# 4. メッセージに関数呼び出しが含まれているかどうかを確認
    if response_message.get("function_call"):
        # 関数呼び出し（function_call）がされていたら、関数を呼び出すための処理を実行する
        # 実行される関数を動的に選ぶために必要な処理。available_functions への入力規則は以下。
        # functionsで入力したnameパラメータ（文字列型） :　def で定義した関数名(関数型)
        available_functions = {
            "get_current_weather": get_current_weather,
        }
        # GPTが呼び出すと判断した関数情報を取得します。
        # 今回の場合は、get_current_weather()関数
        function_name = response_message["function_call"]["name"]
        # 引数情報を取得
        function_args = json.loads(response_message["function_call"]["arguments"])
        # functin_to_call に関数型が値が代入される
        fuction_to_call = available_functions[function_name]
        # そのため以下は、get_current_weather()関数が実行されたときと同じ挙動をする。
        function_response = fuction_to_call(
            location=function_args.get("location"),
            unit=function_args.get("unit"),
        )
        print(response_message)
        # 関数呼び出しで取得した値を　messages変数（GPTへの質問文）に追加
        # ここでは、関数呼び出しを行い、質問、回答を持ち合わせている状態
        messages.append(response_message) 
        messages.append(
            {
                "role": "function",
                "name": function_name,
                "content": function_response,
            }
        )

# 5. 天気情報を取得する関数を定義します。
# 本来ならAPIを使いますが、デモのためダミーデータを使います。
def get_current_weather(location, unit="fahrenheit"):
    """location 引数から与えられた場所の気温データ取得"""
    weather_info = {
        "location": location,
        "temperature": "72", # APIを使えば、気温は動的に得られる
        "unit": unit,
        "forecast": ["sunny", "windy"], # APIを使えば、天気は動的に得られる
    }
    return json.dumps(weather_info)

#6. 前段で準備した情報をGPT-3.5 モデルに入力する。
        # こうすることで、get_current_weather()関数からの値が取得できる
        second_response = openai.ChatCompletion.create(
            model="gpt-3.5-turbo-0613",
            messages=messages,
        ) 

# 7. 最後に、「ボストンの天気」の情報が得られます。
return second_response["choices"][0]["message"]["content"]