From d8e47b05785928d1b6ec01678e5a2803a5e15a32 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sat, 10 May 2025 11:39:33 +0300 Subject: [PATCH] Document vision support for text-generation --- README.md | 2 +- docs/configuration/handlers.md | 2 +- docs/features.md | 6 ++++-- docs/usage.md | 2 ++ 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 54698f2..a27b481 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ It's influenced by [chaz](https://github.com/arcuru/chaz), but does **not** use - Supports **different use purposes** (depending on the [☁ī¸ provider](./docs/providers.md) & model): - - [đŸ’Ŧ text-generation](./docs/features.md#-text-generation): communicating with you via text + - [đŸ’Ŧ text-generation](./docs/features.md#-text-generation): communicating with you via text (though certain models may "see" images as well) - [đŸĻģ speech-to-text](./docs/features.md#-speech-to-text): turning your voice messages into text - [đŸ—Ŗī¸ text-to-speech](./docs/features.md#%EF%B8%8F-text-to-speech): turning bot or users text messages into voice messages - [🖌ī¸ image-generation](./docs/features.md#%EF%B8%8F-image-generation): generating images based on instructions diff --git a/docs/configuration/handlers.md b/docs/configuration/handlers.md index e12ee16..97a9dd6 100644 --- a/docs/configuration/handlers.md +++ b/docs/configuration/handlers.md @@ -8,7 +8,7 @@ You can also use **different models within the same room** (e.g. [đŸ’Ŧ text-gene The bot supports the following use-purposes: -- [đŸ’Ŧ text-generation](../features.md#-text-generation): communicating with you via text +- [đŸ’Ŧ text-generation](../features.md#-text-generation): communicating with you via text (though certain models may "see" images as well) - [đŸĻģ speech-to-text](../features.md#-speech-to-text): turning your voice messages into text - [đŸ—Ŗī¸ text-to-speech](../features.md#ī¸-text-to-speech): turning bot or users text messages into voice messages - [🖌ī¸ image-generation](../features.md#image-generation): generating images based on instructions diff --git a/docs/features.md b/docs/features.md index c62bee9..42414df 100644 --- a/docs/features.md +++ b/docs/features.md @@ -8,7 +8,7 @@ You can also use **different models within the same room** (e.g. [đŸ’Ŧ text-gene The bot supports the following use-purposes: -- [đŸ’Ŧ text-generation](#-text-generation): communicating with you via text +- [đŸ’Ŧ text-generation](#-text-generation): communicating with you via text (though certain models may "see" images as well) - [đŸĻģ speech-to-text](#-speech-to-text): turning your voice messages into text - [đŸ—Ŗī¸ text-to-speech](#%EF%B8%8F-text-to-speech): turning bot or users text messages into voice messages - [🖌ī¸ image-generation](#%EF%B8%8F-image-generation): generating images based on instructions @@ -22,10 +22,12 @@ For more information about configuring handlers, see the [🤝 Handlers / Config ### đŸ’Ŧ Text Generation -Text Generation is the bot's ability to **respond to users' text messages with text**. +Text Generation is the bot's ability to **respond to users' messages with text**. ![Screenshot of Text Generation - a user sends a message and the bot replies in a new conversation thread](./screenshots/text-generation.webp) +Some models also support vision, so you may be able to mix text and images in the same conversation. + In multi-user (group) rooms, to avoid disturbing the normal conversation between people, the bot is auto-configured to only respond to messages starting with the command prefix (`!bai`) or direct mentions via the [đŸ’Ŧ Text Generation / 🗟 Prefix Requirement Type](./configuration/text-generation.md#-prefix-requirement-type) setting. Normally, the bot only responds to allowed [đŸ‘Ĩ Users](./access.md#-users). In certain cases, it's useful for an allowed user to provoke the bot to respond even in foreign threads or reply chains. You can learn more about this feature in the [On-demand involvement](./features.md#on-demand-involvement) section below. diff --git a/docs/usage.md b/docs/usage.md index 024cb06..17b1a27 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -11,6 +11,8 @@ This is related to the [đŸ’Ŧ Text Generation](./features.md#-text-generation) fe If there's a text-generation handler agent configured, the bot **may** respond to messages sent in the room. +Some models also support vision, so you may be able to mix text and images in the same conversation. + See screenshots of: - đŸ–ŧī¸ [the default Text Generation flow](./screenshots/text-generation.webp) in 1:1 rooms