gpt-researcher

环境要求

• Python 3.11 或更高版本
• 有效的 OpenAI API Key（或兼容 OpenAI 的自定义接口）
• 有效的 Tavily API Key（用于联网检索）
• 可选：Docker（使用 Docker 方式部署时需要）

安装与启动步骤

1. 1安装 Python 3.11+

   先确认本机已安装 Python 3.11 或更高版本，README 给出的官方指引见 tutorialsteacher 的 Python 安装教程。版本过低会导致依赖安装失败。

   python --version

   复制

2. 2克隆项目代码

   从 GitHub 拉取 gpt-researcher 仓库，并进入项目根目录，后续所有命令都在该目录下执行。

   git clone https://github.com/assafelovic/gpt-researcher.git
   cd gpt-researcher

   复制

3. 3配置 API 密钥

   通过 export 导出密钥，或把同样的键值写进项目根目录的 .env 文件。OpenAI 与 Tavily 两个 key 都需要设置。

   export OPENAI_API_KEY=sk-xxxxxxxx
   export TAVILY_API_KEY=tvly-xxxxxxxx

   复制

4. 4安装项目依赖

   在项目根目录执行 pip 安装 requirements.txt 中列出的全部依赖，首次安装耗时较长，请保持网络畅通。

   pip install -r requirements.txt

   复制

5. 5启动后端服务

   用 uvicorn 启动 main:app，--reload 会在代码变更时自动重载，适合开发调试；默认监听 8000 端口。

   python -m uvicorn main:app --reload

   复制

6. 6访问 Web 界面

   服务启动后，在浏览器中打开 http://localhost:8000 即可开始输入研究主题并生成报告。

7. 7Docker 方式启动

   备选方案：先把 .env.example 复制为 .env 并填入 API Key，再执行 docker-compose up --build，默认起 8000 与 3000 两个端口。

   docker-compose up --build

   复制

关键配置

如何确认成功

浏览器打开 http://localhost:8000 能看到 GPT Researcher 界面即启动成功；Docker 方式则访问 http://localhost:3000。

常见问题

注意事项

• 密钥既可以 export 到环境变量，也可以写入项目根目录的 .env 文件，两种方式二选一或并存都可。
• 使用 Docker 方式前必须先复制 .env.example 为 .env 并补充 API Key，否则容器内拿不到密钥。
• 除 pip 直接安装外，README 还提到可用 Poetry 或虚拟环境，详见官方 Getting Started 文档。
• README 中 pip 包示例代码片段不完整，未给出 report 的生成方法，实际用法请查阅官方文档。