OpenAGI：用于创建 AI 代理的软件包

✈️ 入门指南

OpenAGI 用作代理创建工具包，用于为 AIOS 构建代理。 注意： 若要在 AIOS 中构建代理，请迁移到 Cerebrum，这是我们用于连接 AIOS 内核的最新 SDK。

安装

从 PyPI 安装

pip install pyopenagi

本地安装

git clone https://agiresearch/OpenAGI
cd OpenAGI
pip install -e .

使用方法

添加新代理

要添加新代理，首先需要在 pyopenagi/agents 文件夹下创建一个文件夹。 该文件夹应具有以下结构：

- pyopenagi/agents
  - 作者
    - 代理名称
      - agent.py # 代理执行逻辑的主要代码
      - config.json # 代理配置设置
      - meta_requirements.txt # 代理所需的依赖项

如果您希望在代理中使用 OpenAGI 提供的外部工具，可以按照 如何设置外部工具 中的说明进行操作。 如果您想为正在开发的代理添加新工具， 则需要在 此文件夹 中添加一个新的工具文件。

上传代理

如果您已经开发并测试了您的代理，并希望分享这些代理，可以使用以下命令上传：

python pyopenagi/agents/interact.py --mode upload --agent <作者名/代理名>

💡请注意，agent 参数必须与您本地存放代理的文件夹完全一致。

下载代理

如果您想查看其他人开发的其他代理的实现，可以使用以下命令：

python pyopenagi/agents/interact.py --mode download --agent <作者名/代理名>

🚀 贡献

有关如何贡献的详细信息，请参阅 CONTRIBUTE。如果您希望为代码库做出贡献，我们始终欢迎 问题 或 拉取请求！

🖋️ 研究

请查看我们的研究论文 OpenAGI：当 LLM 遇见领域专家 的 实现。

@article{openagi,
  title={OpenAGI: When LLM Meets Domain Experts},
  author={Ge, Yingqiang and Hua, Wenyue and Mei, Kai and Ji, Jianchao and Tan, Juntao and Xu, Shuyuan and Li, Zelong and Zhang, Yongfeng},
  journal={In Advances in Neural Information Processing Systems (NeurIPS)},
  year={2023}
}

🌍 OpenAGI 贡献者

🌟 星标历史

OpenAGI 快速上手指南

OpenAGI 是一个用于构建 AI Agent 的工具包，旨在为 AIOS 创建智能体。

注意：若需为最新的 AIOS 内核构建 Agent，请迁移至 Cerebrum SDK。本文档仅针对 OpenAGI 原有功能。

环境准备

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

• 操作系统：Linux, macOS 或 Windows
• Python 版本：建议 Python 3.8 及以上
• 前置依赖：
  • pip (Python 包管理工具)
  • git (版本控制工具)

安装步骤

您可以选择通过 PyPI 直接安装，或通过源码本地安装（推荐开发者使用）。

方式一：通过 PyPI 安装

pip install pyopenagi

(国内用户如遇下载缓慢，可添加清华源加速：pip install pyopenagi -i https://pypi.tuna.tsinghua.edu.cn/simple)

方式二：本地源码安装

git clone https://github.com/agiresearch/OpenAGI
cd OpenAGI
pip install -e .

(国内用户克隆仓库较慢时，可使用镜像：git clone https://gitee.com/mirrors/OpenAGI.git 需确认是否有同步镜像，否则建议使用代理加速 git 连接)

基本使用

1. 创建新 Agent

要在 OpenAGI 中添加一个新的 Agent，需在 pyopenagi/agents 目录下创建特定结构的文件夹。

目录结构示例： 假设作者名为 myname，Agent 名为 demo_agent：

- pyopenagi/agents
  - myname
    - demo_agent
      - agent.py            # Agent 核心执行逻辑代码
      - config.json         # Agent 配置文件
      - meta_requirements.txt # Agent 所需的依赖项

• 扩展工具：如需使用 OpenAGI 提供的外部工具，请参考 tools.md；如需自定义新工具，请在 pyopenagi/tools/ 目录下添加新文件。

2. 上传 Agent

当您开发并测试完 Agent 后，可将其上传至社区共享：

python pyopenagi/agents/interact.py --mode upload --agent myname/demo_agent

💡 注意：--agent 参数必须与本地创建的文件夹路径（作者名/Agent 名）完全一致。

3. 下载 Agent

您可以查看并下载其他开发者分享的 Agent 实现：

python pyopenagi/agents/interact.py --mode download --agent <author_name>/<agent_name>

将 <author_name>/<agent_name> 替换为您想要下载的 Agent 实际路径即可。