[update]add function calling test

README.md

@@ -1,5 +1,5 @@
 ---
-title: Openai Assistant
+title: OpenAI Assistant
 emoji: 🏢
 colorFrom: pink
 colorTo: blue

description.md

@@ -0,0 +1,95 @@
+## OpenAI Assistant
+
+基于 [OpenAI platform](https://platform.openai.com/docs/introduction) 开发的 assistant 界面及示例。
+
+### 使用方法
+
+填写 `openai_api_key` 之后，点击任意 `Example`，然后点击 `Add and run` 就可以运行起来。
+
+界面使用主要分为左中右三个部分。
+
+左边，主要包含对系统的增删查功能。其中最重要的是 `create assistant` 标签，你可以在此填写内容并创建新的 assistant。
+
+中间，是 `conversation` 对话窗口。点击 `Add and run` 按钮就可以发送消息。由于一些原因，后端返回的内容可能无法自动更新到 chatbot 对话记录中，因此你可能需要用到 `Refresh` 按钮。
+
+右边，是一些对话的状态和提示信息。每个对话都需要有一个机器人，即 `assistant_id` 。如果你点击 `Add and run` 按钮发送消息时它的值为空，则会根据 `create assistant` 中的内容自动创建一个机器人，并填充 `assistant_id`，这个参数决定了你正在与哪个机器人聊天，因此不要乱改它，因为它很重要。
+`thread_id` 参数，好像是一个会话的概念，因此也不要乱改。
+
+
+### 对话记录
+
+
+#### 披萨订餐机器人
+
+```text
+User: 你好。
+```
+```text
+Assistant: 嗨！欢迎光临我们的披萨店。 😊 准备好下单了吗？您想要点哪种披萨？
+```
+```text
+User: 可以先看一下菜单吗、
+```
+```text
+Assistant: 好的，这是我们的菜单：
+
+披萨：
+
+意大利辣香肠披萨（大 $12.95/中 $10.00/小 $7.00）
+芝士披萨（大 $10.95/中 $9.25/小 $6.50）
+茄子披萨（大 $11.95/中 $9.75/小 $6.75）
+小吃：
+
+薯条（大 $4.50/小 $3.50）
+希腊沙拉 $7.25
+额外配料：
+
+奶酪 $2.00
+蘑菇 $1.50
+香肠 $3.00
+加拿大培根 $3.50
+AI辣酱 $1.50
+辣椒 $1.00
+饮料：
+
+可乐（大 $3.00/中 $2.00/小 $1.00）
+雪碧（大 $3.00/中 $2.00/小 $1.00）
+瓶装水 $5.00
+请告诉我您想要点哪些项目，如果您想要额外的配料或其他产品，也请随时告诉我。 😄
+```
+```text
+User: 来一个芝士披萨，和一杯雪碧大份。
+```
+```text
+Assistant: 非常好的选择！一个大份的芝士披萨和一大杯雪碧。
+那还需要加点别的吗，比如额外的奶酪或者其他配料？还是这样就可以了？ 😊
+```
+```text
+User: 可以了
+```
+```text
+Assistant: 太棒了！接下来，请问是自取还是需要我们外送？
+如果需要外送的话，麻烦提供一下您的地址。🚚💨
+```
+```text
+User: 我堂食。
+```
+```text
+Assistant: 好的，堂食！您的订单总金额为 $10.95（大份芝士披萨） + $3.00（大杯雪碧） = $13.95
+谢谢您的点单，希望您在这里享受到愉快的用餐体验！🍕🥤🎉
+```
+```text
+User: 哦哦，不好意思，我的披萨要小份就好了。
+```
+```text
+Assistant: 没问题，我已经帮您更改为小份芝士披萨。
+您的订单现在是小份芝士披萨 $6.50 加上大杯雪碧 $3.00，总计金额为 $9.50。
+是否还有其他需要调整的地方？ 😊
+```
+```text
+User: 没有了，很好。
+```
+```text
+Assistant: 好的，订单确认为小份芝士披萨和大杯雪碧，总计 $9.50。
+您的餐点很快就能准备好。祝您在这里用餐愉快！🍕🥤✨
+```

examples.json

@@ -30,5 +30,15 @@
         "gpt-4-1106-preview",
         "What's the weather san francisco",
         "Weather Bot 天气查询，一个基于函数调用的机器人。\n在左边栏的 function script 标签中可以查看有哪些函数可用。\n例如有一个函数叫作 “get_current_weather” 则有一个名为 “get_current_weather.py” 的 python 脚本，其中包含一个名为 “get_current_weather” 的函数。\n当函数被调用时，程序会自动导入该函数并调用。\n因此，你也可以上传自己的函数。"
+    ],
+    [
+        "订餐机器人",
+        "你是订餐机器人，为披萨餐厅自动收集订单信息。\n你要首先问候顾客。然后等待用户回复收集订单信息。收集完信息需确认顾客是否还需要添加其他内容。\n最后需要询问是否自取或外送，如果是外送，你要询问地址。\n最后告诉顾客订单总金额，并送上祝福。\n\n请确保明确所有选项、附加项和尺寸，以便从菜单中识别出该项唯一的内容。\n你的回应应该以简短、非常随意和友好的风格呈现。",
+        null,
+        "{\"type\": \"function\", \"function\": {\"name\": \"get_pizza_restaurant_menu\", \"description\": \"获取披萨餐厅的菜单。\", \"parameters\": {\"type\": \"object\", \"properties\": {}, \"required\": []}}}",
+        null,
+        "gpt-4-1106-preview",
+        "你好。",
+        "相比于知识问答机器人，客服机器人需要主题向客户提问以引导客户，此示例主要测试客服机器人的配置技巧。"
     ]
 ]

functions/get_current_weather.py

@@ -1,9 +1,12 @@
 #!/usr/bin/python3
 # -*- coding: utf-8 -*-
 import json
+from typing import List
 
 
-def get_current_weather(location, unit="fahrenheit"):
+def get_current_weather(location: str, unit: str = None):
+    unit = unit or "fahrenheit"
+
     if "tokyo" in location.lower():
         return json.dumps({"location": location, "temperature": "10", "unit": "celsius"})
     elif "san francisco" in location.lower():
@@ -12,7 +15,38 @@ def get_current_weather(location, unit="fahrenheit"):
         return json.dumps({"location": location, "temperature": "22", "unit": "celsius"})
 
 
+def kwargs() -> List[str]:
+    """
+    函数调用时会根据此处返回的 key 来创建 kwargs 关键字参数，如果存在 key 的值没有提供，则会将其赋值为 None。
+    因此在定义函数时有默认值的参数的值应该为 None，而其真正的默认值可在函数内部赋值，以免被 kwargs 中的 None 覆盖。
+    """
+    return ["location", "unit"]
+
+
 def main():
+    tools = [
+        {
+            "type": "function",
+            "function": {
+                "name": "get_current_weather",
+                "description": "Get the current weather in a given location",
+                "parameters": {
+                    "type": "object",
+                    "properties": {
+                        "location": {
+                            "type": "string",
+                            "description": "The city and state, e.g. San Francisco, CA",
+                        },
+                        "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]},
+                    },
+                    "required": ["location"],
+                },
+            },
+        }
+    ]
+    tools_ = json.dumps(tools, ensure_ascii=False)
+    print(tools_.replace("\"", "\\\""))
+
     result = get_current_weather("beijing")
     print(result)
     return

functions/get_pizza_restaurant_menu.py

@@ -0,0 +1,67 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+import json
+from typing import List
+
+
+def get_pizza_restaurant_menu():
+    result = """
+    菜单包括：
+    
+    菜品：
+    意式辣香肠披萨（大、中、小） 12.95、10.00、7.00
+    芝士披萨（大、中、小） 10.95、9.25、6.50
+    茄子披萨（大、中、小） 11.95、9.75、6.75
+    薯条（大、小） 4.50、3.50
+    希腊沙拉 7.25
+    
+    配料：
+    奶酪 2.00
+    蘑菇 1.50
+    香肠 3.00
+    加拿大熏肉 3.50
+    AI酱 1.50
+    辣椒 1.00
+    
+    饮料：
+    可乐（大、中、小） 3.00、2.00、1.00
+    雪碧（大、中、小） 3.00、2.00、1.00
+    瓶装水 5.00
+    """
+    return result
+
+
+def kwargs() -> List[str]:
+    """
+    函数调用时会根据此处返回的 key 来创建 kwargs 关键字参数，如果存在 key 的值没有提供，则会将其赋值为 None。
+    因此在定义函数时有默认值的参数的值应该为 None，而其真正的默认值可在函数内部赋值，以免被 kwargs 中的 None 覆盖。
+    """
+    return []
+
+
+def main():
+    tools = [
+        {
+            "type": "function",
+            "function": {
+                "name": "get_pizza_restaurant_menu",
+                "description": "获取披萨餐厅的菜单。",
+                "parameters": {
+                    "type": "object",
+                    "properties": {},
+                    "required": [],
+                },
+            },
+        }
+    ]
+    tools_ = json.dumps(tools, ensure_ascii=False)
+    print(tools_)
+    print(tools_.replace("\"", "\\\""))
+
+    result = get_pizza_restaurant_menu()
+    print(result)
+    return
+
+
+if __name__ == '__main__':
+    main()

main.py

@@ -40,6 +40,11 @@ def get_args():
         default="examples.json",
         type=str
     )
+    parser.add_argument(
+        "--description_md_file",
+        default="description.md",
+        type=str
+    )
     parser.add_argument(
         "--openai_api_key",
         default=settings.environment.get("openai_api_key", default=None, dtype=str),
@@ -52,7 +57,6 @@ def get_args():
 def dynamic_import_function(package_name: str, function_name: str):
     try:
         lib = importlib.import_module("functions.{}".format(package_name))
-        print(lib)
     except ModuleNotFoundError as e:
         raise e
 
@@ -253,6 +257,18 @@ def click_delete_function_python_script(filename: str):
     return result
 
 
+def click_download_function_python_script(name: str):
+    function_script_dir = project_path / "functions"
+    filename = function_script_dir / name.strip()
+    if not filename.exists():
+        files = None
+        flag = "File Not Found: {}".format(name.strip())
+    else:
+        files = [filename.as_posix()]
+        flag = "You can download it on `upload_python_script_files` now."
+    return files, flag
+
+
 def convert_message_list_to_conversation(message_list: List[dict]) -> List[Tuple[str, str]]:
     conversation = list()
     for message in message_list:
@@ -364,11 +380,10 @@ def add_and_run(openai_api_key: str,
                 for tool_call in run.required_action.submit_tool_outputs.tool_calls:
                     function_name = tool_call.function.name
                     function_to_call = dynamic_import_function(function_name, function_name)
+                    kwargs_required: List[str] = dynamic_import_function(function_name, "kwargs")()
                     function_args = json.loads(tool_call.function.arguments)
-                    function_response = function_to_call(
-                        location=function_args.get("location"),
-                        unit=function_args.get("unit"),
-                    )
+                    kwargs = {k: function_args.get(k) for k in kwargs_required}
+                    function_response = function_to_call(**kwargs)
                     tool_outputs.append({
                         "tool_call_id": tool_call.id,
                         "output": function_response,
@@ -396,6 +411,7 @@ def add_and_run(openai_api_key: str,
         result = [
             assistant_id, thread_id,
             conversation,
+            None
         ]
         yield result
 
@@ -403,10 +419,15 @@ def add_and_run(openai_api_key: str,
 def main():
     args = get_args()
 
-    gr_description = """
-    OpenAI Assistant
+    brief_description = """
+    ## OpenAI Assistant
+
+    基于 [OpenAI platform](https://platform.openai.com/docs/introduction) 开发的 assistant 界面及示例。使用方法等详细介绍在最下面。
     """
 
+    with open(args.description_md_file, "r", encoding="utf-8") as f:
+        md_description = f.read()
+
     # example json
     with open(args.examples_json_file, "r", encoding="utf-8") as f:
         examples = json.load(f)
@@ -419,7 +440,7 @@ def main():
 
     # ui
     with gr.Blocks() as blocks:
-        gr.Markdown(value=gr_description)
+        gr.Markdown(value=brief_description)
 
         with gr.Row():
             # settings
@@ -446,7 +467,7 @@ def main():
                         retrieval_file_ids = gr.TextArea(label="retrieval_file_ids")
 
                         # create assistant
-                        create_assistant_button = gr.Button("create assistant")
+                        create_assistant_button = gr.Button("create assistant", variant="secondary")
 
                     with gr.TabItem("assistants"):
                         list_assistant_button = gr.Button("list assistant")
@@ -474,8 +495,9 @@ def main():
                         upload_function_python_script_files = gr.Files(label="upload_python_script_files")
                         upload_function_python_script_button = gr.Button("upload python script")
 
-                        delete_function_python_script_file = gr.Textbox(max_lines=1, label="delete_python_script_file")
+                        function_python_script_file = gr.Textbox(max_lines=1, label="python_script_file")
                         delete_function_python_script_button = gr.Button("delete python script")
+                        download_function_python_script_button = gr.Button("download python script")
 
             # chat
             with gr.Column(scale=5):
@@ -484,7 +506,7 @@ def main():
 
                 with gr.Row():
                     with gr.Column(scale=1):
-                        add_and_run_button = gr.Button("Add and run")
+                        add_and_run_button = gr.Button("Add and run", variant="primary")
                     with gr.Column(scale=1):
                         refresh_button = gr.Button("Refresh")
 
@@ -506,6 +528,8 @@ def main():
                 examples_per_page=5
             )
 
+        gr.Markdown(value=md_description)
+
         # create assistant
         create_assistant_button.click(
             click_create_assistant,
@@ -611,13 +635,41 @@ def main():
         delete_function_python_script_button.click(
             click_delete_function_python_script,
             inputs=[
-                delete_function_python_script_file
+                function_python_script_file
             ],
             outputs=[
-                delete_function_python_script_file
+                function_python_script_file
             ]
         )
 
+        # download function python script
+        download_function_python_script_button.click(
+            click_download_function_python_script,
+            inputs=[
+                function_python_script_file
+            ],
+            outputs=[
+                upload_function_python_script_files, function_python_script_file
+            ]
+        )
+
+        # query submit
+        query.submit(
+            add_and_run,
+            inputs=[
+                openai_api_key,
+                assistant_id, thread_id,
+                name, instructions, description, tools, retrieval_files, retrieval_file_ids, model,
+                query,
+            ],
+            outputs=[
+                assistant_id, thread_id,
+                chat_bot,
+                query
+            ],
+            api_name="query_submit",
+        )
+
         # add and run
         add_and_run_button.click(
             add_and_run,
@@ -629,7 +681,8 @@ def main():
             ],
             outputs=[
                 assistant_id, thread_id,
-                chat_bot
+                chat_bot,
+                query
             ],
         )