Skip to content

GitLab

Unverified Commit 711648c9 authored by Parth Sareen's avatar Parth Sareen Committed by GitHub
Browse files

docs: update api.md with streaming with tools is enabled (#8676)

parent dcfb7a10
Show whitespace changes
Inline Side-by-side
Showing with 2 additions and 2 deletions
docs/api.md
View file @ 711648c9
...@@ -495,14 +495,14 @@ Generate the next message in a chat with a provided model. This is a streaming e ...@@ -495,14 +495,14 @@ Generate the next message in a chat with a provided model. This is a streaming e
- `model`: (required) the [model name](#model-names) - `model`: (required) the [model name](#model-names)
- `messages`: the messages of the chat, this can be used to keep a chat memory - `messages`: the messages of the chat, this can be used to keep a chat memory
- `tools`: tools for the model to use if supported. Requires `stream` to be set to `false` - `tools`: list of tools in JSON for the model to use if supported
The `message` object has the following fields: The `message` object has the following fields:
- `role`: the role of the message, either `system`, `user`, `assistant`, or `tool` - `role`: the role of the message, either `system`, `user`, `assistant`, or `tool`
- `content`: the content of the message - `content`: the content of the message
- `images` (optional): a list of images to include in the message (for multimodal models such as `llava`) - `images` (optional): a list of images to include in the message (for multimodal models such as `llava`)
- `tool_calls` (optional): a list of tools the model wants to use - `tool_calls` (optional): a list of tools in JSON that the model wants to use
Advanced parameters (optional): Advanced parameters (optional):
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment