base on 🔍 AI search engine - self-host with local or cloud LLMs # Farfalle Open-source AI-powered search engine. (Perplexity Clone) Run local LLMs (**llama3**, **gemma**, **mistral**, **phi3**), custom LLMs through **LiteLLM**, or use cloud models (**Groq/Llama3**, **OpenAI/gpt4-o**) https://github.com/rashadphz/farfalle/assets/20783686/9527a8c9-a13b-4e53-9cda-a3ab28d671b2 Please feel free to contact me on [Twitter](https://twitter.com/rashadphz) or [create an issue](https://github.com/rashadphz/farfalle/issues/new) if you have any questions. ## 💻 Live Demo [farfalle.dev](https://farfalle.dev/) (Cloud models only) ## 📖 Overview - 🛠️ [Tech Stack](#%EF%B8%8F-tech-stack) - 🏃🏿‍♂️ [Getting Started](#%EF%B8%8F-getting-started) - 🚀 [Deploy](#-deploy) ## 🛣️ Roadmap - [x] Add support for local LLMs through Ollama - [x] Docker deployment setup - [x] Add support for [searxng](https://github.com/searxng/searxng). Eliminates the need for external dependencies. - [x] Create a pre-built Docker Image - [x] Add support for custom LLMs through LiteLLM - [x] Chat History - [x] Expert Search - [ ] Chat with local files ## 🛠️ Tech Stack - Frontend: [Next.js](https://nextjs.org/) - Backend: [FastAPI](https://fastapi.tiangolo.com/) - Search API: [SearXNG](https://github.com/searxng/searxng), [Tavily](https://tavily.com/), [Serper](https://serper.dev/), [Bing](https://www.microsoft.com/en-us/bing/apis/bing-web-search-api) - Logging: [Logfire](https://pydantic.dev/logfire) - Rate Limiting: [Redis](https://redis.io/) - Components: [shadcn/ui](https://ui.shadcn.com/) ## Features - Search with multiple search providers (Tavily, Searxng, Serper, Bing) - Answer questions with cloud models (OpenAI/gpt4-o, OpenAI/gpt3.5-turbo, Groq/Llama3) - Answer questions with local models (llama3, mistral, gemma, phi3) - Answer questions with any custom LLMs through [LiteLLM](https://litellm.vercel.app/docs/providers) - Search with an agent that plans and executes the search for better results ## 🏃🏿‍♂️ Getting Started Locally ### Prerequisites - [Docker](https://docs.docker.com/get-docker/) - [Ollama](https://ollama.com/download) (If running local models) - Download any of the supported models: **llama3**, **mistral**, **gemma**, **phi3** - Start ollama server `ollama serve` ### Get API Keys - [Tavily (Optional)](https://app.tavily.com/home) - [Serper (Optional)](https://serper.dev/dashboard) - [OpenAI (Optional)](https://platform.openai.com/api-keys) - [Bing (Optional)](https://www.microsoft.com/en-us/bing/apis/bing-web-search-api) - [Groq (Optional)](https://console.groq.com/keys) ### Quick Start: ``` git clone https://github.com/rashadphz/farfalle.git cd farfalle && cp .env-template .env ``` Modify .env with your API keys (Optional, not required if using Ollama) Start the app: ``` docker-compose -f docker-compose.dev.yaml up -d ``` Wait for the app to start then visit [http://localhost:3000](http://localhost:3000). For custom setup instructions, see [custom-setup-instructions.md](/custom-setup-instructions.md) ## 🚀 Deploy ### Backend [](https://render.com/deploy?repo=https://github.com/rashadphz/farfalle) After the backend is deployed, copy the web service URL to your clipboard. It should look something like: https://some-service-name.onrender.com. ### Frontend Use the copied backend URL in the `NEXT_PUBLIC_API_URL` environment variable when deploying with Vercel. [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Frashadphz%2Ffarfalle&env=NEXT_PUBLIC_API_URL&envDescription=URL%20for%20your%20backend%20application.%20For%20backends%20deployed%20with%20Render%2C%20the%20URL%20will%20look%20like%20this%3A%20https%3A%2F%2F%5Bsome-hostname%5D.onrender.com&root-directory=src%2Ffrontend) And you're done! 🥳 ## Use Farfalle as a Search Engine To use Farfalle as your default search engine, follow these steps: 1. Visit the settings of your browser 2. Go to 'Search Engines' 3. Create a new search engine entry using this URL: http://localhost:3000/?q=%s. 4. Add the search engine. ", Assign "at most 3 tags" to the expected json: {"id":"10262","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"