Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/astrabert/praivatesearch
Own your AI, search the web with it🌐😎
https://github.com/astrabert/praivatesearch
ai docker gguf llamacpp llm local-search-engine open-source phi-3-mini streamlit web-search-engine
Last synced: 6 days ago
JSON representation
Own your AI, search the web with it🌐😎
- Host: GitHub
- URL: https://github.com/astrabert/praivatesearch
- Owner: AstraBert
- License: mit
- Created: 2024-07-27T18:55:36.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-14T10:59:01.000Z (22 days ago)
- Last Synced: 2025-01-23T17:11:52.951Z (13 days ago)
- Topics: ai, docker, gguf, llamacpp, llm, local-search-engine, open-source, phi-3-mini, streamlit, web-search-engine
- Language: Python
- Homepage: https://astrabert.github.io/PrAIvateSearch/
- Size: 3.56 MB
- Stars: 75
- Watchers: 1
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
PrAIvateSearch
Own your AI, search the web with it🌐😎
## About PrAIvateSearch
PrAIvateSearch is a NextJS web application that aims to implement similar features to SearchGPT, but in an open-source, local and private way.
## Flowchart
Flowchart for PrAIvateSearch
The process of creating and the functioning of PrAIvateSearch is explained in [this blog post on HuggingFace](https://huggingface.co/blog/as-cle-bert/search-the-web-with-ai).
## Installation and usage
> [!IMPORTANT]
> _For this section, you should have [`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) package manager, [`docker`](https://www.docker.com/) and [`docker compose`](https://docs.docker.com/compose/)._
1. Clone the repository:
```bash
git clone https://github.com/AstraBert/PrAIvateSearch.git
cd PrAIvateSearch
```
2. Move `.env.example` to `.env`...
```bash
mv .env.example .env
```
...and specify PostgreSQL related variables:
```bash
# .env file
pgql_db="postgres"
pgql_user="localhost"
pgql_psw="admin"
```
3. Install necessary dependencies with [`conda`](https://anaconda.org/anaconda/conda):
```bash
conda env create -f conda_environment.yaml
```
4. Set up Crawl4AI inside the `conda` environment:
```bash
conda activate praivatesearch
crawl4ai-setup
crawl4ai-doctor
conda deactivate
```
4. Start third-party services:
```bash
docker compose up -d
```
5. Run `Qwen-2.5-1.5B-Instruct` on API with FastAPI/Uvicorn:
```bash
conda activate praivatesearch
cd qwen-on-api/
uvicorn main:app --host 0.0.0.0 --port 8000
```
You can access the application from `http://localhost:3000` and chat with it!
### Usage note
> [!IMPORTANT]
> _The NextJS application was successfully developed and tested on a Ubuntu 22.04.3 machine, with 32GB RAM, 22 cores CPU and Nvidia GEFORCE RTX4050 GPU (6GB, cuda version 12.3), python version 3.11.11 (packaged by conda 24.11.0)_
Although being at a good stage of development, the application is a `beta` and might still contain bugs and have OS/hardware/python version incompatibilities.
## Contributions
Contributions are more than welcome! See [contribution guidelines](./CONTRIBUTING.md) for more information :)
## Funding
If you found this project useful, please consider to [fund it](https://github.com/sponsors/AstraBert) and make it grow: let's support open-source together!😊
## License and rights of usage
This project is provided under [MIT license](./LICENSE): it will always be open-source and free to use.
If you use this project, please cite the author: [Clelia (Astra) Bertelli](https://cleliasportfolio.xyz)