RestGPT

让大语言模型通过 REST API 完成电影与音乐应用任务。

Star 数
★ 1.4k
最近更新
2 年前
License
MIT
主语言
Python

30 秒速览

运行形态
命令行工具
可在哪里用
平台专用OpenAI API
费用
软件免费,模型调用费用自付
上手难度
中 · 需要几步配置
开始前需要
langchaincoloramatiktokenspotipyopenaiShell / 命令行网络访问本地文件系统
典型场景
研究人员在 TMDB 场景评估多步 API 规划时,可运行 RestBench-TMDB 的 100 条人工标注指令及其解题路径。
不适合
  • 只想接入自有 REST API 的开发者,仓库仅提供 TMDB 与 Spotify 场景
  • 不愿承担 Spotify 数据被清空风险的团队,初始化脚本会删除全部数据
维护状态
超过半年没有提交最近提交 2024-06-07

这个 Agent 能做什么,适合哪些场景?

RestGPT 是论文《RestGPT: Connecting Large Language Models with Real-World RESTful APIs》的代码实现,用于让大语言模型控制真实应用。它采用迭代式、由粗到细的在线规划框架,并通过执行器调用 RESTful API。系统由 Planner、API selector 和 Executor 组成;Executor 进一步包含 Caller 与 Parser,后者会根据响应 schema 生成 Python 解析代码。仓库提供 TMDB 电影数据库和 Spotify 音乐播放器场景,并以命令行脚本运行;README 未说明长期运行服务、Web 界面或托管部署方式。

用户运行 python run.py 后输入 TMDB 或 Spotify 场景及自然语言指令。Planner 为当前步骤生成自然语言子任务,API selector 将其映射为更细的 API 调用计划;Executor 执行计划。Caller 依据 API 计划和 API 文档组织参数,Parser 依据响应 schema 生成 Python 代码来解析 API 响应。批量评测可用 python run_tmdb.py 顺序执行 RestBench-TMDB 指令;python run_spotify.py 用于 RestBench-Spotify,但执行前需手动修改 query_idx,并在设备上打开 Spotify。

  1. 研究人员在 TMDB 场景评估多步 API 规划时,可运行 RestBench-TMDB 的 100 条人工标注指令及其解题路径。
  2. 开发者需要把“查询今日最热门电影的导演”拆解为趋势查询与影片演职员查询时,可参考 TMDB 示例流程。
  3. Spotify 用户需要创建名为 “Love Mariah” 且包含三首 Mariah Carey 歌曲的播放列表时,可使用仓库展示的搜索、获取用户、创建播放列表和添加曲目的流程。
  4. 研究团队想研究自然语言子任务、API 选择、参数组织和响应解析如何串成 REST 调用链时,可使用该仓库的模块化框架。
  5. 需要对 TMDB 与 Spotify 两个真实场景的不同 API 路径长度进行比较时,可使用 RestBench 提供的统计和金标路径。

安装与配置要点

摘自下方的安装和使用说明,以项目 README 的最新说明为准。

安装 / 启动命令
  • pip install langchain colorama tiktoken spotipy openai
配置文件
config.yaml

如何安装或部署这个 Agent?

安装已列出的依赖:pip install langchain colorama tiktoken spotipy openai。创建日志目录:mkdir logs。从 OpenAI 获取 OpenAI key,从 TMDB 和 Spotify 开发者文档获取相应密钥,并将自己的密钥填入 config.yaml;README 未提供 config.yaml 的字段格式或 Python 版本要求。

如何使用这个 Agent?

完成密钥配置后,运行 python run.py,然后输入场景(TMDB/Spotify)和指令。批量运行 TMDB 基准使用 python run_tmdb.py;运行 Spotify 基准使用 python run_spotify.py,并先手动修改 query_idx、在设备上打开 Spotify。可选的 python init_spotify.py 会移除 Spotify 中的所有数据,只有在明确需要初始化环境时才应运行。

这个 Agent 有哪些优点和局限?

优点
  • 将规划、API 选择、参数构造和响应解析拆分为明确模块,而不是只展示单次 API 调用。
  • RestBench 覆盖 TMDB 和 Spotify 两个真实场景,并提供人工标注的金标解题路径。
  • Parser 明确以响应 schema 为依据生成 Python 解析代码,覆盖了 REST 调用后的响应处理环节。
  • 仓库提供交互式入口及 TMDB、Spotify 两个批量运行脚本。
局限
  • 运行依赖 OpenAI key,且 README 只列出 OpenAI 作为模型凭证来源。
  • 可验证的场景仅为 TMDB 与 Spotify;没有文档说明如何接入其他 REST API 或应用。
  • Spotify 基准需要设备上打开 Spotify,并要求用户手动修改 query_idx。
  • init_spotify.py 会移除 Spotify 中的所有数据,初始化存在明显的数据风险。
  • README 未给出 config.yaml 的字段格式、Python 版本或服务化部署说明。

这个 Agent 与同类方案有什么区别?

与相关度最高的同类 agent 并排比较关键指标。

Agent 源码审查 形态 / 费用 Star 最近更新 主语言 完整支持的平台
RestGPT 当前 39 · 缺口较多 命令行工具免费 + 模型费 ★ 1.4k 2 年前 Python OpenAI API
Remembra Relay 83 · 表现良好 Agent 插件 / 技能免费版 + 付费版 ★ 17 10 天前 Python Claude Code
Genie 78 · 表现良好 命令行工具免费 + 模型费 ★ 354 1 天前 TypeScript Codex · Claude Code
Planning with Files 77 · 表现良好 Agent 插件 / 技能免费 ★ 28k 今天 Shell Codex · Claude Code

FollowAgents 如何评估这个 Agent?

FollowAgents 源码审查 · FARS-2.1
缺口较多
39/ 100 五分制 2.0 / 5
信任安全 8/29
可靠稳定 3/14
适用触发 8/18
规范维护 10/18
有效结果 6/13
证据核验 4/8
查看各维度的扣分理由
信任安全8 / 29 · 1.4/5

README说明需要OpenAI、TMDB和Spotify密钥,并要求用户将密钥填入config.yaml,能看出凭据来源和配置位置;但没有说明密钥保护、最小权限、数据流或外部调用的防护。Spotify初始化脚本被明确警告会删除所有Spotify数据,且未说明确认步骤或恢复方法,因此外部影响有提示但回滚不足。README提供论文引用和代码归属,来源归因较清楚;未见依赖安全证据。

可靠稳定3 / 14 · 1.1/5

README描述了规划器、API选择器、执行器及其子模块,并列出运行命令和基准脚本,提供了有限的操作线索;但缺少错误处理、故障消息、依赖版本或可用性保障信息。文档没有明显自相矛盾的说法,因此自洽性得部分分。

适用触发8 / 18 · 2.2/5

README明确列出TMDB电影数据库与Spotify音乐场景,并给出多步任务示例,场景说明较好。能力范围看起来集中于这两个场景,但没有明确边界或适用条件;运行要求只提到Python脚本和相关密钥,缺少环境细节。触发说明基本限于输入场景和指令。

规范维护10 / 18 · 2.8/5

README按简介、模块、数据、安装、运行和引用组织信息,并提供TMDB及Spotify示例和基准说明。安装仅列pip依赖、创建logs目录及配置密钥,未给版本或完整环境说明;FAQ与限制说明有限,虽标注演示仍在建设中。MIT许可证文本完整。更新记录只有2023年的发布条目和未完成演示提示,维护责任和后续更新路径不清楚。

有效结果6 / 13 · 2.3/5

文档提供了可读的模块概览、任务示例和启动命令,但没有展示运行输出或错误情况下的用户结果,因此输出可用性证据有限。将LLM与REST API规划及执行相连,并配有TMDB和Spotify基准,显示出明确的任务价值;不过文档没有成本、资源消耗或收益量化,成本效益只能部分判断。

证据核验4 / 8 · 2.5/5

README将架构、基准规模、示例路径和启动步骤具体化,并给出论文引用,主张有一定可追溯性。可见证据只有README和许可证,缺少代码、测试或配置材料交叉印证。文档报告了数据集统计和功能描述,但未将已验证事实与项目目标或主张清楚区分,因此可核验性不充分。

风险与缓解建议
  • 源码中未见:依赖安全审查安装前固定版本并做一次依赖扫描(如 npm audit、pip-audit);优先放在容器里运行。
  • 源码中未见:回滚或恢复路径运行前先备份,或在 git 分支、快照上操作,确保改动可以撤销。
  • README警告init_spotify.py会删除所有Spotify数据;执行前应核实其具体影响并确认可恢复性。
  • 配置说明要求提供多个服务密钥,但未说明密钥存储保护、权限范围或外部数据流;当前评分仅依据README和LICENSE样本。
证据充分度:低 评估于 2026年11月8日 审查版本 d99012860cb4
评估证据 README.mdLICENSE
查看完整评分方法 →
你是这个项目的维护者?把 FARS 徽章加到 README

徽章显示当前的评审分数和结论,点击回到本页。重新评审后约一小时内更新。

FARS

[![FARS 评测](https://followagents.com/badge/restgpt.svg?lang=zh)](https://followagents.com/zh/agents/restgpt)
<a href="https://followagents.com/zh/agents/restgpt"><img src="https://followagents.com/badge/restgpt.svg?lang=zh" alt="FARS 评测"></a>

常见问题

需要哪些凭证?
需要 OpenAI key、TMDB key 和 Spotify key,并填入 config.yaml。
它能操作哪些应用?
README 明确提供 TMDB 电影数据库和 Spotify 音乐播放器两个场景。
运行会产生哪些外部调用?
系统通过 Executor 调用 RESTful API;因此需要网络连接及相应服务的有效凭证。
Spotify 初始化安全吗?
不安全操作。README 警告 python init_spotify.py 会移除 Spotify 中的所有数据。
RestGPT 免费吗?
软件本身免费,但 RestGPT 要调用 AI 模型,模型的调用费用由你向模型服务商支付(也可以接本地模型)。
RestGPT 开源吗?
开源。源码在 GitHub(Yifan-Song793/RestGPT),许可证是 MIT。
RestGPT 还在维护吗?
GitHub 仓库自 2024-06-07 以来没有新提交,已超过半年。可能是项目已经完成,也可能已经停更,用之前建议先看看 issue 区。
RestGPT 是谁开发的?
RestGPT 由 GitHub 账号 Yifan-Song793 发布。FollowAgents 没有核实这个账号背后是哪个人或公司。
这页内容对你有帮助吗?
在 GitHub 查看 ↗ 安装 ↓

对比同类 Agent

用同一套 FARS 评审,横向比较这个 Agent 所属的短名单。

相关核心概念