Merge pull request #73 from liuooo/add-more-examples

move e2e tests to the examples section to lower the barrier to trial, add more examples

Author: liuooo

README.md

@@ -92,15 +92,17 @@ Interface documentation address: http://127.0.0.1:8086/docs
 
 ### Complete Usage Example
 
-In this example, an AI assistant is created and run using the official OpenAI client library, including two built-in
-tools, web_search and retrieval, and a custom function.
+In this example, an AI assistant is created and run using the official OpenAI client library. If you need to explore other usage methods, 
+such as streaming output, tools (web_search, retrieval, function), etc., you can find the corresponding code under the examples directory.
 Before running, you need to run `pip install openai` to install the Python `openai` library.
 
 ```sh
 # !pip install openai
-python tests/e2e/index.py
+export PYTHONPATH=$(pwd) 
+python examples/run_assistant.py 
 ```
 
+
 ### Permissions
 Simple user isolation is provided based on tokens to meet SaaS deployment requirements. It can be enabled by configuring `APP_AUTH_ENABLE`.
 

README_CN.md

@@ -89,12 +89,14 @@ Api Base URL: http://127.0.0.1:8086/api/v1
 
 ### 完整使用示例
 
-此示例中使用 OpenAI 官方的 client 库创建并运行了一个 AI 助手，包含了 web_search 和 retrieval 两个内置 tool 和一个自定义 function。
+此示例中使用 OpenAI 官方的 client 库创建并运行了一个 AI 助手。如果需要查看其它使用方式，如流式输出、工具（web_search、retrieval、function)的使用等，
+可以在 examples 查看对应示例。
 运行之前需要运行 `pip install openai` 安装 Python `openai` 库。
 
 ```sh
 # !pip install openai
-python tests/e2e/index.py
+export PYTHONPATH=$(pwd) 
+python examples/run_assistant.py 
 ```
 
 ### 权限

examples/__init__.py

@@ -1,26 +1,27 @@
 import time
+import logging
+import requests
+import json
 
-import openai
-import pytest
+from app.exceptions.exception import BadRequestError
+from examples.prerun import client
+from examples.prerun import base_url
+from examples.prerun import api_key
 
-from app.providers.database import session
-from app.schemas.tool.action import ActionBulkCreateRequest
-from app.schemas.tool.authentication import Authentication, AuthenticationType
-from app.services.tool.action import ActionService
 
+# To test the localhost, you can listen to a port using the shell command 'echo -e "HTTP/1.1 200 OK\r\n\r\n Success" | nc -l 9999'.
+# Make sure to change the URL to match your API server.
+auth_server_url = "http://localhost:9999/api/v1"
 
-@pytest.fixture
-def api_url():
-    return "http://127.0.0.1:8086/api/v1/actions"
-
-
-@pytest.fixture
-def create_workspace_with_authentication():
-    return {
+def create_worksapce_action():
+    """
+    create action with actions api
+    """
+    openapi_schema = {
         "openapi_schema": {
             "openapi": "3.0.0",
             "info": {"title": "Create New Workspace", "version": "1.0.0"},
-            "servers": [{"url": "https://tx.c.csvfx.com/api"}],
+            "servers": [{"url": f"{auth_server_url}"}],
             "paths": {
                 "/tx/v1/workspaces": {
                     "post": {
@@ -74,68 +75,73 @@ def create_workspace_with_authentication():
             },
         }
     }
+    openapi_schema["authentication"] = {"type": "none"}
+    actions_url = f"{base_url}/actions"
+    headers = {
+        'Content-Type': 'application/json',
+        'Authorization': f'Bearer {api_key}'
+    }
+    response = requests.request("POST", actions_url, headers=headers, data=json.dumps(openapi_schema), timeout=1000)
+    if response.status_code != 200:
+        raise BadRequestError(f"Failed to create action: {response.text}")
+    return response.json()
 
 
-# 测试带有action的助手,run 的时候传递自己的auth信息
-def test_run_with_action_auth(create_workspace_with_authentication):
-    body = ActionBulkCreateRequest(**create_workspace_with_authentication)
-    body.authentication = Authentication(type=AuthenticationType.none)
-    actions = ActionService.create_actions_sync(session=session, body=body)
-    [create_workspace_with_authentication] = actions
-
-    client = openai.OpenAI(base_url="http://localhost:8086/api/v1", api_key="xxx")
+if __name__ == "__main__":
+    [create_workspace_with_authentication] = create_worksapce_action()
+    logging.info("=====> action: %s\n", create_workspace_with_authentication)
 
-    # 创建带有 action 的 assistant
+    # create a assistant with action
     assistant = client.beta.assistants.create(
         name="Assistant Demo",
-        instructions="你是一个有用的助手",
-        tools=[{"type": "action", "id": create_workspace_with_authentication.id}],
+        instructions="you are a personal assistant",
+        tools=[{"type": "action", "id": create_workspace_with_authentication["id"]}],
         model="gpt-3.5-turbo-1106",
     )
-    print(assistant, end="\n\n")
+    logging.info("=====> : %s\n", assistant)
 
     thread = client.beta.threads.create()
-    print(thread, end="\n\n")
+    logging.info("=====> : %s\n", thread)
 
     message = client.beta.threads.messages.create(
         thread_id=thread.id,
         role="user",
-        content="在组织63db49f7dcc8bf7b0990903c下,创建一个随机名字的工作空间",
+        content="在组织 63db49f7dcc8bf7b0990903c 下, 创建一个随机名字的工作空间",
     )
-    print(message, end="\n\n")
+    logging.info("=====> : %s\n", message)
 
+    # create a run with auth info
     run = client.beta.threads.runs.create(
-        # model="gpt-3.5-turbo-1106",
         thread_id=thread.id,
         assistant_id=assistant.id,
         instructions="",
         extra_body={
             "extra_body": {
                 "action_authentications": {
-                    create_workspace_with_authentication.id: {
+                    create_workspace_with_authentication["id"]: {
+                        # auth info, change as needed
                         "type": "bearer",
-                        "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2M2RiNDlhY2RjYzhiZjdiMDk5MDhmZDYiLCJhdWQiOiI2M2RiNDlmN2RjYzhiZjdiMDk5MDkwM2MiLCJ1aWQiOiI2M2RiNDlhY2RjYzhiZjdiMDk5MDhmZDYiLCJpYXQiOjE3MTAxNDkxODcsImV4cCI6MTcxMDIzNTU4N30.h96cKhB8rPGKM2PEq6bg4k2j09gR82HCJHUws232Oe4",
+                        "secret": "xxx",
                     }
                 }
             }
         },
     )
-    print(run, end="\n\n")
+    logging.info("=====> : %s\n", run)
 
     while True:
-        # run = client.beta.threads.runs.retrieve(thread_id=thread.id, run_id=run.id)
         run = client.beta.threads.runs.retrieve(thread_id=thread.id, run_id=run.id)
         if run.status == "completed":
-            print("done!", end="\n\n")
             messages = client.beta.threads.messages.list(thread_id=thread.id)
 
-            print("messages: ")
+            logging.info("=====> messages:")
             for message in messages:
                 assert message.content[0].type == "text"
-                print(messages)
-                print({"role": message.role, "message": message.content[0].text.value})
-
+                logging.info("%s", {"role": message.role, "message": message.content[0].text.value})
+            break
+        elif run.status == "failed":
+            logging.error("run failed %s\n", run.last_error)
             break
         else:
-            print("\nin progress...")
-            time.sleep(1)
+            logging.info("in progress...\n")
+            time.sleep(5)

examples/action/__init__.py

@@ -0,0 +1,23 @@
+import logging
+
+from examples.prerun import client
+
+if __name__ == "__main__":
+    assistant = client.beta.assistants.create(
+        name="Assistant Demo",
+        instructions="you are a personal assistant, reply 'hello' to user",
+        model="gpt-3.5-turbo-1106",
+        extra_body={
+            "extra_body": {
+                "model_params": {
+                    "frequency_penalty": 0,
+                    "logit_bias": None,
+                    "max_tokens": 1024,
+                    "temperature": 1,
+                    "presence_penalty": 0,
+                    "top_p": 1,
+                }
+            }
+        },
+    )
+    logging.info("=====> : %s\n", assistant)

tests/run/run_with_auth_action_test.py renamed to examples/action/run_with_auth_action.py

@@ -0,0 +1,15 @@
+import logging
+
+from examples.prerun import client
+
+if __name__ == "__main__":
+    # support three types of memory: navie, zero, window
+    assistant = client.beta.assistants.create(
+        name="Assistant Demo",
+        instructions="you are a personal assistant, reply 'hello' to user",
+        model="gpt-3.5-turbo-1106",
+        metadata={"memory": {"type": "naive"}}
+        # metadata={"memory": {"type": "zero"}}
+        # metadata={"memory": {"type": "window", "window_size": 5}}
+    )
+    logging.info("=====> : %s\n", assistant)

examples/assistant/__init__.py

@@ -0,0 +1,10 @@
+import logging
+import openai
+
+logging.basicConfig(level=logging.INFO, format='%(levelname)s - %(message)s')
+
+# Use this client to run examples. 
+# If you have enabled authentication management, please set the 'api_key'. Otherwise, you can ignore this parameter.
+base_url = "http://localhost:8086/api/v1"
+api_key = "ml-xxx"
+client = openai.OpenAI(base_url=base_url, api_key=api_key)

examples/assistant/create_assistant_with_extra_body.py

@@ -0,0 +1,55 @@
+import time
+import logging
+
+from examples.prerun import client
+
+if __name__ == "__main__":
+
+    assistant = client.beta.assistants.create(
+        name="Assistant Demo",
+        instructions="you are a personal assistant, reply 'hello' to user",
+        model="gpt-3.5-turbo-1106",
+    )
+    logging.info("=====> : %s\n", assistant)
+
+    thread = client.beta.threads.create()
+    logging.info("=====> : %s\n", thread)
+
+    message = client.beta.threads.messages.create(
+        thread_id=thread.id,
+        role="user",
+        content="hello",
+    )
+    logging.info("=====> : %s\n", message)
+
+    run = client.beta.threads.runs.create(
+        thread_id=thread.id,
+        assistant_id=assistant.id,
+        instructions="",
+    )
+    logging.info("=====> : %s\n", run)
+
+    logging.info("checking assistant status. \n")
+    while True:
+        run = client.beta.threads.runs.retrieve(thread_id=thread.id, run_id=run.id)
+        run_steps = client.beta.threads.runs.steps.list(run_id=run.id, thread_id=thread.id).data
+        for run_step in run_steps:
+            logging.info("=====> : %s\n", run_step)
+
+        if run.status == "completed":
+            messages = client.beta.threads.messages.list(thread_id=thread.id)
+
+            logging.info("=====> messages:")
+            for message in messages:
+                assert message.content[0].type == "text"
+                logging.info("%s", {"role": message.role, "message": message.content[0].text.value})
+
+            # delete asst
+            client.beta.assistants.delete(assistant.id)
+            break
+        elif run.status == "failed":
+            logging.error("run failed %s\n", run.last_error)
+            break
+        else:
+            logging.info("in progress...\n")
+            time.sleep(5)