AutoGen UI

[!IMPORTANT]
本仓库已更新，采用了基于最新 AutoGen 0.4x AgentChat API 的 AutoGen AgentChat 接口。此外，API 可能会发生变动，请留意未来可能出现的破坏性更新。

这是使用 AutoGen AgentChat API 构建 UI 界面的“Hello World”级示例。

该示例 UI 展示了如何使用 AutoGen AgentChat API 构建交互界面。其中 UI 基于 Next.js 构建，Web API 则使用 FastAPI 开发。

该应用的功能是什么？

• autogenui.manager - 提供了一个简单的 run 方法，它接收提示词（prompt）并从预定义的 agent team 返回响应。查看 agent team 的 JSON 配置文件，可以了解 Agent 是如何配置的，以及支持哪些类型的 Agent 等。请查阅 tutorial notebook 获取关于如何使用该类加载团队配置的示例。

• autogenui.web.app.py - 基于 FastAPI 的后端，提供了一个简单的 /generate 端点，该端点接收提示词并从预定义的 agent team 返回响应。

  • 创建一个 manager 来运行任务。
  • 将任务运行的结果以流式（streaming）方式传输给客户端 UI。

• frontend - 基于 Next.js 的前端，提供了一个简单的聊天界面，用于与后端进行交互。

接下来要做什么？

这个应用仅仅是一个起点。以下是一些扩展思路：

• 扩展 manager 以支持从 UI 端配置多个团队。
• 在数据库中存储和加载交互历史记录。
• 安全性 - 为应用添加身份验证（Authentication）和授权（Authorization）。

[!TIP] 提示 AutoGen Studio 正在基于 AgentChat API 进行重写，以解决上述大部分问题。可以查看该项目的实现，获取更完整的示例。

快速开始

请注意，运行应用前需要设置你的 OPENAI_API_KEY。

export OPENAI_API_KEY=

安装依赖。需要 Python 3.9+ 环境。可以通过 pip 从 pypi 安装：

pip install autogenui

或者从源码安装：

git clone git@github.com:victordibia/autogen-ui.git
cd autogenui
pip install -e .

运行 UI 服务器。

设置环境变量 OPENAI_API_KEY：

export OPENAI_API_KEY=

autogenui # 或者使用 --port 8081

在浏览器中打开 http://localhost:8081。

若需修改源码，请在前端源码目录中进行更改，并运行 npm run build 以重新构建前端。

开发

要在开发模式下运行应用，你需要分别运行后端和前端。

后端 - 支持热重载 (Hot-reload)

autogenui --reload

[!TIP] 提示 此 CLI 加载的 UI 是通过运行下方前端构建命令生成的预编译版本。这意味着如果你修改了前端代码，或者更改了后端运行的主机名或端口，则需要重新构建前端代码，更改才能在该命令中生效。

前端

cd frontend

安装依赖：

yarn install

在开发模式下运行 - 支持热重载：

在命令行设置 NEXT_PUBLIC_API_SERVER：

export NEXT_PUBLIC_API_SERVER=http://<your_backend_hostname>/api

或者在前端目录下创建一个 .env 文件，内容如下：

NEXT_PUBLIC_API_SERVER=http://<your_backend_hostname>/api

其中 your_backend_hostname 是 autogenui 运行的主机名，例如 localhost:8081。

yarn dev

(重新)构建：

构建前请确保已安装依赖并设置了 NEXT_PUBLIC_API_SERVER。

yarn build

开发路线图

本项目目前没有正式的开发路线图。它旨在作为一个简单的入门示例，帮助你开始使用 AutoGen AgentChat API。如需更完整的示例，请参考 AutoGen Studio 项目。

参考文献

• AutoGen Studio.

@inproceedings{dibia2024autogen,
  title={AutoGen Studio: A No-Code Developer Tool for Building and Debugging Multi-Agent Systems},
  author={Dibia, Victor and Chen, Jingya and Bansal, Gagan and Syed, Suff and Fourney, Adam and Zhu, Erkang and Wang, Chi and Amershi, Saleema},
  journal={EMNLP 2024},
  year={2024}
}

• AutoGen.

@inproceedings{wu2023autogen,
      title={AutoGen: Enabling Next-Gen LLM Applications via Multi-Agent Conversation Framework},
      author={Qingyun Wu and Gagan Bansal and Jieyu Zhang and Yiran Wu and Shaokun Zhang and Erkang Zhu and Beibin Li and Li Jiang and Xiaoyun Zhang and Chi Wang},
      year={2023},
      eprint={2308.08155},