开源项目使用教程：Local Deep Research

开源项目使用教程：Local Deep Research

local-deep-research Local Deep Research is an AI-powered assistant that transforms complex questions into comprehensive, cited reports by conducting iterative analysis using any LLM across diverse knowledge sources including academic databases, scientific repositories, web content, and private document collections. 项目地址: https://gitcode.com/gh_mirrors/lo/local-deep-research

1. 项目目录结构及介绍

Local Deep Research项目的目录结构如下：

local-deep-research/
├── .github/
├── docs/
├── examples/
├── installers/
│   └── windows/
├── src/
│   └── local_deep_research/
├── tests/
├── .cursorrules.template
├── .gitignore
├── Dockerfile
├── LICENSE
├── MANIFEST.in
├── README.md
├── docker-compose.yml
├── kill_servers.py
├── pyproject.toml
└── web1.png

• .github/：包含GitHub特有的配置文件。
• docs/：存放项目文档的文件夹。
• examples/：示例文件和项目案例。
• installers/：安装程序，包含Windows操作系统的安装器。
• src/：源代码文件夹，包含项目的核心代码。
• tests/：测试文件夹，包含项目的单元测试代码。
• .cursorrules.template：编辑器配置文件模板。
• .gitignore：定义在Git版本控制中需要忽略的文件和文件夹。
• Dockerfile：用于构建Docker镜像的文件。
• LICENSE：项目使用的许可协议文件。
• MANIFEST.in：指定在打包时包含的文件。
• README.md：项目的说明文件，通常包含项目描述、功能、安装和使用说明。
• docker-compose.yml：用于定义Docker多容器应用的配置文件。
• kill_servers.py：用于终止服务器的Python脚本。
• pyproject.toml：Python项目配置文件。
• web1.png：项目相关的图片文件。

2. 项目的启动文件介绍

项目的启动文件根据运行方式不同，主要有以下几种：

• ldr-web：启动项目Web界面的脚本。
• python -m local_deep_research.web.app：通过Python模块直接启动Web界面。
• ldr：命令行界面的启动脚本。
• python -m local_deep_research.main：通过Python模块直接启动命令行界面。

使用Web界面时，可在浏览器中访问 http://127.0.0.1:5000 来使用项目。

3. 项目的配置文件介绍

项目使用以下配置文件来管理不同的设置：

• settings.toml：通用设置，包括研究、Web界面和搜索的设置。
• llm_config.py：高级语言模型配置，通常不需要修改。
• search_engines.toml：定义和配置搜索引擎。
• local_collections.toml：配置本地文档集合，用于向量嵌入的搜索。
• .env：环境变量配置文件，用于存储API密钥等敏感信息。

在开始使用项目之前，建议检查和配置这些文件，以确保项目能够按预期工作。

local-deep-research Local Deep Research is an AI-powered assistant that transforms complex questions into comprehensive, cited reports by conducting iterative analysis using any LLM across diverse knowledge sources including academic databases, scientific repositories, web content, and private document collections. 项目地址: https://gitcode.com/gh_mirrors/lo/local-deep-research