https://github.com/plippe/faiss-web-service
A web service build on top of Facebook's Faiss
https://github.com/plippe/faiss-web-service
faiss
Last synced: 7 months ago
JSON representation
A web service build on top of Facebook's Faiss
- Host: GitHub
- URL: https://github.com/plippe/faiss-web-service
- Owner: plippe
- License: unlicense
- Created: 2017-05-13T16:41:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T20:27:34.000Z (over 2 years ago)
- Last Synced: 2025-01-17T23:44:00.041Z (9 months ago)
- Topics: faiss
- Language: OpenEdge ABL
- Homepage:
- Size: 41.9 MB
- Stars: 219
- Watchers: 10
- Forks: 79
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Faiss Web Service
### Getting started
The fastest way to get started is to use [the docker hub image](https://hub.docker.com/r/plippe/faiss-web-service/) with the following command:
```sh
docker run --rm -it -p 5000:5000 plippe/faiss-web-service:[FAISS_RELEASE]
```
Once the container is running, you should be able to ping the service:
```sh
# Healthcheck
curl 'localhost:5000/ping'
# Faiss search for ids 1, 2, and 3
curl 'localhost:5000/faiss/search' -X POST -d '{"k": 5, "ids": [1, 2, 3]}'
# Faiss search for a vector
curl 'localhost:5000/faiss/search' -X POST -d '{"k": 5, "vectors": [[54.7, 0.3, 0.6, 0.4, 0.1, 0.7, 0.2, 0.0, 0.6, 0.5, 0.3, 0.2, 0.1, 0.9, 0.3, 0.6, 0.2, 0.9, 0.5, 0.0, 0.9, 0.1, 0.9, 0.1, 0.5, 0.5, 0.8, 0.8, 0.5, 0.2, 0.6, 0.2, 0.2, 0.7, 0.1, 0.7, 0.8, 0.2, 0.9, 0.0, 0.4, 0.4, 0.9, 0.0, 0.6, 0.4, 0.4, 0.6, 0.6, 0.2, 0.5, 0.0, 0.1, 0.6, 0.0, 0.0, 0.4, 0.7, 0.5, 0.7, 0.2, 0.5, 0.5, 0.7]]}'
```
### Custom index
By default, the faiss web service will use the files in the `resources` folder. Those can be overwritten by mounting new ones.
```sh
docker run \
--rm \
-it \
-p 5000:5000 \
-v [PATH_TO_RESOURCES]:/opt/faiss-web-service/resources \
plippe/faiss-web-service:[FAISS_RELEASE]
```
Another solution would be to create a new docker image [from `plippe/faiss-web-service`](https://docs.docker.com/engine/reference/builder/#from), that [adds your resources](https://docs.docker.com/engine/reference/builder/#add).
### Production
The application runs with Flask's build in server. Flask's documentation clearly states [it is not suitable for production](http://flask.pocoo.org/docs/1.1.x/deploying/).