init

.gitignore

@@ -0,0 +1 @@
+.env

app.py

@@ -0,0 +1,161 @@
+# 必要なモジュールをインポート
+import os
+import sys
+import json
+import csv
+import dotenv
+import openai
+from langchain.chat_models import ChatOpenAI
+from langchain.agents import initialize_agent, Tool
+from langchain.schema import (
+    AIMessage,
+    HumanMessage,
+    FunctionMessage
+)
+from langchain.chat_models import ChatOpenAI
+from langchain.agents import AgentType
+
+# .envファイルから環境変数をロード
+dotenv.load_dotenv(".env")
+
+# OpenAIキーをosモジュールで取得
+openai.api_key = os.environ.get("OPENAI_API_KEY")
+
+# 民間伝承を取得する関数
+def fetch_folklore(location):
+    folklore_lookup = {}
+    # CSVファイルからデータを読み取り、地点をキー、伝承を値とする辞書を作成
+    with open('folklore.csv', 'r') as f:
+        reader = csv.DictReader(f)
+        folklore_lookup = {row['location']:row['folklore'] for row in reader}
+        
+    # 指定された地点の伝承を返す。存在しない場合は不明を返す。
+    return folklore_lookup.get(location, "その地域の伝承は不明です。")
+
+# LangChainエージェントからレスポンスを取得する関数
+def get_response_from_lang_chain_agent(query_text):
+    # ChatOpenAIを使用して言語モデルを初期化
+    language_model = ChatOpenAI(model_name='gpt-3.5-turbo-0613')
+    tools = [
+        # 民間伝承を取得するToolを作成
+        Tool(
+            name = "Folklore",
+            func=fetch_folklore,
+            description="伝承を知りたい施設や地名を入力。例: 箱根寄木細工",
+        )
+    ]
+    # エージェントを初期化してから応答を取得
+    agent = initialize_agent(tools, language_model, agent="zero-shot-react-description", verbose=True, return_intermediate_steps=True)
+    response = agent({"input": query_text})
+    return response
+
+# 関数呼び出しからレスポンスを取得する関数
+def get_response_from_function_calling(query_text):
+    function_definitions = [
+        # 関数の定義を作成
+        {
+            "name": "fetchFolklore",
+            "description": "伝承を調べる",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "location": {
+                        "type": "string",
+                        "description": "伝承を知りたい施設や地名。例: 箱根寄木細工",
+                    },
+                },
+                "required": ["location"],
+            },
+        }
+    ]
+    messages=[HumanMessage(content=query_text)]
+    language_model = ChatOpenAI(model_name='gpt-3.5-turbo-0613')
+    # 言語モデルを使ってメッセージを予測
+    message = language_model.predict_messages(messages, functions=function_definitions)
+    
+    if message.additional_kwargs:
+        # 関数の名前と引数を取得
+        function_name = message.additional_kwargs["function_call"]["name"]
+        arguments = message.additional_kwargs["function_call"]["arguments"]
+        
+        # JSON 文字列を辞書に変換
+        arguments = json.loads(arguments)
+        
+        # 関数を実行してレスポンスを取得
+        function_response = fetch_folklore(location=arguments.get("location"))
+        # 関数メッセージを作成
+        function_message = FunctionMessage(name=function_name, content=function_response)
+        # 関数のレスポンスをメッセージに追加して予測
+        messages.append(function_message)
+        second_response = language_model.predict_messages(messages=messages, functions=function_definitions)
+        content = "AIの回答: " + second_response.content
+    else:
+        content = "AIの回答: " + message.content
+    return content
+
+# Function Call Agentからレスポンスを取得する関数
+def get_response_from_function_calling_agent(query_text):
+    language_model = ChatOpenAI(model_name='gpt-3.5-turbo-0613')
+    tools = [
+        # 民間伝承情報を提供するツールの追加
+        Tool(
+            name = "Folklore",
+            func=fetch_folklore,
+            description="伝承を知りたい施設や地名を入力。例: 箱根寄木細工"
+        )
+    ]
+    # エージェントの初期化とレスポンスの取得
+    agent = initialize_agent(tools, language_model, agent=AgentType.OPENAI_FUNCTIONS, verbose=True, return_intermediate_steps=True)
+    response = agent({"input": query_text})
+    return response
+
+# メインの実行部分
+def main(query_text):
+    print(f"Input: {query_text}")
+    
+    # LangChainエージェントからのレスポンス
+    response = get_response_from_lang_chain_agent(query_text)
+    print(f"Output of LangChain Agent: {response}")
+    
+    # 関数呼び出しからのレスポンス
+    response = get_response_from_function_calling(query_text)
+    print(f"Output of Function Calling: {response}")
+    
+    # Function Callingエージェントからのレスポンス
+    response = get_response_from_function_calling_agent(query_text)
+    print(f"Output of Function Calling Agent: {response}")
+
+import gradio as gr
+
+def main(query_text):
+    # LangChainエージェントからのレスポンス
+    response1 = get_response_from_lang_chain_agent(query_text)
+
+    # 関数呼び出しからのレスポンス
+    response2 = get_response_from_function_calling(query_text)
+    
+    # Function Callingエージェントからのレスポンス
+    response3 = get_response_from_function_calling_agent(query_text)
+    
+    return response1, response2, response3
+
+# gr.Interface()を使ってユーザーインターフェースを作成します
+# gr.inputs.Text()はテキスト入力ボックスを作成し、
+# gr.outputs.Textbox()は出力テキストを表示するためのテキストボックスを作成します。
+iface = gr.Interface(fn=main, inputs=gr.inputs.Textbox(lines=5, placeholder="質問を入力してください"), 
+                     outputs=[gr.outputs.Textbox(label="LangChain Agentのレスポンス"),
+                              gr.outputs.Textbox(label="関数呼び出しのレスポンス"),
+                              gr.outputs.Textbox(label="Function Calling Agentのレスポンス")])
+
+# インターフェースを起動します
+iface.launch()
+
+# # スクリプトが直接実行された場合にmain()を実行
+# if __name__ == "__main__":
+#     try:
+#         query_text = sys.argv[1]
+#     except IndexError:
+#         print("使い方: python app.py '質問の文字列'")
+#         print("　　例） python app.py '醍醐寺の伝承を教えて'")
+#         sys.exit()
+#     main(query_text=query_text)

folklore.csv

@@ -0,0 +1,85 @@
+location,folklore
+箱根,箱根山の自然環境を生かした芸術として、箱根寄木細工は江戸時代から伝わる工芸品です。
+日下部民藝館,日本各地の美しい民芸品が集められ、展示されている美術館です。ここでは地元の人々が代々受け継いできた伝統的な技術が生かされた作品を見ることができます。
+醍醐寺,平安時代に創建され、豪華な仏像や絵画が数多く保存されている世界遺産です。春には醍醐の花見として知られる見事な桜の景色を楽しむことができます。
+京都, 元々日本の首都であり、古い伝統や文化が残る観光地として有名です。祇園祭、時代祭といった古くからの伝統行事が今もなお毎年行われています。
+奈良, 奈良時代に日本の首都となった歴史的な町で、多くの仏教寺院や古代の遺跡があります。奈良公園では鹿と触れ合うことができ、これは古代の神使との交流を象徴しています。
+金閣寺, 美しい金色の外装で知られる仏教寺院で、観光名所として人気です。金閣寺はあらゆる方位から見て美しく、これは武将足利義満が自身の死後でも名を残したいという願いからきています。
+鹿児島, 鹿児島県の県庁所在地であり、桜島や種子島などの自然美や温泉地が魅力です。また、江戸時代後期の大久保利通や西郷隆盛らを輩出し確立された「薩摩の薩摩っ子精神」は今も地元に息づいています。
+石垣島, 沖縄県の離島で、美しいビーチやダイビングスポットがあります。また、島特有の方言で歌われる「防人の詩」は古くから島民によって受け継がれてきたもので、夜の集まりでは未だに歌われています。
+竹田城址, 天守閣が再建されている日本の城跡で、歴史や風景が楽しめます。
+佐渡,焚く火祭は年に一度、佐渡島で行われる伝統的なお祭りで、邪気を払う象徴とされています。
+信州, 長野県の愛称で、美しい自然や温泉地、歴史的な町並みがあります。
+富士山, 世界遺産に登録されている富士山は、日本を代表する山で観光名所です。
+松本城, 長野県松本市にある日本の山城で、美しい姿と風景が楽しめます。
+高野山, 和歌山県にある密教の聖地であり、修行道場としても有名です。
+東京ディズニーランド, 日本で最も有名なテーマパークで、国内外から多くの観光客が訪れます。
+大阪城, 大阪府大阪市にある歴史的な城で、美しい姿と広大な敷地が魅力です。
+名古屋城, 愛知県名古屋市にある城で、美しい姿と歴史的価値があります。
+長崎, 長崎県の県庁所在地であり、歴史的な町並みやグラバー園、長崎平和公園などがあります。
+滋賀, 滋賀県は琵琶湖を有する地域で、自然や観光名所が豊富です。
+稲佐山, 佐賀県唐津市にある活火山で、美しい景色と温泉が楽しめます。
+宮島, 広島県の島で、厳島神社や大鳥居といった観光名所があります。
+能登半島, 石川県七尾市にある半島で、美しい海岸や温泉地が人気です。
+四国, 四国は香川、愛媛、高知、徳島の四県からなる地域で、四国八十八ヶ所巡りが有名です。
+知床, 北海道の知床半島は世界自然遺産に登録された地域で、豊かな自然が楽しめます。
+洞爺湖, 北海道の湖で、美しい景色や温泉地があります。
+那覇, 沖縄県の県庁所在地であり、首里城や国際通りが観光名所です。
+石垣市, 沖縄県の石垣島にある市で、美しいビーチやリゾートがあります。
+日光, 栃木県の観光地で、日光東照宮や奥日光の自然と歴史を楽しめます。
+伊勢神宮, 三重県の伊勢市にある神社で、日本最古の神宮として有名です。
+大山, 鳥取県と島根県にまたがる山で、登山や自然観察が楽しめます。
+小豆島, 香川県の離島で、オリーブの産地として有名です。
+輪島, 石川県輪島市の日本海に面した町で、輪島塗などの伝統的な工芸品が楽しめます。
+鳴門, 徳島県の鳴門市にある地域で、鳴門の渦潮や大塔宮などが見どころです。
+高千穂峡, 宮崎県の渓谷で、美しい自然景観や滝が楽しめます。
+大山寺, 京都府八幡市にある寺院で、美しい庭園や古い建築物があります。
+道後温泉, 愛媛県松山市にある温泉地で、国内外から多くの観光客が訪れます。
+北谷町, 沖縄県北谷町の美しい海岸とリゾート地が魅力です。
+札幌, 北海道の都市で、大通公園や時計台などの観光名所があります。
+青森, 青森県の県庁所在���であり、ねぶた祭りや津軽三味線が有名です。
+函館, 北海道の港町で、函館山や五稜郭公園が人気の観光地です。
+富士急ハイランド, 山梨県富士吉田市にある遊園地で、絶叫マシンが楽しめます。
+姫路城, 兵庫県姫路市にある歴史的な城で、美しい姿と広大な敷地が魅力です。
+和歌山城, 和歌山県和歌山市にある山城で、美しい姿と歴史的価値があります。
+高知城, 高知県高知市にある城で、歴史的な価値と美しい風景が楽しめます。
+浅草, 東京都台東区にある観光地で、浅草寺や仲見世通りが有名です。
+広島平和記念公園, 広島県広島市にある原爆ドームや平和記念資料館があります。
+奈良公園, 奈良県の奈良市にある公園で、多くの鹿が自由に歩いています。
+秋田犬, 秋田県の秋田市周辺で飼育されている日本の特産犬種です。
+八甲田山, 青森県と秋田県にまたがる山で、美しい自然景観やハイキングが楽しめます。
+長崎バイオパーク, 長崎県長崎市にある動物園で、多種多様な動物が飼育されています。
+高野山, 和歌山県にある密教の聖地であり、修行道場としても有名です。
+小倉城, 福岡県北九州市にある城で、美しい姿と歴史的な価値があります。
+湯布院, 大分県由布市にある温泉地で、美しい自然と温泉が楽しめます。
+天橋立, 京都府宮津市にある景勝地で、美しい景色や自然が楽しめます。
+姫路市立動物園, 兵庫県姫路市にある動物園で、多種多様な動物が飼育されています。
+稚内, 北海道の最北端に位置する市で、海の幸や美しい風景が魅力です。
+宮古島, 沖縄県の島で、美しいビーチやダイビングスポットがあります。
+黄金千枚田, 新潟県十日町市にある田園景観で、美しい風景が楽しめます。
+阿寒湖, 北海道釧路市にある湖で、美しい湖と自然景観が楽しめます。
+山中渓谷, 富山県中新川郡にある景勝地で、美しい渓谷や滝があります。
+高松城, 香川県高松市にある城で、美しい庭園と歴史的な価値があります。
+知床五湖, 北海道斜里町にある湖群で、美しい湖と自然が楽しめます。
+泊まらない温泉, 鳥取県岩美町にある日帰り温泉施設で、美肌効果があると言われています。
+鹿角市, 青森県の市で、美しい自然と観光名所が魅力です。
+龍馬のすまい, 高知県高知市にある坂本龍馬ゆかりの地で、歴史的な建造物があります。
+徳島県立阿波踊り会館, 徳島県徳島市にある会館で、日本の踊りや伝統文化が体験できます。
+松江城, 島根県松江市にある歴史的な城で、美しい姿と広大な敷地が魅力です。
+岩手山, 岩手県にある活火山で、美しい山岳景観が楽しめます。
+長瀞, 埼玉県秩父市にある渓谷で、美しい景観とウミウの天然記念物が魅力です。
+高尾山, 東京都八王子市にある山で、ハイキングや紅葉が楽しめます。
+浮島, 滋賀県大津市にある湖上に浮かぶ島で、美しい自然景観が楽しめます。
+富山湾, 富山県にある湾で、新鮮な海の幸が味わえます。
+日本平, 静岡県静岡市にある山で、美しい景観と富士山が楽しめます。
+笠間, 茨城県笠間市にある観光地で、陶磁器や伝統工芸などが楽しめます。
+宮津市, 京都府宮津市にある町で、天橋立や網野などの観光名所があります。
+青春18きっぷ, JRが提供する乗り放題切符で、観光列車などの利用が可能です。
+湯島天神, 東京都台東区にある神社で、学問の神様として知られています。
+星野リゾート, 北海道や長野県などにある高級リゾートで、自然を満喫できます。
+忍者寺, 岐阜県可児市にある寺院で、忍者の隠れ家として有名です。
+耶馬溪, 島根県の山間地に位置する渓谷で、美しい自然景観が楽しめます。
+鳥取砂丘, 鳥取県にある砂丘で、広大な砂漠のような風景が広がっています。
+由布院湯布院温泉, 大分県由布市にある温泉地で、美しい自然と温泉が楽しめます。
+鞆の浦, 広島県福山市にある港町で、昔ながらの町並みや美しい風景が魅力です。
+小田原城, 神奈川県小田原市にある城で、歴史的な価値と美しい風景が楽しめます。

openai_function_calling_sample_code.py

@@ -0,0 +1,299 @@
+# -*- coding: utf-8 -*-
+"""openai_function_calling_sample_code.ipynb
+
+Automatically generated by Colaboratory.
+
+Original file is located at
+    https://colab.research.google.com/drive/1FBRyZ2hTn04o_nvNDaZFtroebmN4jiz-
+
+# Function Calling  について LangChain Agent と比較しながら試してみた
+
+こちらの記事のサンプルコードになります：https://qiita.com/yu-Matsu/items/12b686fe4cab343f50b3
+
+## 必要なライブラリのインストール
+"""
+
+# !pip install openai==0.27.6
+# !pip install langchain==0.0.205
+
+"""## 一部ライブラリのインポート、APIキーの設定"""
+
+import json
+import os
+import sys
+import openai
+import dotenv
+
+dotenv.load_dotenv(".env")
+openai.api_key = os.environ.get("OPENAI_API_KEY")
+# print("OPENAI_API_KEY: ", openai.api_key)
+
+print("""## 普通にChatGPTに天気を聞いてみる""")
+
+def chat_gpt_without_functions(text):
+    response = openai.ChatCompletion.create(
+        model="gpt-3.5-turbo-0613",
+        messages=[
+            {"role": "user", "content": text},
+        ]
+    )
+    
+    content = response["choices"][0]["message"]["content"]
+    print(content)
+
+    return content
+
+print("""# 挨拶は普通に返ってくるが...""")
+chat_gpt_without_functions("こんにちは")
+
+print("""# 天気を聞いても返してくれない""")
+chat_gpt_without_functions("東京の天気を教えて")
+
+print("""## 今回利用する天気を返す関数""")
+
+print("""# locationに応じて固定値で天気を返すだけの簡単な関数""")
+def weather_function(location):
+    match location:
+      case "東京" | "Tokyo":
+        weather = "晴れ"
+      case "大阪" | "Osaka":
+        weather = "曇り"
+      case "北海道" | "Hokkaido":
+        weather = "雪"
+      case _ :
+        weather = "不明"
+
+    weather_answer = [
+        {"天気": weather}
+    ]
+
+    return json.dumps(weather_answer)
+
+print("""# 実際に Function callingを動かしてみる""")
+
+def chat_gpt_with_function(text):
+    # AIが呼び出せる関数の定義
+    functions = [
+        # 何をする関数かについて記述
+        {
+            "name": "weather",
+            "description": "天気を調べる",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    # location引数についての情報を記述
+                    "location": {
+                        "type": "string",
+                        "description": "天気を知りたい場所を入力。例: 東京",
+                    },
+                },
+                "required": ["location"],
+            },
+        }
+    ]
+
+    # ユーザーの入力から、Functions Callingが必要かどうか判断する
+    response = openai.ChatCompletion.create(
+        model="gpt-3.5-turbo-0613",
+        messages=[
+            {"role": "user", "content": text},
+        ],
+        functions=functions,
+        function_call="auto",
+    )
+
+    # Function Callingが必要なければ、そのままAIの回答になる
+    message = response["choices"][0]["message"]
+
+    # Functions Callingが必要な場合は、messageに関数名と引数を格納されている
+    if message.get("function_call"):
+
+
+        print("------function_callの中身------")
+        print(message["function_call"])
+        print("--------------------------------------")
+
+        # messageから実行する関数と引数を取得
+        function_name = message["function_call"]["name"]
+        arguments = json.loads(message["function_call"]["arguments"])
+
+        # 関数を実行
+        if function_name == "weather":
+            function_response = weather_function(
+                location=arguments.get("location"),
+            )
+
+        # 関数の実行結果を元にAIの回答を生成
+        second_response = openai.ChatCompletion.create(
+            model="gpt-3.5-turbo-0613",
+            messages=[
+                {"role": "user", "content": text},
+                message,
+                {
+                    "role": "function",
+                    "name": function_name,
+                    "content": function_response,
+                },
+            ],
+        )
+
+        content = "AIの回答: " + second_response.choices[0]["message"]["content"]
+    else:
+        content = "AIの回答: " + message["content"]
+    
+    print(content)
+    return content
+
+print("""# 挨拶をした場合は、Functionを呼び出す必要がないと判断される""")
+chat_gpt_with_function("こんにちは")
+
+print("""# 天気を聞いた場合、Functionを呼び出す必要があると判断され、関数名と引数の情報が「function_call」に格納されている""")
+chat_gpt_with_function("東京の天気を教えて")
+
+print("""## LangChain の Agent の場合""")
+
+from langchain.llms import OpenAI
+from langchain.agents import initialize_agent, Tool
+from langchain.agents.mrkl import prompt
+
+def lang_chain_agent(text):
+    llm = OpenAI(model_name='gpt-3.5-turbo-0613')
+    # toolsに利用したいToolを格納する。LangChainで用意されたToolを利用することも出来る。
+    # 代表的なTool一覧：https://book.st-hakky.com/docs/agents-of-langchain/
+    tools = [
+        Tool(
+            name = "Weather",
+            func=weather_function,
+            description="天気を知りたい場所を入力。例: 東京",
+        )
+    ]
+
+    # エージェントの準備
+    agent = initialize_agent(
+        tools,
+        llm,
+        agent="zero-shot-react-description",
+        agent_kwargs=dict(suffix='Answer should be in Japanese.' + prompt.SUFFIX),
+        verbose=True,
+        return_intermediate_steps=True)
+
+    response = agent({"input": text})
+
+    return response
+
+print("""
+# 東京の天気について質問すると、toolsで用意した「Weather」が利用され、その結果を元にAIの回答が生成されていることが分かる
+# 動作が安定しない可能性があるため、失敗する場合は何度か実行してみて下さい
+lang_chain_agent("東京の天気を教えて")
+""")
+
+print("""## LangChain で Function Calling を利用してみる""")
+
+from langchain.schema import (
+    AIMessage,
+    HumanMessage,
+    FunctionMessage
+)
+from langchain.chat_models import ChatOpenAI
+
+def lang_chain_with_function_calling(text):
+    # AIが利用する関数の定義
+    functions = [
+        # 何をする関数かについて記述
+        {
+            "name": "weather",
+            "description": "天気を調べる",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    # location引数についての情報を記述
+                    "location": {
+                        "type": "string",
+                        "description": "天気を知りたい場所を入力。例: 東京",
+                    },
+                },
+                "required": ["location"],
+            },
+        }
+    ]
+
+    # ユーザーの入力をmessagesに格納
+    messages=[HumanMessage(content=text)]
+
+    llm=ChatOpenAI(model_name='gpt-3.5-turbo-0613')
+
+    # ユーザーの入力内容から、Functions Callingが必要かどうか判断する
+    # Function Callingが必要なければ、こちらの結果がAIの回答になる
+    message = llm.predict_messages(
+        messages, functions=functions
+    )
+
+    print("==================")
+    print(message)
+    print("==================")
+
+    # Functions Callingが必要な場合は、additional_kwargsに関数名と引数を格納されている
+    if message.additional_kwargs:
+
+        # messageから実行する関数と引数を取得
+        function_name = message.additional_kwargs["function_call"]["name"]
+        arguments = json.loads(message.additional_kwargs["function_call"]["arguments"])
+
+        # 関数を実行
+        function_response = weather_function(
+            location=arguments.get("location"),
+        )
+
+        # 実行結果をFunctionMessageとしてmessagesに追加
+        function_message = FunctionMessage(name=function_name, content=function_response)
+        messages.append(function_message)
+
+        # FuncitonMessageを元に、AIの回答を取得
+        second_response = llm.predict_messages(
+            messages=messages, functions=functions
+        )
+        content = "AIの回答: " + second_response.content
+    else:
+        content = "AIの回答: " + message.content
+    
+    print(content)
+    return content
+
+print("""# 挨拶の場合は、contentにAIのレスポンスが格納されており、Functionの情報は含まれていない""")
+lang_chain_with_function_calling("こんにちは")
+
+print("""# 天気を聞いた場合、contentにAIのレスポンスは含まれず、additional_kwgargsに呼び出すFunctionの情報が格納されている""")
+lang_chain_with_function_calling("東京の天気を教えて")
+
+print("""# Agent にも対応""")
+
+from langchain.agents import AgentType
+
+def lang_chain_agent_with_function_calling(text):
+    llm = ChatOpenAI(model_name='gpt-3.5-turbo-0613')
+    # カスタムツールの登録は従来のAgentと同様
+    tools = [
+        Tool(
+            name = "Weather",
+            func=weather_function,
+            description="天気を知りたい場所を入力。例: 東京"
+        )
+    ]
+
+    # エージェントの準備
+    agent = initialize_agent(
+        tools,
+        llm,
+        agent=AgentType.OPENAI_FUNCTIONS,  # ここで、AgentType.OPENAI_FUNCTIONSを指定する
+        verbose=True,
+        return_intermediate_steps=True)
+
+    response = agent({"input": text})
+    print(response)
+    return response
+
+print("""# 挨拶の場合はFunctionが利用されていないことが実行結果（intermediate_steps）から分かる""")
+lang_chain_agent_with_function_calling("こんにちは")
+
+print("""# 天気を聞いた場合、intermediate_stepsに��AIMessageとしてFunctionが呼び出されていることが分かる""")
+lang_chain_agent_with_function_calling("今日の東京の天気を教えて")

requirements.txt

@@ -0,0 +1,4 @@
+openai
+langchain
+python-dotenv
+gradio