开源项目 `search_with_lepton` 使用教程

开源项目 search_with_lepton 使用教程

search_with_lepton项目地址:https://gitcode.com/gh_mirrors/se/search_with_lepton

1. 项目的目录结构及介绍

search_with_lepton 项目的目录结构如下：

search_with_lepton/
├── lepton_template/
├── web/
├── .gitignore
├── LICENSE
├── README.md
├── search_with_lepton.py

• lepton_template/: 包含项目的基础模板文件。
• web/: 包含项目的Web界面相关文件。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• LICENSE: 项目的许可证文件，采用Apache-2.0许可证。
• README.md: 项目的说明文档。
• search_with_lepton.py: 项目的启动文件。

2. 项目的启动文件介绍

项目的启动文件是 search_with_lepton.py。该文件负责启动搜索服务，并支持多种搜索引擎后端，如Bing、Google等。以下是启动文件的基本使用方法：

使用Bing搜索引擎

BACKEND=BING python search_with_lepton.py

使用Google搜索引擎（通过SearchApi）

export SEARCHAPI_API_KEY=YOUR_SEARCHAPI_API_KEY
BACKEND=SEARCHAPI python search_with_lepton.py

使用Google搜索引擎（通过Serper）

export SERPER_SEARCH_API_KEY=YOUR_SERPER_API_KEY
BACKEND=SERPER python search_with_lepton.py

使用Google搜索引擎（通过Programmable Search Engine）

export GOOGLE_SEARCH_API_KEY=YOUR_GOOGLE_SEARCH_API_KEY
export GOOGLE_SEARCH_CX=YOUR_GOOGLE_SEARCH_ENGINE_ID
BACKEND=GOOGLE python search_with_lepton.py

3. 项目的配置文件介绍

项目没有显式的配置文件，但可以通过环境变量进行配置。以下是一些常用的环境变量配置：

{
  "BACKEND": "LEPTON",
  "GOOGLE_SEARCH_CX": "",
  "LLM_MODEL": "mixtral-8x7b",
  "KV_NAME": "search-with-lepton",
  "RELATED_QUESTIONS": "true",
  "LEPTON_ENABLE_AUTH_BY_COOKIE": "true",
  "secret": [
    "BING_SEARCH_V7_SUBSCRIPTION_KEY"
  ]
}

• BACKEND: 指定使用的搜索引擎后端。
• GOOGLE_SEARCH_CX: 如果使用Google搜索引擎，指定搜索的CX。
• LLM_MODEL: 指定使用的LLM模型。
• KV_NAME: 指定存储搜索查询和结果的KV名称。
• RELATED_QUESTIONS: 是否生成相关问题。
• LEPTON_ENABLE_AUTH_BY_COOKIE: 是否允许Web访问。
• secret: 包含所需的API密钥等敏感信息。

以上是 search_with_lepton 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

search_with_lepton项目地址:https://gitcode.com/gh_mirrors/se/search_with_lepton