vbatts/llama.cpp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update /props endpoint docs with total_slots

Browse source
This commit is contained in:
Justin Parker 2024-02-06 14:53:33 -05:00
parent 4ff37ea41f
commit 6ada782e80
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
examples/server/README.md
View file

@ -272,13 +272,15 @@ Notice that each `probs` is an array of length `n_probs`.
{
"assistant_name": "",
"user_name": "",
"default_generation_settings": { ... }
"default_generation_settings": { ... },
"total_slots": ""
}
```
- `assistant_name` - the required assistant name to generate the prompt in case you have specified a system prompt for all slots.
- `user_name` - the required anti-prompt to generate the prompt in case you have specified a system prompt for all slots.
- `default_generation_settings` - the default generation settings for the `/completion` endpoint, has the same fields as the `generation_settings` response object from the `/completion` endpoint.
- `total_slots` - the total number of slots for process requests (defined by `--parallel` option)
- **POST** `/v1/chat/completions`: OpenAI-compatible Chat Completions API. Given a ChatML-formatted json description in `messages`, it returns the predicted completion. Both synchronous and streaming mode are supported, so scripted and interactive applications work fine. While no strong claims of compatibility with OpenAI API spec is being made, in our experience it suffices to support many apps. Only ChatML-tuned models, such as Dolphin, OpenOrca, OpenHermes, OpenChat-3.5, etc can be used with this endpoint. Compared to `api_like_OAI.py` this API implementation does not require a wrapper to be served.