以代码为中心的Agent框架：TaskWeaver 原理、框架与使用案例

unsetunsetTaskWeaver 介绍unsetunset

TaskWeaver 是一个以代码为中心的智能代理框架，用于无缝规划和执行数据分析任务。这个创新框架通过代码片段解释用户请求，并高效协调各种插件（以函数形式存在）来执行数据分析或工作流自动化任务。

1. 丰富的数据结构 - TaskWeaver 允许你在 Python 中使用丰富的数据结构，如列表、字典或 Pandas DataFrame，而不必限制在文本字符串上。
2. 自定义算法 - TaskWeaver 允许你将你自己的算法或函数封装成插件（以 Python 函数的形式），并协调它们来完成复杂任务。
3. 融入领域特定知识 - TaskWeaver 设计为易于融入领域特定知识，例如任务规划和代码生成方面的知识或经验，以提高任务执行的可靠性。
4. 有状态的对话 - TaskWeaver 设计为支持有状态的对话，这意味着你可以在多个聊天回合中与内存中的数据进行交互。
5. 代码验证 - TaskWeaver 设计为在执行前验证生成的代码。它可以检测生成代码中的潜在问题并自动修复它们。
6. 安全考虑 - TaskWeaver 支持在沙箱环境中运行代码，以防止恶意代码执行。它还提供基本的会话管理，以保持不同用户的数据分离。
7. 易于调试 - TaskWeaver 设计为易于调试。我们有详细的日志、指标和追踪，使用 OpenTelemetry 进行仪表化，帮助你理解简单聊天界面下发生了什么。
8. 易于扩展 - TaskWeaver 设计为易于扩展以完成更复杂的任务。除了插件之外，你可以创建额外的角色，定义它们如何与规划器交互，并协调它们来实现更复杂的任务。
9. 易于使用 - TaskWeaver 设计为易于使用。我们提供一套示例插件和教程，帮助你快速上手。我们还提供一站式 Docker 镜像，帮助你快速体验 TaskWeaver。

unsetunsetTaskWeaver 快速开始unsetunset

安装环境：

# clone the repository
git clone https://github.com/microsoft/TaskWeaver.git
cd TaskWeaver
# install the requirements
pip install -r requirements.txt

TaskWeaver 作为一个进程运行，需要创建一个项目目录来存储插件和配置文件：

📦project
 ┣ 📜taskweaver_config.json # the project configuration file for TaskWeaver
 ┣ 📂plugins # the folder to store plugins
 ┣ 📂planner_examples # the folder to store planner examples
 ┣ 📂codeinterpreter_examples # the folder to store code interpreter examples
 ┣ 📂logs # the folder to store logs, will be generated after program starts
 ┗ 📂workspace # the directory stores session data， will be generated after program starts
    ┗ 📂 session_id 
      ┣ 📂ces # the folder used by the code execution service
      ┣ 📂cwd # the current working directory to run the generated code
      ┗ other session data

unsetunsetTaskWeaver 代码执行模式unsetunset

https://microsoft.github.io/TaskWeaver/docs/code_execution

TaskWeaver 支持两种代码执行模式：local（本地）和 container（容器）。container 模式是默认模式。两种模式的关键区别在于。

container 模式在 Docker 容器内执行代码，为代码执行提供了更安全的环境，而 local 模式将代码作为 TaskWeaver 进程的子进程执行。

在 local 模式下，如果用户有恶意意图，他们可能会指示 TaskWeaver 在宿主机上执行有害代码。此外，LLM（大型语言模型）也可能生成有害代码，导致潜在的安全风险。

unsetunsetTaskWeaver 总体结构unsetunset

Taskweaver主要由两部分构成，Planer和Code Interpreter，其中Code Interpreter又由负责生成代码的Code Generator和负责执行代码的Code Executor构成。

从执行的流程上来看，可以大致划分为以下几个过程：

• 用户发出指令，Planer接收到用户的指令。
• Planer根据用户的指令，结合prompt中的例子，做出初始计划（init plan）。
• Planer将init plan转化为更加精简的最终计划（final plan），计划中的每一步可以看作是一个子任务。
• 逐步将计划中的每一步发送给Code Interpreter。
• Code Generator根据接收到的任务，从可用的插件里进行选择，并生成一段用于完成当前步骤的代码，发送给Code Executor。
• Code Executor执行代码，并将执行结果反馈给Planer。

unsetunsetTaskWeaver 核心概念unsetunset

Project

项目可以看作是taskweaver中最高层级的概念，每个项目会指定一个特定的目录，其中包含了指导planer的prompt和example，项目下的每个会话（Session）的日志，项目中可以使用的各类插件，以及使用的LLM相关的配置。

Session

会话是实际代码执行中比较高层级，独立且完整的概念了，各种角色、组件都是挂在具体的会话下，每次启动taskweaver，就视作是唤起了一次会话。

Memory

Memory相当于是对话历史plus，除了像一般的LLM项目中，将对话历史保存下来，memory还保留了Code Executor的执行结果，并且在保留记忆的时候，利用compression组件对对话的内容进行了总结。

Attachment

Attachment是在Post中，除了一般的文本信息之外，需要特殊被标记出来的附件，包括code，markdown，execution_result等，不同的角色通过判断特定的attachment的类型和其中的内容，来采取进一步的行动。

Plugin

插件是在代码生成过程中，提供给Code Generator的，用于完成某些相对复杂的任务。在提供插件的时候，需要提供两个文件，其一是py脚本，一旦插件被选中，脚本会被提供给Code Executor用于执行；其二是yaml文件，用于添加到Code Generator的prompt部分中，其中提供了该插件的介绍，使用例子，以及输入输出的类型等信息。

unsetunsetTaskWeaver 配置文件unsetunset

TaskWeaver 的配置文件位于 project/taskweaver_config.json，你可以编辑这个文件来配置 TaskWeaver 的各种设置。以下是配置文件中可用参数的概览：

unsetunsetTaskWeaver 使用案例unsetunset

本代码将使用 微软的 TaskWeaver 框架，并使用 GLM-4 模型来完成具有规划性的 Agent 任务。

修改project/taskweaver_config.json中的相关配置，按照官方文档 进行配置，即可使用 GLM-4 模型作为模型底座。

{
  "llm.api_base": "https://open.bigmodel.cn/api/paas/v4",
  "llm.api_key": "your keys",
  "llm.api_type": "zhipuai",
  "llm.model": "glm-4",
  "llm.embedding_model": "embedding-2",
  "llm.embedding_api_type": "zhipuai"
}

案例 1：获取机器用户名

   Human   ▶  获取当前机器的用户名，mac 机器，
 ╭───< Planner >
 ├─► [init_plan] 1. Use the os module to get the current username
 ├─► [plan] 1. Use the os module to get the current username
 ├─► [current_plan_step] 1. Use the os module to get the current username
 ├──● Please use the os module to get the current username of the MAC machine
 ├─► [board]
 │
 │   ====== Plan ======
 │   I have drawn up a plan:
 │   1. Use the os module to get the current username
 │   ==================
 │
 ╰──● sending message to CodeInterpreter
 ╭───< CodeInterpreter >
 ├─► [thought] I will use the os module to retrieve the current username of the MAC machine. I will make sure to directly import the required module without installing it. I will also ensure that I refer to
 │   intermediate variables from previous successful rounds and not refer to any failed rounds or previous conversations.
 ├─► [reply_type] python
 ├─► [reply_content]
 │   import os
 │
 │   # Get the current username
 │   username = os.getlogin()
 │
 │   username
 ├─► [verification] NONE
 ├─► [code_error] No code verification is performed.
 ├─► [execution_status] SUCCESS
 ├─► [execution_result]
 │   The execution of the generated python code above has succeeded
 │
 │   The result of above Python code after execution is:
 │   liufinlay
 ├─► [artifact_paths] []
 ├──● The following python code has been executed:
 │   ```python
 │   import os
 │
 │   # Get the current username
 │   username = os.getlogin()
 │
 │   username
 │   ```
 │
 │
 │   The execution of the generated python code above has succeeded
 │
 │   The result of above Python code after execution is:
 │   liufinlay
 ╰──● sending message to Planner
 ╭───< Planner >
 ├─► [init_plan] 1. Use the os module to get the current username
 ├─► [plan] 1. Use the os module to get the current username
 ├─► [current_plan_step] 1. Use the os module to get the current username
 ├─► [review]
 │   The Python code to get the current username has been executed successfully.
 │   The current username on the MAC machine is 'liufinlay'.
 ├──● The current username on the MAC machine is 'liufinlay'.
 ├─► [board]
 │
 │   ====== Plan ======
 │   I have drawn up a plan:
 │   1. Use the os module to get the current username
 │   ==================
 │
 ╰──● sending message to User
 TaskWeaver ▶  The current username on the MAC machine is 'liufinlay'.

案例 2：统计文件个数

   Human   ▶  统计 /Users/liufinlay/Downloads 下面的文件个数
 ╭───< Planner >
 ├─► [init_plan]
 │   1. Use the os module to list all files in the specified directory
 │   2. Count the number of files in the listed data <sequentially depends on 1>
 │   3. Check the execution result and report the file count to the user <interactively depends on 2>
 ├─► [plan]
 │   1. Instruct CodeInterpreter to list all files in the directory /Users/liufinlay/Downloads and count the number of files
 │   2. Check the execution result and report the file count to the user if it is correct
 ├─► [current_plan_step] 1. Instruct CodeInterpreter to list all files in the directory /Users/liufinlay/Downloads and count the number of files
 ├──● Please list all files in the directory /Users/liufinlay/Downloads and count the number of files
 ├─► [board]
 │
 │   ====== Plan ======
 │   I have drawn up a plan:
 │   1. Instruct CodeInterpreter to list all files in the directory /Users/liufinlay/Downloads and count the number of files
 │   2. Check the execution result and report the file count to the user if it is correct
 │   ==================
 │
 ╰──● sending message to CodeInterpreter
 ╭───< CodeInterpreter >
 ├─► [thought] I will use the os module to list all files in the directory /Users/liufinlay/Downloads and count the number of files. I will make sure to directly import the required module without installing it.
 │   I will also ensure that I refer to intermediate variables from previous successful rounds and not refer to any failed rounds or previous conversations.
 ├─► [reply_type] python
 ├─► [reply_content]
 │   import os
 │
 │   # List all files in the directory /Users/liufinlay/Downloads and count the number of files
 │   directory_path = '/Users/liufinlay/Downloads'
 │   file_count = len(os.listdir(directory_path))
 │   file_count
 ├─► [verification] NONE
 ├─► [code_error] No code verification is performed.
 ├─► [execution_status] SUCCESS
 ├─► [execution_result]
 │   The execution of the generated python code above has succeeded
 │
 │   The result of above Python code after execution is:
 │   277
 ├─► [artifact_paths] []
 ├──● The following python code has been executed:
 │   ```python
 │   import os
 │
 │   # List all files in the directory /Users/liufinlay/Downloads and count the number of files
 │   directory_path = '/Users/liufinlay/Downloads'
 │   file_count = len(os.listdir(directory_path))
 │   file_count
 │   ```
 │
 │
 │   The execution of the generated python code above has succeeded
 │
 │   The result of above Python code after execution is:
 │   277
 ╰──● sending message to Planner
 ╭───< Planner >
 ├─► [init_plan]
 │   1. Use the os module to list all files in the specified directory
 │   2. Count the number of files in the listed data <sequentially depends on 1>
 │   3. Check the execution result and report the file count to the user <interactively depends on 2>
 ├─► [plan]
 │   1. Instruct CodeInterpreter to list all files in the directory /Users/liufinlay/Downloads and count the number of files
 │   2. Check the execution result and report the file count to the user if it is correct
 ├─► [current_plan_step] 2. Check the execution result and report the file count to the user
 ├─► [review]
 │   The Python code to list all files in the directory /Users/liufinlay/Downloads and count the number of files has been executed successfully.
 │   There are 277 files in the directory.
 ├──● There are 277 files in the directory /Users/liufinlay/Downloads.
 ├─► [board]
 │
 │   ====== Plan ======
 │   I have drawn up a plan:
 │   1. Instruct CodeInterpreter to list all files in the directory /Users/liufinlay/Downloads and count the number of files
 │   2. Check the execution result and report the file count to the user if it is correct
 │   ==================
 │
 ╰──● sending message to User
 TaskWeaver ▶  There are 277 files in the directory /Users/liufinlay/Downloads.

与 36000+来自竞赛爱好者一起交流~