Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shadowfax92/Fyin
Open source alternative to Perplexity AI with ability to run locally
https://github.com/shadowfax92/Fyin
llm ollama openai rag rust
Last synced: 2 days ago
JSON representation
Open source alternative to Perplexity AI with ability to run locally
- Host: GitHub
- URL: https://github.com/shadowfax92/Fyin
- Owner: shadowfax92
- License: agpl-3.0
- Created: 2024-05-17T21:02:47.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-06T14:41:25.000Z (4 months ago)
- Last Synced: 2024-08-02T13:29:27.501Z (3 months ago)
- Topics: llm, ollama, openai, rag, rust
- Language: Rust
- Homepage: https://fyin.app/
- Size: 12.7 MB
- Stars: 101
- Watchers: 4
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fyin
> Open source alternative to Perplexity AI with ability to run locally.
## Motivation
This project aims to build a tool that can be run locally, is open-source, and delivers faster answers, serving as an alternative to Perplexity AI.
## Features
- [x] Run locally using ollama or use openai API
- [x] local VectorDB for fast search
- [x] very quick searching, scraping & answering due to parallelism
- [x] Configurable number of search results to parse
- [x] local scraping of websites
---
## Demo
[](https://www.youtube.com/watch?v=9tVGcPokgdo)
(You can watch the demo on YouTube too [here](https://www.youtube.com/watch?v=9tVGcPokgdo))
---
## Installation
1. Clone the repository - `git clone https://github.com/shadowfax92/fyin.app`
2. Get Bing API key or searxng URL or duckduckgo URL
3. Get OpenAI API key or [Ollama](https://ollama.com/)
4. Fill/setup the environment variables (see `sample.env` file, copy it to `.fyin.env` and fill the values))
5. `cargo run --query "" -n `
### Environment Variables
```
# Open AI config; Ollama config in comments
# OPENAI_API_KEY="ollama"
OPENAI_API_KEY="your-openai-api-key"
# OPENAI_BASE_URL=http://localhost:11434/v1
# Leave blank for default
OPENAI_BASE_URL=
BING_SUBSCRIPTION_KEY="your-bing-subscription-key"
# Leave blank for default
BING_ENDPOINT=
# EMBEDDING_MODEL_NAME="llama3"
EMBEDDING_MODEL_NAME="text-embedding-ada-002"
# CHAT_MODEL_NAME="llama3"
CHAT_MODEL_NAME="gpt-4o"
# Search engine config
SEARCH_ENGINE="bing" # Options: bing, searxng, duckduckgo
SEARXNG_ENDPOINT="your-searxng-endpoint"
DUCKDUCKGO_ENDPOINT="your-duckduckgo-endpoint"
```
### Docker
Here is how you can run the app using docker:
1. Build the docker image - `docker build -t fyin .`
2. Create environment file - `cp sample.env .env` and populate the values
3. Run the docker container
`docker run --rm --env-file .env fyin --query "" --search `
## Notes
- The app use Bing API for searching. You can get from [Active Bing API](https://www.microsoft.com/en-us/bing/apis/bing-web-search-api).
- You can get OpenAI API key form [OpenAI](https://openai.com/api/).
- [Ollama](https://www.ollama.com/) setup instructions here.
---
## TODO
- [ ] Simlar to perplexity.ai, use GPT to figure out 3-5 search queries based on prompt
- This should give better results as we are translating human query into search query.
- [ ] Build a simple website
- [ ] Hosted version of the app