mirror of
https://github.com/mudler/LocalAI.git
synced 2025-05-06 18:48:24 +00:00
doc: update README with embeddings docs
This commit is contained in:
parent
89dfa0f5fc
commit
3daff6f1aa
19
README.md
19
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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user