Open Deep Research 项目使用教程

Open Deep Research 项目使用教程

open_deep_research 项目地址: https://gitcode.com/gh_mirrors/op/open_deep_research

1. 项目目录结构及介绍

Open Deep Research 项目是一个开源研究助手，用于自动化研究和生成任何主题的可定制报告。项目的目录结构如下：

• examples/: 包含示例代码和Jupyter笔记本，用于展示如何使用Open Deep Research。
• src/open_deep_research/: 项目的主要代码库，包括环境配置文件、许可证、项目说明文件、Python项目配置文件等。
  • .env.example: 环境变量配置文件示例。
  • LICENSE: 项目使用的MIT许可证文件。
  • README.md: 项目说明文件。
  • langgraph.json: LangGraph配置文件。
  • pyproject.toml: Python项目配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过LangGraph服务来实现的。以下是启动项目的步骤：

• 安装LangGraph服务依赖。
• 启动LangGraph服务。

在Mac系统中，可以使用以下命令安装和启动服务：

# 安装uv包管理器
curl -LsSf https://astral.sh/uv/install.sh | sh
# 安装依赖并启动LangGraph服务
uvx --refresh --from "langgraph-cli[inmem]" --with-editable . --python 3.11 langgraph dev

在Windows或Linux系统中，可以使用以下命令安装依赖并启动服务：

# 安装依赖
pip install -e .
pip install -U "langgraph-cli[inmem]"
# 启动LangGraph服务
langgraph dev

启动服务后，可以使用以下URL访问不同的服务界面：

• API: http://127.0.0.1:2024
• Studio UI: https://smith.langchain.com/studio/?baseUrl=http://127.0.0.1:2024
• API 文档: http://127.0.0.1:2024/docs

3. 项目的配置文件介绍

项目的配置文件主要是.env文件，它用于设置环境变量，这些变量将控制模型选择、搜索工具和其他配置设置。以下是配置文件的示例：

# 设置API密钥
TAVILY_API_KEY=your_tavily_api_key
ANTHROPIC_API_KEY=your_anthropic_api_key
OPENAI_API_KEY=your_openai_api_key
PERPLEXITY_API_KEY=your_perplexity_api_key
EXA_API_KEY=your_exa_api_key
PUBMED_API_KEY=your_pubmed_api_key
PUBMED_EMAIL=your_email@example.com
LINKUP_API_KEY=your_linkup_api_key
GOOGLE_API_KEY=your_google_api_key
GOOGLE_CX=your_google_custom_search_engine_id

# 其他配置
planner_provider=anthropic
planner_model=claude-3-7-sonnet-latest
writer_provider=anthropic
writer_model=claude-3-5-sonnet-latest
search_api=tavily

在运行项目之前，需要根据实际情况设置.env文件中的API密钥和配置参数。可以通过复制.env.example到.env来开始配置：

cp .env.example .env

然后编辑.env文件，填入所需的API密钥和配置参数。项目将自动加载这些值。

open_deep_research 项目地址: https://gitcode.com/gh_mirrors/op/open_deep_research