diff options
| author | Lain Soykaf <lain@lain.com> | 2024-05-19 13:04:27 +0400 |
|---|---|---|
| committer | Lain Soykaf <lain@lain.com> | 2024-05-19 13:04:27 +0400 |
| commit | 23881842ae33a294e344cef0cc2f1385ea6819f9 (patch) | |
| tree | e1d0ef3b7e6e5157c6c136153b0e7d97ee24ff5a /supplemental/search/fastembed-api/README.md | |
| parent | 8329ad521419119f89e3e2577269475190cfe921 (diff) | |
| download | pleroma-23881842ae33a294e344cef0cc2f1385ea6819f9.tar.gz pleroma-23881842ae33a294e344cef0cc2f1385ea6819f9.zip | |
B FastembedAPI: Add readme
Diffstat (limited to 'supplemental/search/fastembed-api/README.md')
| -rw-r--r-- | supplemental/search/fastembed-api/README.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/supplemental/search/fastembed-api/README.md b/supplemental/search/fastembed-api/README.md new file mode 100644 index 000000000..63a037207 --- /dev/null +++ b/supplemental/search/fastembed-api/README.md @@ -0,0 +1,6 @@ +# About +This is a minimal implementation of the [OpenAI Embeddings API](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings) meant to be used with the QdrantSearch backend. + +# Usage + +The easiest way to run it is to just use docker compose with `docker compose up`. This starts the server on the default configured port. Different models can be used, for a full list of supported models, check the [fastembed documentation](https://qdrant.github.io/fastembed/examples/Supported_Models/). The first time a model is requested it will be downloaded, which can take a few seconds. |