L♾️pGPT

一个模块化的 Auto-GPT 框架

L♾️pGPT 是对流行的 Auto-GPT 项目的重新实现，将其改造成一个规范的 Python 包，并在设计时充分考虑了模块化和可扩展性。

🚀 特性 🚀

• “即插即用”的 API - 可扩展且模块化的“Python 式”框架，而不仅仅是一个命令行工具。可以轻松地从 Python 代码中添加新功能、集成和自定义智能体能力，无需繁琐的配置文件！
• 兼容 GPT-3.5 - 对于尚未拥有 GPT-4 访问权限的用户来说，效果比 Auto-GPT 更好！
• 最小化的提示开销 - 每个 token 都很重要。我们一直在努力以尽可能少的 token 数量获得最佳结果。
• 人机协作 - 通过人工反馈，能够对偏离轨道的智能体进行“纠正方向”。
• 完整状态序列化 - 从中断处继续；L♾️pGPT 可以将智能体的完整状态（包括记忆及其工具的状态）保存到文件或 Python 对象中。无需外部数据库或向量存储（但仍然支持它们）！

🧑‍💻 安装

从 PyPI 安装

📗 这会安装最新稳定版的 L♾️pGPT。对于大多数用户来说，这是推荐的方式：

pip install loopgpt

📕 下面两种方法会安装 L♾️pGPT 的最新开发版本。请注意，此版本可能不稳定：

从源码安装

pip install git+https://www.github.com/farizrahman4u/loopgpt.git@main

从源码安装（开发版）

git clone https://www.github.com/farizrahman4u/loopgpt.git
cd  loopgpt
pip install -e .

使用 Docker 从源码安装（开发版）

git clone https://www.github.com/farizrahman4u/loopgpt.git
cd  loopgpt
docker build -t loopgpt:local-dev .

🏎️ 开始使用

设置你的 OpenAI API 密钥 🔑

方法 1️⃣：通过 .env 文件

在当前工作目录（你打算运行 L♾️pGPT 的地方）创建一个 .env 文件，并添加以下内容：

OPENAI_API_KEY="<your-openai-api-key>"

🛑 重要 🛑

Windows 用户请确保在文件资源管理器中启用了“显示文件扩展名”选项。否则，文件可能会被命名为 .env.txt 而不是 .env。

方法 2️⃣：通过环境变量

将名为 OPENAI_API_KEY 的环境变量设置为你的 OpenAI API 密钥。

如何设置环境变量：

• Windows
• Linux
• Mac

创建一个新的 L♾️pGPT 智能体🕵️：

让我们在一个新的 Python 脚本中创建一个智能体。

from loopgpt.agent import Agent

agent = Agent()

L♾️pGPT 默认使用 gpt-3.5-turbo，此处显示的所有输出都是基于它生成的。如果使用 GPT-4 的用户可以将 model="gpt-4" 替换：

agent = Agent(model="gpt-4")

设置智能体的属性🕵️：

agent.name = "ResearchGPT"
agent.description = "一个用于研究和寻找最佳科技产品的 AI 助手"
agent.goals = [
    "在 Google 上搜索最佳耳机",
    "分析规格、价格和评论，找出前 5 名最佳耳机",
    "将前 5 名最佳耳机及其价格写入文件",
    "总结每款耳机的优缺点，并将其写入名为 'summary.txt' 的另一份文件中",
]

现在就可以开始了！让我们运行智能体的 CLI：

agent.cli()

将你的 Python 文件保存为 research_gpt.py 并运行：

python research_gpt.py

你可以通过输入“exit”来退出 CLI。

🔁 连续模式 🔁

如果将 continuous 设置为 True, 智能体会自动执行命令，而不会询问用户的许可。这可能导致无限循环，因此请谨慎使用！

agent.cli(continuous=True)

💻 仅命令行模式

你也可以直接从命令行运行 L♾️pGPT，而无需编写任何 Python 代码：

loopgpt run

运行 loopgpt --help 查看所有可用选项。

🐋 Docker 模式

你可以在前面提到的模式下使用 Docker 运行 L♾️pGPT：

# CLI 模式
docker run -i --rm loopgpt:local-dev loopgpt run

# 脚本模式示例
docker run -i --rm -v "$(pwd)/scripts:/scripts" loopgpt:local-dev python /scripts/myscript.py

⚒️ 添加自定义工具 ⚒️

L♾️pGPT 智能体自带一组内置工具，可用于执行各种基本任务，如网络搜索、文件系统操作等。你可以通过 print(agent.tools) 查看这些工具。

除了这些内置工具外，你还可以将自己的工具添加到智能体的工具箱中。

示例：WeatherGPT 🌦️

让我们创建 WeatherGPT，一个专注于天气的 AI 助手。

工具继承自 BaseTool，你只需编写文档字符串即可让工具正常运行！

from loopgpt.tools import BaseTool

class GetWeather(BaseTool):
    """快速获取指定城市的天气信息

    参数:
        city (str): 城市名称
    
    返回:
        dict: 该城市的天气报告
    """
    
    def run(self, city):
        ...

L♾️pGPT 会为你的工具分配一个默认 ID，但如果你愿意，也可以覆盖它：

class GetWeather(BaseTool):
    """快速获取指定城市的天气信息

    参数:
        city (str): 城市名称
    
    返回:
        dict: 该城市的天气报告
    """

    @property
    def id(self):
        return "get_weather_command"

接下来，让我们在 run 方法中定义工具的具体功能：

import requests

# 定义你的自定义工具
class GetWeather(BaseTool):
    """快速获取指定城市的天气信息

    参数:
        city (str): 城市名称
    
    返回:
        dict: 该城市的天气报告
    """
    
    def run(self, city):
        try:
            url = "https://wttr.in/{}?format=%l+%C+%h+%t+%w+%p+%P".format(city)
            data = requests.get(url).text.split(" ")
            keys = ("location", "condition", "humidity", "temperature", "wind", "precipitation", "pressure")
            data = dict(zip(keys, data))
            return data
        except Exception as e:
            return f"获取天气时发生错误：{e}。"

就是这样！你已经构建了自己的第一个自定义工具。让我们将其注册到一个新的智能体并运行它：

from loopgpt.tools import WriteToFile
import loopgpt

# 注册自定义工具类型

# 这里实际上并不需要，但在加载带有自定义工具的已保存代理时则需要。
loopgpt.tools.register_tool_type(GetWeather)

# 创建代理
agent = loopgpt.Agent(tools=[GetWeather, WriteToFile])
agent.name = "WeatherGPT"
agent.description = "一个告诉你天气的AI助手"
agent.goals = [
    "获取纽约和北京的天气",
    "给用户提供关于如何根据纽约和北京天气穿衣的建议",
    "将这些建议写入名为'dressing_tips.txt'的文件中"
]

# 运行代理的命令行界面
agent.cli()

让我们来看看WeatherGPT为我们写的dressing_tips.txt文件：

dressing_tips.txt

- 北京室外晴朗，气温为+10°C。建议穿一件薄外套和裤子。
- 纽约室外多云，气温为+11°C。建议穿一件薄外套、裤子，并带上雨伞。

🚢 航向修正

与Auto-GPT不同，当用户拒绝执行某个命令时，该代理并不会终止。相反，它会请求用户的反馈以调整其行动方向。

要修正代理的航向，只需拒绝执行并提供反馈即可：

代理已经更新了它的行动计划：

💾 保存和加载代理状态 💾

你可以将代理的状态保存到一个JSON文件中，方法如下：

agent.save("ResearchGPT.json")

这会保存代理的配置（模型、名称、描述等）以及其内部状态（对话状态、记忆、工具状态等）。你也可以通过在agent.save()中传入include_state=False来仅保存配置：

agent.save("ResearchGPT.json", include_state=False)

之后，你可以从上次停止的地方继续：

import loopgpt
agent = loopgpt.Agent.load("ResearchGPT.json")
agent.cli()

或者直接从命令行运行已保存的代理：

loopgpt run ResearchGPT.json

你还可以将代理状态转换为与JSON兼容的Python字典，而不是写入文件：

agent_config = agent.config()

如果只想获取配置而不包括内部状态，可以这样操作：

agent_config = agent.config(include_state=False)

要从配置重新加载代理，可以使用以下代码：

import loopgpt

agent = loopgpt.Agent.from_config(agent_config)

📋 需求

• Python 3.8+
• 一个OpenAI API密钥
• Google Chrome

可选需求

为了支持官方的Google搜索功能，你需要设置两个环境变量GOOGLE_API_KEY和CUSTOM_SEARCH_ENGINE_ID，以下是获取它们的方法：

1. 在Google开发者控制台上创建一个应用。
2. 使用Google自定义搜索创建你的自定义搜索引擎。
3. 自定义搜索引擎创建完成后，选择它并进入其详情页面。
   • 在“基本”部分，你会找到“搜索引擎ID”字段，这个值就是你要用于CUSTOM_SEARCH_ENGINE_ID环境变量的值。
   • 接下来，转到页面底部的“程序化访问”部分。
     • 创建一个“自定义搜索JSON API”。
     • 按照提示选择你在第1步中创建的应用程序，并在获得API密钥后将其填入GOOGLE_API_KEY环境变量中。

ℹ️ 如果这些环境变量不存在，L♾️pGPT将会回退到使用DuckDuckGo搜索。

💌 贡献

我们非常需要帮助！如果你愿意贡献，请开一个issue或PR。

🌳 社区

需要帮助吗？加入我们的Discord。

⭐ 星标历史 📈

LoopGPT 快速上手指南

LoopGPT 是一个模块化、可扩展的 Auto-GPT 框架 Python 实现。相比原版，它对 GPT-3.5 更友好，支持自定义工具、状态保存以及人工干预修正，且无需复杂的配置文件即可通过代码灵活扩展。

环境准备

在开始之前，请确保满足以下系统要求和前置依赖：

• 操作系统：Windows / Linux / macOS
• Python 版本：Python 3.8 或更高版本
• 必要依赖：
  • OpenAI API Key
  • Google Chrome 浏览器（部分功能依赖）
• 可选依赖（用于启用官方 Google 搜索）：
  • GOOGLE_API_KEY
  • CUSTOM_SEARCH_ENGINE_ID
  • 注：若未配置上述变量，LoopGPT 将自动降级使用 DuckDuckGo 进行搜索。

安装步骤

推荐使用 PyPI 安装最新稳定版。国内用户若遇到下载缓慢，可指定清华或阿里镜像源。

方法一：使用 pip 安装（推荐）

# 默认源安装
pip install loopgpt

# 国内加速安装（推荐中国开发者使用）
pip install loopgpt -i https://pypi.tuna.tsinghua.edu.cn/simple

方法二：从源码安装（开发版）

如需体验最新开发特性（可能不稳定），可从 GitHub 源码安装：

pip install git+https://www.github.com/farizrahman4u/loopgpt.git@main

或者克隆仓库进行本地开发：

git clone https://www.github.com/farizrahman4u/loopgpt.git
cd loopgpt
pip install -e .

基本使用

1. 配置 API Key

LoopGPT 需要访问 OpenAI 服务。你可以通过以下两种方式之一配置密钥：

方式 A：创建 .env 文件（推荐）

在当前工作目录下创建名为 .env 的文件（Windows 用户请注意不要存成 .env.txt），并写入：

OPENAI_API_KEY="<your-openai-api-key>"

方式 B：设置环境变量

在终端中设置 OPENAI_API_KEY 环境变量。

2. 创建并运行 Agent

创建一个 Python 脚本（例如 research_gpt.py），编写以下代码即可启动一个智能体：

from loopgpt.agent import Agent

# 初始化 Agent (默认使用 gpt-3.5-turbo，如需 GPT-4 可添加 model="gpt-4")
agent = Agent()

# 设置 Agent 属性
agent.name = "ResearchGPT"
agent.description = "an AI assistant that researches and finds the best tech products"
agent.goals = [
    "Search for the best headphones on Google",
    "Analyze specs, prices and reviews to find the top 5 best headphones",
    "Write the list of the top 5 best headphones and their prices to a file",
    "Summarize the pros and cons of each headphone and write it to a different file called 'summary.txt'",
]

# 启动命令行交互界面
agent.cli()

保存文件后，在终端运行：

python research_gpt.py

运行后，Agent 将在命令行中与你对话并执行任务。输入 exit 可退出。

3. 进阶模式

连续模式（慎用） 设置 continuous=True 后，Agent 执行命令前不再请求用户确认，可能导致无限循环：

agent.cli(continuous=True)

纯命令行模式 如果不写 Python 脚本，也可以直接通过命令行运行：

loopgpt run

状态保存与恢复 你可以随时保存 Agent 的完整状态（包括记忆和工具状态）以便稍后继续：

# 保存状态
agent.save("ResearchGPT.json")

# 加载状态并继续运行
import loopgpt
agent = loopgpt.Agent.load("ResearchGPT.json")
agent.cli()

或者直接通过命令行加载：

loopgpt run ResearchGPT.json