论文 | 关键特性 | 安装 | 快速入门 | 示例 | 教程 | 基准测试

---

AgentLite 是一个面向研究的库，旨在构建和推进基于 LLM 的任务导向型智能体系统。它简化了新型智能体或多智能体架构的实现，通过管理智能体轻松编排多个智能体。无论您是在构建单个智能体还是复杂的多智能体系统，AgentLite 都能为您的研究与开发提供一个简单轻量级的基础。更多详情请参阅我们的论文。

🎉 新闻

• [04.2024] AgentLite 发布了UI 支持功能！
• [03.2024] xLAM 模型和xLAM 代码发布！您可以使用AgentLite 基准测试来体验，其性能可与 GPT-4 相媲美！
• [03.2024] 我们使用 AgentLite 实现了BOLAA中的所有智能体架构。请查看我们的新基准测试。
• [02.2024] AgentLite 库及论文首次发布！

🌟 关键特性

• 轻量级代码库：专为轻松实现新型智能体或多智能体架构而设计。
• 任务导向型 LLM 智能体：专注于构建针对特定任务的智能体，以提升其性能和能力。
• 面向研究的设计：是探索基于 LLM 的多智能体系统高级概念的理想工具。

🤖 框架

🛠️ 安装

要开始使用 AgentLite，请克隆仓库并运行以下命令安装软件包：

git clone https://github.com/SalesforceAIResearch/AgentLite.git
cd AgentLite
pip install -e .

请务必查看 requirements.txt 和 setup.py 中的依赖项和要求。

🚀 快速入门

要使用 AgentLite，首先设置 OpenAI API 密钥，然后运行其中一个示例脚本：

export OPENAI_API_KEY=<在此处插入您的 OpenAI API 密钥>
python ./example/SearchManager.py

🖥️ UI 支持

我们为演示目的在 AgentLite 中提供了一个简单的 UI 功能。要启用此功能，请取消注释 requirements.txt 中的 UI 相关部分，以安装 streamlit 包。 安装完成后，运行以下命令即可启动：

streamlit run app/Homepage.py

请查看我们的录制 UI 演示。

🔍 示例

构建单个智能体

通过提供特定的搜索动作，构建一个维基百科搜索智能体。完整源码请参阅 SearchAgent.py。

1. 定义智能体的动作

from agentlite.actions.BaseAction import BaseAction
from langchain_community.tools import WikipediaQueryRun

class WikipediaSearch(BaseAction):
    def __init__(self) -> None:
        action_name = "Wikipedia_Search" 
        action_desc = "使用此 API 搜索维基内容。" # LLM 使用 action_name 和 action_desc 来理解该动作
        params_doc = {"query": "搜索字符串，尽量简洁。"} # LLM 使用此 params_doc 来理解 self.__call__() 函数中的参数
        self.search = WikipediaQueryRun(api_wrapper=WikipediaAPIWrapper())
        super().__init__(
            action_name=action_name,
            action_desc=action_desc,
            params_doc=params_doc,
        )

    def __call__(self, query):
        return self.search.run(query)

2. 定义带有搜索动作的智能体

# 获取用于智能体的 LLM。如果您使用 OpenAI API，则应已在终端中导出 OPENAI_API_KEY=""。
llm_config_dict = {"llm_name": "gpt-3.5-turbo", "temperature": 0.9}
llm_config = LLMConfig(llm_config_dict)
llm = get_llm_backend(llm_config)
# 定义一个单个智能体
search_agent_info = {
    "name": "search_agent",
    "role": "你可以搜索维基百科获取信息。"
}
search_agent = BaseAgent(name=search_agent_info["name"], 
                         role=search_agent_info["role"], 
                         llm=llm, 
                         actions=[WikipediaSearch()], 
                         logger=agent_logger
                         )

3. 使用任务调用智能体

# 使用 TaskPackage 调用智能体
from agentlite.commons import TaskPackage
test_task = "微软公司成立于哪一年"
test_task_pack = TaskPackage(instruction=test_task)
response = search_agent(test_task_pack)
print("响应:", response)

构建多智能体系统

将不同的搜索智能体编排成一个多智能体系统。完整源码请参阅 simple_manager.py。

1. 定义单个智能体

# 定义两种不同类型的搜索智能体
## 获取 LLM 后端
from agentlite.llm.agent_llms import get_llm_backend
from agentlite.llm.LLMConfig import LLMConfig
llm_config_dict = {
    "llm_name": "gpt-3.5-turbo",
    "temperature": 0.9,
    "context_len": 4000,
}
llm_config = LLMConfig(llm_config_dict)
llm = get_llm_backend(llm_config)

## 获取个体智能体
from example.SearchAgent import WikiSearchAgent, DuckSearchAgent
wiki_search_agent = WikiSearchAgent(llm)
duck_search_agent = DuckSearchAgent(llm)

2. 定义管理智能体

from agentlite.agents import ManagerAgent
manager_agent_info = {
    "name": "search_manager",
    "role": "你负责控制 wiki_search_agent 和 duck_search_agent 完成搜索任务。你应该首先使用 wiki_search_agent 完成任务。如果它未能回答问题，请尝试让 duck_search_agent 来解答。最后，你需要整合两个智能体的回答，以最终完成任务。"
}
# 简单地通过信息和 TeamAgents 初始化管理智能体。
search_manager = ManagerAgent(llm, manager_agent_info["name"], 
                              manager_agent_info["role"],
                              TeamAgents=[wiki_search_agent, duck_search_agent])

3. 使用 TaskPackage 测试管理智能体

from agentlite.commons import TaskPackage
test_task = "Salesforce 因何而出名？"
test_task_pack = TaskPackage(instruction=test_task, task_creator="User")
response = search_manager(test_task_pack)
print(response)

在终端运行测试时，您将看到如下输出：

Agent search_manager 接收到以下 TaskPackage：
[
        任务 ID：6f6bffdd-1ba8-4f7c-b326-8f409865fef0
        指令：Salesforce 因何而出名？
]
====search_manager 开始执行任务 Package 6f6bffdd-1ba8-4f7c-b326-8f409865fef0====
Agent search_manager 执行第 0 步操作：
{
        名称：wiki_search_agent
        参数：{'任务': 'Salesforce 因何而出名？'}
}

📘 教程

• 构建搜索智能体
• 构建多智能体搜索系统
• 国际象棋游戏中的两个智能体
• 数学问题求解
• 交互式图像理解
• 多 LLM QA
• 搜索与绘画
• 哲学家对话

有关如何将 AgentLite 应用于您的研究或项目的详细示例和教程，请访问 教程目录。

🔬 基准测试

• HotpotQA
• 网上商店
• 工具查询
• 工具操作

引用

如果您觉得我们的论文或代码有用，请引用以下内容：

@misc{liu2024agentlite,
      title={AgentLite: 一个用于构建和推进面向任务的 LLM 智能体系统的轻量级库}, 
      author={刘志伟、姚伟然、张建国、杨良伟、刘祖鑫、谭俊涛、Prafulla K. Choubey、兰天、吴杰森、王欢、希利·海涅克、熊才明、西尔维奥·萨瓦雷斯},
      year={2024},
      eprint={2402.15538},
      archivePrefix={arXiv},
      primaryClass={cs.MA}
}

致谢

我们使用了 Langchain 中的一些优秀工具来构建示例以及实现 LLM 调用的库。

联系方式

如果您有任何问题或建议，请随时与我们联系。您可以提交问题或拉取请求，也可以发送邮件至 zhiweiliu@salesforce.com。

AgentLite 快速上手指南

AgentLite 是一个面向研究的轻量级库，旨在构建和推进基于大语言模型（LLM）的任务导向型智能体系统。它简化了新智能体或多智能体架构的实现，支持通过管理智能体轻松协调多个智能体。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• Python 版本：3.9 或更高版本
• 依赖项：
  • langchain 相关组件（安装时会自动处理）
  • 若需使用 OpenAI 模型，需准备有效的 OPENAI_API_KEY
• 网络建议：由于依赖 PyPI 和 GitHub，国内用户建议在安装时使用国内镜像源加速。

安装步骤

1. 克隆仓库 从 GitHub 获取源代码：

   git clone https://github.com/SalesforceAIResearch/AgentLite.git
   cd AgentLite
   

2. 安装依赖 推荐使用国内镜像源（如清华源）进行安装，以提升下载速度：

   pip install -e . -i https://pypi.tuna.tsinghua.edu.cn/simple
   

   注：如有特殊需求，请检查 requirements.txt 和 setup.py 中的具体依赖。

基本使用

以下是最简单的单智能体使用示例，演示如何构建一个维基百科搜索智能体。

1. 配置 API Key

在终端中设置您的 OpenAI API Key（如果使用其他后端请相应调整）：

export OPENAI_API_KEY=<INSERT YOUR OpenAI API KEY HERE>

2. 运行示例代码

AgentLite 提供了现成的示例脚本。您可以直接运行搜索管理示例来体验多智能体协作，或参考以下代码构建单个智能体。

直接运行官方示例：

python ./example/SearchManager.py

代码示例：构建并调用单个搜索智能体

如果您想通过代码自定义智能体，可以参考以下核心步骤：

from agentlite.actions.BaseAction import BaseAction
from agentlite.llm.agent_llms import get_llm_backend
from agentlite.llm.LLMConfig import LLMConfig
from agentlite.agents import BaseAgent
from agentlite.commons import TaskPackage
from langchain_community.tools import WikipediaQueryRun
from langchain.utilities import WikipediaAPIWrapper

# 1. 定义智能体的动作 (Action)
class WikipediaSearch(BaseAction):
    def __init__(self) -> None:
        action_name = "Wikipedia_Search" 
        action_desc = "Using this API to search Wiki content."
        params_doc = {"query": "the search string. be simple."}
        self.search = WikipediaQueryRun(api_wrapper=WikipediaAPIWrapper())
        super().__init__(
            action_name=action_name,
            action_desc=action_desc,
            params_doc=params_doc,
        )

    def __call__(self, query):
        return self.search.run(query)

# 2. 初始化 LLM 后端
llm_config_dict = {"llm_name": "gpt-3.5-turbo", "temperature": 0.9}
llm_config = LLMConfig(llm_config_dict)
llm = get_llm_backend(llm_config)

# 3. 定义智能体
search_agent_info = {
    "name": "search_agent",
    "role": "you can search wikipedia to get the information."
}
search_agent = BaseAgent(
    name=search_agent_info["name"], 
    role=search_agent_info["role"], 
    llm=llm, 
    actions=[WikipediaSearch()]
)

# 4. 下达任务并执行
test_task = "what is the found date of microsoft"
test_task_pack = TaskPackage(instruction=test_task)
response = search_agent(test_task_pack)
print("response:", response)

进阶：启动 UI 界面

AgentLite 还支持简单的 Streamlit UI 演示。如需体验，请先取消注释 requirements.txt 中的 streamlit 相关依赖并重新安装，然后运行：

streamlit run app/Homepage.py