highperfocused/ollama
1
0
Fork 0
mirror of https://github.com/ollama/ollama.git synced 2025-04-07 19:38:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Parth Sareen 2025-01-29 15:14:30 -08:00 committed by GitHub
parent dcfb7a105c
commit 711648c9bb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api.md
View File

@ -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):