From 711648c9bbc186697c19775bf140b174b6a5687a Mon Sep 17 00:00:00 2001 From: Parth Sareen Date: Wed, 29 Jan 2025 15:14:30 -0800 Subject: [PATCH] docs: update api.md with streaming with tools is enabled (#8676) --- docs/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index ede6446f9..e9719ad4e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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) - `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: - `role`: the role of the message, either `system`, `user`, `assistant`, or `tool` - `content`: the content of the message - `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):