安装

1. 初步要求

1.1 基本要求

  • Docker Compose

  • Python >= 3.10 （可选，如果你使用终端。）

1.2 配置 XAgent

  1. 您应该在 assets/config.yml 中配置 XAgent，然后再运行它。

  2. 至少提供一个 OpenAI 密钥在 assets/config.yml 中，用于访问 OpenAI API。 我们强烈建议使用 gpt-4-32k 来运行 XAgent； gpt-4 对于大多数简单任务也是可以的。 无论如何，至少应提供一个 gpt-3.5-turbo-16k API 密钥作为备份模型。 由于上下文长度极小，我们不建议使用 gpt-3.5-turbo 来运行 XAgent；您不应该尝试在此上运行 XAgent。

  3. 如果您想要更改 XAgentServer 的 config_file 路径，您应该修改 CONFIG_FILE 在 .env 文件中的值并重启 docker 容器。

1.3 构建和运行 ToolServer

ToolServer 是 XAgent 操作的地方。它是一个提供安全环境以供 XAgent 运行的 docker 容器。 （如果对配置进行了更改，以下命令也需要重新运行。）

docker-compose up --build

2. 使用 GUI 或终端运行 XAgent

通过GUI运行XAgent

## run nginx in docker
docker exec XAgent-Server systemctl start nginx

启动docker容器。 您将看到XAgent Server在端口8090上监听。 您可以访问http://localhost:5173通过使用web UI与XAgent进行交互。

通过终端运行XAgent

python -m venv .venv && source .venv/bin/activate ## Create virtual environment and activate it
pip install -r requirements.txt 
python run.py --task "put your task here" --model "gpt-4" --config_file "assets/config.yml"

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

  2. 您的 XAgent 的本地工作空间在 local_workspace，您可以在这里找到 XAgent 在运行过程中生成的所有文件。

  3. 执行后，整个 workspace 在 ToolServerNode 中将被复制到 running_records 以方便您使用。

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

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

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