Added message format for chat api (#1488)

e3b090db · pepperoni21 · GitHub · d9e60f63 · e3b090db
Unverified Commit e3b090db authored Dec 13, 2023 by pepperoni21 Committed by GitHub Dec 13, 2023
Show whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

docs/api.md docs/api.md +4 -0

No files found.
--- 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`