From 3daff6f1aa500935bb6a2c043e0e1906ddfb4153 Mon Sep 17 00:00:00 2001
From: mudler <mudler@mocaccino.org>
Date: Mon, 8 May 2023 20:02:59 +0200
Subject: [PATCH] doc: update README with embeddings docs

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 82cb9aa..20490df 100644
--- a/README.md
+++ b/README.md
@@ -529,6 +529,25 @@ curl http://localhost:8080/v1/models
 
 </details>
 
+### Embeddings
+
+<details>
+
+The embedding endpoint is experimental and enabled only if the model is configured with `emebddings: true` in its `yaml` file, for example:
+
+```yaml
+name: text-embedding-ada-002
+parameters:
+  model: wizardLM-7B.ggml.q5_1.bin
+embeddings: true
+```
+
+There is an example available [here](https://github.com/go-skynet/LocalAI/tree/master/examples/query_data/).
+
+Note: embeddings is supported only with `llama.cpp` compatible models. (doesn't work with gpt4-all-j, yet).
+
+</details>
+
 ## Frequently asked questions
 
 Here are answers to some of the most common questions.