法式蝴蝶面

开源的AI驱动搜索引擎。（Perplexity 克隆版）

可运行本地大模型（llama3、gemma、mistral、phi3），通过 LiteLLM 使用自定义大模型，或使用云端模型（Groq/Llama3、OpenAI/gpt4-o）。

https://github.com/rashadphz/farfalle/assets/20783686/9527a8c9-a13b-4e53-9cda-a3ab28d671b2

如有任何问题，欢迎随时通过 Twitter 联系我，或在 GitHub 上提交 issue。

💻 在线演示

farfalle.dev（仅限云端模型）

📖 概述

• 🛠️ 技术栈
• 🏃🏿‍♂️ 快速开始
• 🚀 部署

🛣️ 路线图

• 通过 Ollama 添加对本地大模型的支持
• 完成 Docker 部署配置
• 添加对 searxng 的支持，无需外部依赖。
• 创建预构建的 Docker 镜像
• 通过 LiteLLM 支持自定义大模型
• 对话历史记录
• 专家搜索
• 与本地文件进行对话

🛠️ 技术栈

• 前端：Next.js
• 后端：FastAPI
• 搜索 API：SearXNG、Tavily、Serper、Bing
• 日志记录：Logfire
• 限流：Redis
• 组件库：shadcn/ui

特性

• 支持多搜索引擎（Tavily、Searxng、Serper、Bing）
• 可使用云端模型回答问题（OpenAI/gpt4-o、OpenAI/gpt3.5-turbo、Groq/Llama3）
• 可使用本地模型回答问题（llama3、mistral、gemma、phi3）
• 可通过 LiteLLM 使用任何自定义大模型回答问题
• 使用智能代理规划并执行搜索，以获得更优结果

🏃🏿‍♂️ 本地快速开始

前提条件

• Docker
• Ollama（若运行本地模型）
  • 下载任意支持的模型：llama3、mistral、gemma、phi3
  • 启动 Ollama 服务：ollama serve

获取 API 密钥

• Tavily（可选）
• Serper（可选）
• OpenAI（可选）
• Bing（可选）
• Groq（可选）

快速启动：

git clone https://github.com/rashadphz/farfalle.git
cd farfalle && cp .env-template .env

根据需要修改 .env 文件中的 API 密钥（可选，若使用 Ollama 则无需填写）。

启动应用：

docker-compose -f docker-compose.dev.yaml up -d

等待应用启动后，访问 http://localhost:3000。

如需自定义设置说明，请参阅 custom-setup-instructions.md。

🚀 部署

后端

后端部署完成后，将 Web 服务 URL 复制到剪贴板。URL 格式大致如下：https://some-service-name.onrender.com。

前端

在使用 Vercel 部署时，将复制的后端 URL 填入 NEXT_PUBLIC_API_URL 环境变量中。

这样就完成了！🥳

将 Farfalle 用作默认搜索引擎

要将 Farfalle 设置为默认搜索引擎，请按照以下步骤操作：

1. 打开浏览器的设置页面
2. 进入“搜索引擎”选项
3. 使用此 URL 创建一个新的搜索引擎条目：http://localhost:3000/?q=%s。
4. 保存并添加该搜索引擎。

Farfalle 快速上手指南

Farfalle 是一款开源的 AI 驱动搜索引擎（Perplexity 克隆版），支持本地运行大模型（如 Llama3、Mistral 等）或连接云端模型，具备多源搜索、专家模式及对话历史等功能。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux / macOS / Windows (需安装 WSL2 或 Docker Desktop)
• 核心依赖：
  • Docker 及 Docker Compose
  • Ollama（仅当您需要运行本地模型时必需）
• 本地模型（可选）： 若使用本地推理，请先通过 Ollama 下载支持的模型：

  ollama pull llama3
  # 或者
  ollama pull mistral
  ollama pull gemma
  ollama pull phi3
  

  启动 Ollama 服务：

  ollama serve
  

• API Keys（可选）： 若不使用本地模型，需准备以下任一服务的密钥（在 .env 文件中配置）：
  • 搜索源：Tavily, Serper, Bing
  • 大模型：OpenAI, Groq

安装步骤

1. 克隆项目代码

   git clone https://github.com/rashadphz/farfalle.git
   cd farfalle
   

2. 配置环境变量 复制环境变量模板文件：

   cp .env-template .env
   

   • 仅使用本地模型：通常无需修改 .env 文件。
   • 使用云端模型：请使用文本编辑器打开 .env 文件，填入您申请的 API Keys。

3. 启动服务 使用 Docker Compose 启动应用：

   docker-compose -f docker-compose.dev.yaml up -d
   

4. 访问应用 等待容器启动完成后，在浏览器中访问： http://localhost:3000

基本使用

启动成功后，您将看到类似 Perplexity 的搜索界面。

1. 发起搜索： 在输入框中输入自然语言问题（例如："2024 年最新的 AI 发展趋势是什么？”）。
2. 选择模式：
   • 默认模式下，系统将自动调用配置的搜索源（如 SearXNG、Tavily 等）检索信息，并结合选定的 LLM（本地或云端）生成带引用的回答。
   • 可开启 "Expert Search"（专家搜索）模式，让 Agent 规划更复杂的搜索路径以获取更深度的结果。
3. 切换模型： 在设置或对话框中，您可以随时切换后端使用的模型（如从 gpt-4o 切换到本地的 llama3）。

提示：若需将 Farfalle 设为浏览器默认搜索引擎，可在浏览器设置的“搜索引擎”管理中，添加新条目，URL 格式为：http://localhost:3000/?q=%s。