English • 中文 • 日本語

教程 • 演示 • 博客 • 文档 • 引用

📖 简介

XAgent 是一个开源的、基于大型语言模型（LLM）的实验性自主智能体，能够自动解决各种任务。它被设计为一种通用型智能体，适用于广泛的场景。目前，XAgent 仍处于早期阶段，我们正不断努力改进和完善。

🏆 我们的目标是打造一个超级智能的智能体，能够解决任何给定的任务！

我们欢迎多种形式的合作，包括全职、兼职等职位。如果你对智能体领域的前沿技术感兴趣，并希望加入我们共同实现真正的自主智能体，请通过 xagentteam@gmail.com 联系我们。

XAgent

XAgent 具备以下特点：

• 自主性：XAgent 可以在无需人工干预的情况下自动完成各类任务。
• 安全性：XAgent 的运行环境经过严格设计，所有操作均在 Docker 容器内进行，确保安全可靠。尽管如此，仍请谨慎使用！
• 可扩展性：XAgent 设计灵活，易于扩展。你可以轻松添加新工具来增强其能力，甚至引入新的智能体！
• 图形界面：XAgent 提供友好的图形用户界面，方便用户与智能体交互。同时，也支持通过命令行与智能体进行互动。
• 人机协作：XAgent 能够与人类协同工作，共同完成任务。它不仅可以在执行过程中遵循你的指导，还能在遇到困难时主动寻求你的帮助。

XAgent 由三个核心组件构成：

• 🤖 分配器 负责动态实例化并分发任务给不同的智能体，使我们能够灵活地添加新智能体或提升现有智能体的能力。
• 🧐 计划器 负责生成和调整任务计划，将复杂任务拆解为子任务，并制定阶段性目标，从而实现逐步解决问题。
• 🦾 执行者 负责执行具体行动以达成目标并完成子任务。执行者会利用多种工具来解决子任务，同时也能够与人类协作完成任务。

🧰 ToolServer

ToolServer 是为 XAgent 提供强大且安全工具的服务器，它是一个 Docker 容器，为 XAgent 的运行提供了一个安全的环境。 目前，ToolServer 提供以下工具：

• 📝 文件编辑器：用于编写、读取和修改文件。
• 📘 Python 笔记本：提供交互式 Python 环境，可用于验证想法、绘制图表等。
• 🌏 网页浏览器：用于搜索和访问网页。
• 🖥️ Shell：提供 Bash shell 工具，可以执行任意 Shell 命令，甚至安装软件和部署服务。
• 🧩 Rapid API：允许从 Rapid API 平台获取并调用 API，为 XAgent 提供了丰富的功能支持。更多关于 Rapid API 集合的信息，请参阅 ToolBench。 此外，你还可以轻松向 ToolServer 添加新工具，进一步提升 XAgent 的能力。

✨ 快速入门

🛠️ 构建并设置 ToolServer

ToolServer 是 XAgent 执行任务的核心环境，它是一个 Docker 容器，为 XAgent 提供了安全可靠的运行空间。 因此，你需要先安装 docker 和 docker-compose。 接下来，按照以下任一方式构建 ToolServer 镜像：

从 Docker Hub 拉取镜像并启动容器：

docker compose up

从本地源码构建镜像并启动容器：

docker compose build
docker compose up

这将构建 ToolServer 的镜像并启动容器。若需在后台运行容器，请使用 docker compose up -d。 有关 ToolServer 的详细信息，请参阅 此处。

如果 ToolServer 发生更新，你需要重新拉取或重新构建镜像：

docker compose pull

或者

docker compose build

🎮 设置与运行 XAgent

在设置好 ToolServer 后，您可以开始运行 XAgent。

• 安装依赖（要求 Python >= 3.10）

pip install -r requirements.txt

• 配置 XAgent

1. 在运行 XAgent 之前，您需要在 assets/config.yml 中进行配置。
2. 至少需要在 assets/config.yml 中提供一个 OpenAI API 密钥，用于访问 OpenAI API。我们强烈推荐使用 gpt-4-32k 来运行 XAgent；对于大多数简单任务，gpt-4 也可以胜任。无论如何，至少应提供一个 gpt-3.5-turbo-16k 的 API 密钥作为备用模型。由于上下文长度有限，我们不测试也不建议使用 gpt-3.5-turbo 来运行 XAgent，因此请勿尝试使用该模型。
3. 如果您想更改 XAgentServer 的配置文件路径，应在 .env 文件中修改 CONFIG_FILE 的值，并重启 Docker 容器。

• 运行 XAgent

python run.py --task "将您的任务放在这里" --config-file "assets/config.yml"

1. 您可以使用 --upload-files 参数来选择要提交给 XAgent 的初始文件。

2. 您的 XAgent 本地工作区位于 local_workspace 目录下，您可以在其中找到 XAgent 在整个运行过程中生成的所有文件。

3. 执行完成后，ToolServerNode 中的整个 workspace 将被复制到 running_records 目录，方便您查阅。

4. 此外，在 running_records 目录中，您还可以找到所有中间步骤的信息，例如任务状态、大模型的输入输出对、使用的工具等。

5. 您可以通过加载记录来重现之前的运行过程，只需在配置中设置 record_dir 参数（默认为 Null）。记录是系统级别的保存，与 XAgent 的代码版本相关联。所有的运行配置、查询、代码执行状态（包括错误）以及服务器行为都会被记录下来。

6. 我们已从记录中移除所有敏感信息（包括 API 密钥），因此您可以安全地与他人分享这些记录。在不久的将来，我们将推出更细粒度的分享选项，突出人类在执行过程中的贡献。

• 使用 GUI 运行 XAgent 容器 XAgent-Server 已启动，并配备了 Nginx 和一个监听端口 5173 的 Web 服务器。您可以通过访问 http://localhost:5173 使用网页界面与 XAgent 交互。默认的用户名和密码分别为 guest 和 xagent。有关我们 GUI 演示的详细信息，请参阅 这里。

🎬 演示

在此，我们还展示了一些由 XAgent 解决任务的案例： 您可以在 XAgent 官方网站 上查看我们的实时演示。我们也在下方提供了视频演示及 XAgent 的使用展示：

案例 1. 数据分析：展示双循环机制的有效性

我们从一个帮助用户进行复杂数据分析的案例开始。用户向 XAgent 提交了一个名为 iris.zip 的文件，寻求数据分析方面的帮助。XAgent 迅速将任务分解为四个子任务：(1) 数据检查与理解，(2) 检查系统中是否安装了相关的数据分析库，(3) 编写数据处理和分析的代码，(4) 根据 Python 代码的执行结果编写分析报告。 以下是 XAgent 绘制的一张图表。

案例 2. 推荐：人机交互的新范式

凭借主动寻求人类帮助并协同解决问题的独特能力，XAgent 不断重新定义人机协作的边界。如下面的截图所示，一位用户希望 XAgent 帮助推荐一些适合朋友聚会的好餐厅，但未能提供具体细节。XAgent 意识到所提供的信息不足，于是使用了 AskForHumanHelp 工具，请求人工干预以获取用户偏好的地点、预算限制、饮食偏好和饮食禁忌。在获得这些宝贵信息后，XAgent 轻松生成了个性化的餐厅推荐，确保用户及其朋友们获得满意且贴心的用餐体验。

案例 3. 训练模型：一位精通工具的助手

XAgent 不仅能处理日常琐事，还能在复杂的任务中发挥重要作用，比如模型训练。这里我们展示了一个场景：用户希望分析电影评论，评估公众对特定电影的情感倾向。对此，XAgent 迅速开始行动，下载 IMDB 数据集来训练一个先进的 BERT 模型（见下图），充分利用深度学习的力量。借助这个训练好的 BERT 模型，XAgent 能够轻松应对电影评论中的各种细微差别，准确预测公众对不同电影的看法。

📊 评估

我们进行了人类偏好评估，以衡量 XAgent 的表现。我们准备了 超过 50 个现实世界中的复杂任务 用于评估，这些任务可分为五大类：搜索与报告、编码与开发、数据分析、数学以及生活助手。 我们将 XAgent 的结果与 AutoGPT 进行了比较，结果显示 XAgent 总体上优于 AutoGPT。 所有运行记录可参考 这里。

我们报告了 XAgent 在人类偏好方面相对于 AutoGPT 的显著提升。

我们还对 XAgent 进行了以下基准测试：

🖌️ 博客

我们的博客可在 这里 查看！

🌟 我们的贡献者

衷心感谢所有贡献者。正是你们的努力使这个项目不断成长和发展。无论大小，每一份贡献都弥足珍贵。

🌟 星标历史

引用

如果您觉得我们的仓库很有用，请考虑引用：

@misc{xagent2023,
      title={XAgent：用于解决复杂任务的自主智能体},
      author={XAgent 团队},
      year={2023},
}

XAgent 快速上手指南

XAgent 是一个开源的实验性大型语言模型（LLM）驱动的自主智能体，能够自动解决各种复杂任务。它具备自主性、安全性（基于 Docker 隔离）、可扩展性以及友好的人机协作界面。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：支持 Docker 的 Linux、macOS 或 Windows (WSL2)。
• Docker 环境：必须安装 docker 和 docker-compose。
• Python 版本：本地运行需安装 Python >= 3.10。
• API Key：需要至少一个 OpenAI API Key。
  • 推荐模型：gpt-4-32k（效果最佳）或 gpt-4。
  • 备用模型：必须配置至少一个 gpt-3.5-turbo-16k 作为备份。
  • 注意：不建议使用标准的 gpt-3.5-turbo，因其上下文长度限制可能导致运行失败。

安装步骤

1. 构建并启动 ToolServer

ToolServer 是 XAgent 执行任务的安全沙箱环境（Docker 容器）。

方法一：直接从 Docker Hub 拉取镜像（推荐）

docker compose up

方法二：从本地源码构建镜像

如果您需要修改底层环境或网络无法访问 Docker Hub，可使用此方法：

docker compose build
docker compose up

提示：若需在后台运行容器，请添加 -d 参数，例如 docker compose up -d。 若 ToolServer 有更新，请执行 docker compose pull 或 docker compose build 重新构建。

2. 配置 XAgent

在运行主程序前，需配置 API 密钥和模型参数。

1. 打开配置文件 assets/config.yml。
2. 填入您的 OpenAI API Key。
3. 确认模型设置：首选 gpt-4-32k，并确保备用了 gpt-3.5-turbo-16k。
4. （可选）如需修改配置文件路径，请编辑 .env 文件中的 CONFIG_FILE 变量并重启 Docker 容器。

3. 安装 Python 依赖

在项目根目录下安装所需的 Python 包：

pip install -r requirements.txt

国内加速建议：如遇下载缓慢，可使用清华源或阿里源： pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

命令行模式

使用以下命令启动 XAgent 并指派任务：

python run.py --task "put your task here" --config-file "assets/config.yml"

常用参数说明：

• --task: 您希望智能体完成的具体任务描述。
• --upload-files: 指定需要提交给 XAgent 处理的初始文件。

运行结果查看：

• 实时文件：生成的文件位于本地 local_workspace 目录。
• 完整记录：任务结束后，ToolServer 中的完整工作区会复制到 running_records 目录，包含所有中间步骤、LLM 输入输出对、工具调用记录及错误日志。
• 复现任务：可通过在配置文件中设置 record_dir 加载历史记录进行复现。

Web GUI 模式

XAgent 提供了友好的网页交互界面。

1. 确保 XAgent-Server 容器已启动。
2. 在浏览器中访问：http://localhost:5173
3. 默认登录凭证：
   • 用户名：guest
   • 密码：xagent

通过 Web 界面，您可以直观地观察智能体的思考过程、规划步骤以及与智能体进行实时协作。