From e3b090dbc561d86ee2ab5c006fec9c257a3b99f0 Mon Sep 17 00:00:00 2001 From: pepperoni21 Date: Wed, 13 Dec 2023 17:21:23 +0100 Subject: [PATCH] Added message format for chat api (#1488) --- docs/api.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api.md b/docs/api.md index d95ae9cc..c4b9ac47 100644 --- a/docs/api.md +++ b/docs/api.md @@ -304,6 +304,10 @@ Generate the next message in a chat with a provided model. This is a streaming e - `model`: (required) the [model name](#model-names) - `messages`: the messages of the chat, this can be used to keep a chat memory + A message is an object with the following fields: + - `role`: the role of the message, either `user`, `assistant` or `system` + - `content`: the content of the message + Advanced parameters (optional): - `format`: the format to return a response in. Currently the only accepted value is `json`