跳转到主内容

开始使用

第 0 步 - 安装 Python 3.11 或更高版本。分步指南请见此处。

第 1 步 - 下载项目并进入其目录

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

第 3 步 - 设置 API 密钥，有两种方法：直接导出或将其存储在 .env 文件中。

对于 Linux/Windows 临时设置，请使用导出方法

export OPENAI_API_KEY={Your OpenAI API Key here}
export TAVILY_API_KEY={Your Tavily API Key here}

对于更持久的设置，请在当前的 gpt-researcher 目录下创建一个 .env 文件，并输入环境变量（不带 export）。

  • 对于 LLM 提供商，我们推荐 OpenAI GPT，但您也可以使用任何其他 LLM 模型（包括开源模型）。要了解如何更改 LLM 模型，请参阅文档页面。
  • 对于网络搜索 API，我们推荐 Tavily Search API，但您也可以通过在 config/config.py 中将搜索提供商更改为 duckduckgo、google、bing、searchapi、serper、searx 等来使用您选择的其他搜索 API。然后添加相应的环境变量 API 密钥。

快速入门​

第 1 步 - 安装依赖项

$ pip install -r requirements.txt

第 2 步 - 使用 FastAPI 运行代理

$ uvicorn main:app --reload

第 3 步 - 在任何浏览器中访问 https://:8000 并开始您的研究之旅！

使用虚拟环境或 Poetry​

根据您对每种工具的熟悉程度选择其一

虚拟环境​

建立具有激活/停用配置的虚拟环境​

使用 venv 包创建一个虚拟环境，环境名称为 <your_name>，例如 env。在 PowerShell/CMD 终端中执行以下命令

python -m venv env

要激活虚拟环境，请在 PowerShell/CMD 终端中使用以下激活脚本

.\env\Scripts\activate

要停用虚拟环境，请在 PowerShell/CMD 终端中运行以下停用脚本

deactivate

为虚拟环境安装依赖项​

激活 env 环境后，使用 requirements.txt 文件通过以下命令安装依赖项

python -m pip install -r requirements.txt

Poetry​

使用 Poetry 版本 ~1.7.1 建立 Poetry 依赖和虚拟环境​

安装项目依赖项，并同时为指定项目创建虚拟环境。执行此命令后，Poetry 会读取项目的“pyproject.toml”文件来确定所需的依赖项及其版本，从而确保一个一致且隔离的开发环境。虚拟环境可以清晰地分离项目特定的依赖项，防止与系统范围的包发生冲突，并使整个项目生命周期中的依赖管理更加简单。

poetry install

激活与 Poetry 项目关联的虚拟环境​

通过运行此命令，用户将进入与项目关联的隔离环境中的 shell 会话，为开发和执行提供一个专用的空间。该虚拟环境确保项目依赖被封装，避免与系统范围的包发生冲突。激活 Poetry shell 对于无缝地进行项目工作至关重要，因为它确保使用了正确版本的依赖项，并提供了一个有利于高效开发和测试的受控环境。

poetry shell

运行应用​

通过执行以下命令，在虚拟环境或 Poetry 设置中启动 FastAPI 应用程序代理

python -m uvicorn main:app --reload

在任何网页浏览器中访问 https://:8000 并开始您的研究！