deep-searcher

环境要求

• Python 3.10（README 推荐版本）
• 已安装 git，可克隆 GitHub 仓库
• 已安装 uv（开发模式安装依赖时使用）
• 准备所选 LLM 提供方的 API Key（如 OPENAI_API_KEY）

安装与启动步骤

1. 1克隆仓库

   把 deep-searcher 源码拉到本地并进入项目目录，需已安装 git。

   git clone https://github.com/zilliztech/deep-searcher.git && cd deep-searcher

   复制

2. 2创建虚拟环境

   使用 pip 方式安装时，先用 Python 3.10 创建并激活虚拟环境。

   python -m venv .venv
   source .venv/bin/activate

   复制

3. 3uv 安装依赖

   开发模式推荐：安装 uv 后同步项目依赖，再激活生成的 .venv。

   uv sync
   source .venv/bin/activate

   复制

4. 4设置 API Key

   按所选模型把密钥写入环境变量，demo 默认识别 OPENAI_API_KEY。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

5. 5编写配置脚本

   指定 llm 与 embedding 提供方及模型名，再调用 init_config 完成初始化。

   from deepsearcher.configuration import Configuration, init_config
   from deepsearcher.online_query import query
   
   config = Configuration()
   config.set_provider_config("llm", "OpenAI", {"model": "o1-mini"})
   config.set_provider_config("embedding", "OpenAIEmbedding", {"model": "text-embedding-ada-002"})
   init_config(config=config)

   复制

6. 6安装可选依赖

   仅当使用 TogetherAI 或 Gemini 时才需补装对应包，其他提供方跳过此步。

   pip install together
   pip install google-genai

   复制

关键配置

如何确认成功

运行配置脚本无报错，导入 deepsearcher 与 init_config 成功即表示环境与密钥配置可用。

常见问题

注意事项

• README 推荐 Python 3.10，开发模式优先使用 uv 安装依赖。
• 密钥建议通过环境变量传入，不要硬编码进代码或提交到仓库。
• 切换到非 OpenAI 模型时，务必同时更换 llm 配置与对应的 API Key 环境变量。