Microsoft TaskWeaver项目快速入门指南

Microsoft TaskWeaver项目快速入门指南

TaskWeaver A code-first agent framework for seamlessly planning and executing data analytics tasks. 项目地址: https://gitcode.com/gh_mirrors/ta/TaskWeaver

什么是TaskWeaver

TaskWeaver是微软开发的一个AI助手框架，它通过模块化设计实现了任务规划、代码生成和执行的能力。作为一个开源项目，它允许开发者快速构建基于大语言模型的智能助手应用。

环境安装

准备工作

在开始使用TaskWeaver之前，需要确保系统满足以下条件：

• Python 3.10或更高版本
• pip包管理工具
• 可选：conda环境管理工具（推荐用于隔离依赖）

安装步骤

1. 创建隔离环境（推荐）

conda create -n taskweaver python=3.10
conda activate taskweaver

2. 获取项目代码

git clone https://github.com/microsoft/TaskWeaver.git
cd TaskWeaver

3. 安装依赖

pip install -r requirements.txt

项目目录结构

TaskWeaver采用项目目录的方式来管理配置、插件和会话数据。一个标准的项目目录结构如下：

📦project
 ┣ 📜taskweaver_config.json  # 主配置文件
 ┣ 📂plugins                 # 插件存放目录
 ┣ 📂logs                    # 日志目录（运行时自动生成）
 ┣ 📂examples                # 示例目录
    ┣ 📂 planner_examples    # 规划器示例
    ┗ 📂 code_generator_examples # 代码生成示例
 ┗ 📂workspace               # 工作空间（运行时自动生成）
    ┗ 📂 session_id          # 会话ID目录
      ┣ 📂ces                # 代码执行服务目录
      ┣ 📂cwd                # 代码运行工作目录
      ┗ 其他会话数据

配置OpenAI服务

TaskWeaver支持两种OpenAI服务配置方式：

Azure OpenAI配置

{
  "llm.api_base": "https://xxx.openai.azure.com/",
  "llm.api_key": "你的API密钥",
  "llm.api_type": "azure",
  "llm.api_version": "API版本号",
  "llm.model": "部署名称"  # 在Azure OpenAI中，模型名称对应部署名称
}

原生OpenAI配置

{
  "llm.api_key": "你的API密钥",
  "llm.model": "模型名称，如gpt-4"
}

重要提示：只有最新版OpenAI API支持json_object响应格式。如果使用旧版本，需要在配置中将"llm.response_format"设为null。

启动TaskWeaver

命令行启动

python -m taskweaver -p ./project/

成功启动后，你将看到如下欢迎界面：

=========================================================
 _____         _     _       __
|_   _|_ _ ___| | _ | |     / /__  ____ __   _____  _____
  | |/ _` / __| |/ /| | /| / / _ \/ __ `/ | / / _ \/ ___/
  | | (_| \__ \   < | |/ |/ /  __/ /_/ /| |/ /  __/ /
  |_|\__,_|___/_|\_\|__/|__/\___/\__,_/ |___/\___/_/
=========================================================
TaskWeaver: 我是TaskWeaver，一个AI助手。请告诉我您的需求？
Human: ___

其他启动方式

1. Web界面：TaskWeaver提供了基于Chainlit的实验性Web界面
2. Python库：可以作为Python库集成到你的应用中
3. Docker容器：官方提供了包含所有依赖的Docker镜像

使用建议

对于初次接触TaskWeaver的开发者，建议：

1. 先从命令行界面开始熟悉基本功能
2. 仔细阅读配置文件中的各项参数说明
3. 尝试修改示例插件来理解插件开发流程
4. 关注日志输出，了解系统运行机制

通过以上步骤，你可以快速上手TaskWeaver项目，并开始构建自己的AI助手应用。

TaskWeaver A code-first agent framework for seamlessly planning and executing data analytics tasks. 项目地址: https://gitcode.com/gh_mirrors/ta/TaskWeaver