diff options
| author | Alexey Parfenov <zxed@alkatrazstudio.net> | 2024-02-05 08:10:22 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-05 10:10:22 +0200 |
| commit | a2d60c9158435ae9a6f14632f07f1acf7a3becef (patch) | |
| tree | 1466e6a9bfc6ddc1810e0580eb404aa54de537e4 /examples/server/README.md | |
| parent | e6f81775323f6f4e4a30abf022a6028fa86b79ac (diff) | |
server : allow to get default generation settings for completion (#5307)
Diffstat (limited to 'examples/server/README.md')
| -rw-r--r-- | examples/server/README.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/examples/server/README.md b/examples/server/README.md index fe934dab..d8e7c313 100644 --- a/examples/server/README.md +++ b/examples/server/README.md @@ -264,7 +264,21 @@ Notice that each `probs` is an array of length `n_probs`. It also accepts all the options of `/completion` except `stream` and `prompt`. -- **GET** `/props`: Return the required assistant name and anti-prompt to generate the prompt in case you have specified a system prompt for all slots. +- **GET** `/props`: Return current server settings. + +### Result JSON + +```json +{ + "assistant_name": "", + "user_name": "", + "default_generation_settings": { ... } +} +``` + +- `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. - **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. |