深度研究助手项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00827/article/details/147058595

深度研究助手项目教程

deep-research An AI-powered research assistant that performs iterative, deep research on any topic by combining search engines, web scraping, and large language models. The goal of this repo is to provide the simplest implementation of a deep research agent - e.g. an agent that can refine its research direction overtime and deep dive into a topic. 项目地址: https://gitcode.com/gh_mirrors/deeprese/deep-research

1. 项目目录结构及介绍

深度研究助手项目的目录结构如下：

deep-research/
├── .env.example
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yml
├── package-lock.json
├── package.json
├── prettier.config.mjs
├── report.md
├── src/
│   ├── .env.example
│   ├── .gitignore
│   ├── Dockerfile
│   ├── LICENSE
│   ├── README.md
│   ├── docker-compose.yml
│   ├── package-lock.json
│   ├── package.json
│   ├── prettier.config.mjs
│   ├── report.md
│   └── tsconfig.json

主要文件和目录说明：

src/: 源代码目录，包含项目的所有源代码和配置文件。
.env.example: 环境变量配置示例文件。
.gitignore: Git忽略文件列表，用于指定Git应该忽略的文件和目录。
Dockerfile: Docker构建文件，用于创建项目的Docker镜像。
LICENSE: 项目许可证文件，本项目采用MIT许可证。
README.md: 项目自述文件，包含项目介绍和使用说明。
docker-compose.yml: Docker Compose配置文件，用于定义和运行多容器Docker应用程序。
package-lock.json: npm包锁定文件，用于锁定安装的依赖版本。
package.json: npm包配置文件，定义了项目的依赖和脚本。
prettier.config.mjs: Prettier配置文件，用于统一代码风格。
report.md: 报告文件，用于生成和保存研究结果的Markdown报告。

2. 项目的启动文件介绍

项目的启动主要是通过package.json中的脚本实现的。以下是package.json中的部分内容，它定义了启动项目的脚本：

"scripts": {
  "start": "node src/index.js",
  "docker": "docker run --rm -it -v $(pwd):/app deep-research npm start"
}

启动脚本说明：

start: 这个脚本用于在本地环境启动项目。它会运行node src/index.js命令，启动位于src目录下的index.js文件，这是项目的入口文件。
docker: 这个脚本用于在Docker容器中启动项目。它会运行Docker命令来启动一个包含项目文件的容器，并执行start脚本。

要启动项目，你可以在项目根目录下运行以下命令：

npm start

或者在Docker容器中运行：

npm run docker

3. 项目的配置文件介绍

项目的配置主要通过.env.example文件进行。.env.example文件是一个环境变量配置文件，它包含了一些必要的环境变量和它们的示例值。以下是.env.example文件的内容：

# Firecrawl API 配置
FIRECRAWL_KEY=your_firecrawl_key
# 如果使用自托管版本的Firecrawl，请设置以下变量
# FIRECRAWL_BASE_URL=http://localhost:3002

# OpenAI API 配置
OPENAI_KEY=your_openai_key
# 如果使用本地LLM，请注释掉 OPENAI_KEY 并取消注释以下行
# OPENAI_ENDPOINT=http://localhost:1234/v1
# OPENAI_MODEL=custom_model