Release 1.0.4

Previously, the bot only had rudimentary typing notification support.

It used to send a single notification when starting a long task
and did not bother with notifications anymore.
By default matrix-rust-sdk gives these notifications a validity of 4
seconds, so it would expire shortly. If the bot takes longer to respond,
you'd see the typing notification expire and wonder if a response is
coming.

Another edge case is the bot sending an answer quicker and the typing
notice still being on. Some clients (like element-web) seem to hide the
typing notice when a new message comes, so they don't experience this as
problematic.

The reworked typing notification system should be robust:

- typing notices are sent continuously, until the bot finishes doing
  work
- if the bot is performing multiple actions in a room (even for
  different people), typing notices would continue to be sent until the
  bot becomes idle
- as soon as the bot becomes idle, a "not typing anymore" notice is sent
  to clear the state

CHANGELOG.md

@@ -1 +1,13 @@
-There's nothing here yet.
+# (2024-09-14) Version 1.0.4
+
+[Improves](https://github.com/etkecc/baibot/commit/dd1dd78312e3db7f92b37fb3b4750fbe35de7115) the typing notification logic.
+
+
+# (2024-09-13) Version 1.0.3
+
+Contains [fixes](https://github.com/etkecc/rust-mxlink/commit/f339fc85e69aa7f614394ad303d1614cd307319c) for [some](https://github.com/etkecc/baibot/issues/1) startup failures caused by partial initialization (errors during startup).
+
+
+# (2024-09-12) Version 1.0.0
+
+Initial release. 🎉

Cargo.lock

@@ -297,16 +297,16 @@ dependencies = [
 
 [[package]]
 name = "baibot"
-version = "1.0.0"
+version = "1.0.4"
 dependencies = [
  "anthropic-rs",
  "anyhow",
  "async-openai 0.24.0",
  "base64 0.22.1",
+ "etke_openai_api_rust",
  "matrix-sdk",
  "mxidwc",
  "mxlink",
- "openai_api_rust",
  "quick_cache",
  "regex",
  "serde",
@@ -919,6 +919,20 @@ dependencies = [
  "windows-sys 0.52.0",
 ]
 
+[[package]]
+name = "etke_openai_api_rust"
+version = "0.1.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c1499ac61bf9b9a5973a5830894cbf2016a96a4dab9eb2dab4a526c720632c93"
+dependencies = [
+ "log",
+ "mime",
+ "rand",
+ "serde",
+ "serde_json",
+ "ureq",
+]
+
 [[package]]
 name = "event-listener"
 version = "4.0.3"
@@ -2108,9 +2122,9 @@ dependencies = [
 
 [[package]]
 name = "mxlink"
-version = "1.0.0"
+version = "1.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "80cb97e517e3bc8e85b4787ed87037cd324526862ca9375c6d038699010bf6c2"
+checksum = "195f0bd9764068de3e3e446bbac81a54489ff51674d80e387057b805c7dab96c"
 dependencies = [
  "base64 0.22.1",
  "chacha20poly1305",
@@ -2204,19 +2218,6 @@ version = "0.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c08d65885ee38876c4f86fa503fb49d7b507c2b62552df7c70b2fce627e06381"
 
-[[package]]
-name = "openai_api_rust"
-version = "0.1.9"
-source = "git+https://github.com/etkecc/openai_api_rust.git?branch=next#a9183fc2e699c3d33c635c2aed3f9174f9d9cd74"
-dependencies = [
- "log",
- "mime",
- "rand",
- "serde",
- "serde_json",
- "ureq",
-]
-
 [[package]]
 name = "openssl"
 version = "0.10.66"

Cargo.toml

@@ -5,9 +5,9 @@ authors = ["Slavi Pantaleev <slavi@devture.com>"]
 repository = "https://github.com/etkecc/baibot"
 license = "AGPL-3.0-or-later"
 readme = "README.md"
-keywords = ["matrix", "chat", "LLM", "openai", "anthropic", "localai"]
+keywords = ["matrix", "chat", "bot", "AI", "LLM"]
-exclude = [".editorconfig", "justfile", "docs/", "etc/", "Dockerfile", ".dockerignore", ".gitignore"]
+include = ["/etc/assets/baibot-torso-768.png", "/src", "/README.md", "/CHANGELOG.md", "/LICENSE"]
-version = "1.0.0"
+version = "1.0.4"
 edition = "2021"
 
 [lib]
@@ -22,8 +22,8 @@ base64 = "0.22.*"
 # We'd rather not depend on this, but we cannot use the ruma-events EventContent macro without it.
 matrix-sdk = { version = "0.7.1", default-features = false }
 mxidwc = "1.0.*"
-mxlink = "1.0.*"
+mxlink = "1.2.*"
-openai_api_rust = { git = "https://github.com/etkecc/openai_api_rust.git", branch = "next" }
+etke_openai_api_rust = "0.1.*"
 quick_cache = "0.6.*"
 regex = "1.10.*"
 serde = { version = "1.0.*", features = ["derive"], default-features = false }

README.md

@@ -5,7 +5,7 @@
 
 🤖 baibot is an [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) ([Large Language Model](https://en.wikipedia.org/wiki/Large_language_model)) bot for [Matrix](https://matrix.org/) built by [etke.cc](https://etke.cc/) (managed Matrix servers).
 
-The name is pronounced 'bye' and is a play on [AI](https://en.wikipedia.org/wiki/Artificial_intelligence), referencing the fictional character [🇧🇬 Bai Ganyo](https://en.wikipedia.org/wiki/Bay_Ganyo).
+The name is pronounced 'bye'-bot and is a play on [AI](https://en.wikipedia.org/wiki/Artificial_intelligence), referencing the fictional character [🇧🇬 Bai Ganyo](https://en.wikipedia.org/wiki/Bay_Ganyo).
 
 It's designed as a more private and [featureful](#-features) alternative to [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot).
 It's influenced by [chaz](https://github.com/arcuru/chaz), but does **not** use the [AIChat](https://github.com/sigoden/aichat) CLI tool and instead does everything in-process, without forking.
@@ -19,8 +19,8 @@ It's influenced by [chaz](https://github.com/arcuru/chaz), but does **not** use
 
   - [💬 text-generation](./docs/features.md#-text-generation): communicating with you via text
   - [🦻 speech-to-text](./docs/features.md#-speech-to-text): turning your voice messages into text
-  - [🗣️ text-to-speech](./docs/features.md#️-text-to-speech): turning bot or users text messages into voice messages
+  - [🗣️ 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#-image-generation): generating images based on instructions
+  - [🖌️ image-generation](./docs/features.md#%EF%B8%8F-image-generation): generating images based on instructions
 
 - 🪄 Supports [seamless voice interaction](./docs/features.md#seamless-voice-interaction) (turning user voice messages into text, answering in text, then turning that text back into voice)
 

docs/README.md

@@ -1,9 +1,11 @@
 # Table of Contents
 
 - [🔒 Access](./access.md)
-- [🤖 Agents](./agents.md) and [☁️ Providers](./providers.md)
+- [🤖 Agents](./agents.md)
 - [🛠️ Configuration](./configuration/README.md)
 - [🌟 Features](./features.md)
+- [🤝 Handlers](./configuration/handlers.md)
+- [☁️ Providers](./providers.md)
 - [📖 Usage](./usage.md)
 - [🚀 Installation](./installation.md)
 - [💻 Development](./development.md)

docs/configuration/text-generation.md

@@ -23,7 +23,7 @@ To support such use-cases, the bot has a `text-generation prefix-requirement-typ
 
 - `command_prefix`: indicates that the bot would require that messages be prefixed with the command prefix (e.g. `!bai`) and would ignore all messages that are not prefixed
 
-By default, the bot is **auto-configured (upon joining a new room)** to use the `no` setting in rooms that only include 2 users (you and the bot), and `command_prefix` in rooms with more than 2 users. To prevent surprises, the bot will **not** adjust this setting subsequently. You can manually adjust it via `!bai config room set-prefix-requirement-type VALUE`.
+By default, the bot is **auto-configured (upon joining a new room)** to use the `no` setting in rooms that only include 2 users (you and the bot), and `command_prefix` in rooms with more than 2 users. To prevent surprises, the bot will **not** adjust this setting subsequently. You can manually adjust it via `!bai config room text-generation set-prefix-requirement-type VALUE`.
 
 Example: `!bai config room text-generation set-prefix-requirement-type command_prefix` (this can also be set globally, see [🛠️ Room Settings](./README.md#room-settings))
 
@@ -51,7 +51,7 @@ The bot also supports ♻️ **context management**, which automatically adjusts
 
 This feature relies on [tokenization](https://en.wikipedia.org/wiki/Large_language_model#Tokenization) performed by the [tiktoken-rs](https://github.com/zurawiki/tiktoken-rs) library which is [poorly well-maintained](https://github.com/zurawiki/tiktoken-rs/issues/50) and only works well for [OpenAI](../providers.md#openai) models.
 
-This setting is **disabled by default**, but can be enabled via `!bai config room context-management-enabled true` (this can also be set globally, see [🛠️ Room Settings](./README.md#room-settings)).
+This setting is **disabled by default**, but can be enabled via `!bai config room text-generation set-context-management-enabled true` (this can also be set globally, see [🛠️ Room Settings](./README.md#room-settings)).
 
 
 ### ⌨️ Prompt Override

docs/features.md

@@ -10,8 +10,8 @@ The bot supports the following use-purposes:
 
 - [💬 text-generation](#-text-generation): communicating with you via text
 - [🦻 speech-to-text](#-speech-to-text): turning your voice messages into text
-- [🗣️ text-to-speech](#️-text-to-speech): turning bot or users text messages into voice messages
+- [🗣️ text-to-speech](#%EF%B8%8F-text-to-speech): turning bot or users text messages into voice messages
-- [🖌️ image-generation](#-image-generation): generating images based on instructions
+- [🖌️ image-generation](#%EF%B8%8F-image-generation): generating images based on instructions
 
 In a given room, each different purpose can be served by a different [☁️ provider](./providers.md) and model. This combination of provider and model configuration is called an [🤖 agent](./agents.md). Each purpose can be served by a different **handler** agent.
 
@@ -32,7 +32,7 @@ A few other features (like [🗣️ Text-to-Speech](#️-text-to-speech) and [
 
 You may also wish to see:
 
-- [🛠️ Configuration / 💬 Text Generation](./configuration/README.md#-text-generation) for configuration options related to Text Generation
+- [🛠️ Configuration / 💬 Text Generation](./configuration/text-generation.md) for configuration options related to Text Generation
 - [📖 Usage / 💬 Text Generation](./usage.md#-text-generation) section for more details on how to use the bot for Text Generation in a room
 
 
@@ -48,7 +48,9 @@ By default, the bot **doesn't** perform text-to-speech. It can be configured for
 
 Another use-case is to have the bot operate in [Text-to-Speech-only mode](#text-to-speech-only-mode).
 
-- [🛠️ Configuration / 🗣️ Text-to-Speech](./configuration/README.md#-text-to-speech) for configuration options related to Text-to-Speech
+You may also wish to see:
+
+- [🛠️ Configuration / 🗣️ Text-to-Speech](./configuration/text-to-speech.md) for configuration options related to Text-to-Speech
 - [📖 Usage / 🗣️ Text-to-Speech](./usage.md#-text-to-speech) section for more details on how to use the bot for Text-to-Speech in a room
 
 
@@ -77,6 +79,10 @@ The default flow is shown in the screenshot above: your voice messages are trans
 
 You may also configure the bot for [Seamless voice interaction](#seamless-voice-interaction) or [Transcribe-only mode](#transcribe-only-mode), etc.
 
+You may also wish to see:
+
+- [🛠️ Configuration / 🦻 Speech-to-Text](./configuration/speech-to-text.md) for configuration options related to Speech-to-Text
+- [📖 Usage / 🦻 Speech-to-Text](./usage.md#-speech-to-text) section for more details on how to use the bot for Speech-to-Text in a room
 
 #### Seamless voice interaction
 
@@ -121,7 +127,7 @@ See a [🖼️ Screenshot of the Image Generation feature](./screenshots/image-g
 
 You may also wish to see:
 
-- [🛠️ Configuration / 🖌️ Image Generation](./configuration/README.md#-image-generation) for configuration options related to Image Generation
+- [🛠️ Configuration / 🖌️ Image Generation](./configuration/image-generation.md) for configuration options related to Image Generation
 - [📖 Usage / 🖌️ Image Generation](./usage.md#-image-generation) section for more details on how to use the bot for Image Generation in a room
 - [🫵 Sticker Generation](#-sticker-generation) - a special case of Image Generation
 

docs/providers.md

@@ -49,7 +49,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local anthropic my-anthropic-agent`
   - create a global agent: `!bai agent create-global anthropic my-anthropic-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/anthropic.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/anthropic.yml).
 
 
 ### Groq
@@ -63,7 +63,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local groq my-groq-agent`
   - create a global agent: `!bai agent create-global groq my-groq-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/groq.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/groq.yml).
 
 
 ### LocalAI
@@ -77,7 +77,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local localai my-localai-agent`
   - create a global agent: `!bai agent create-global localai my-localai-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/localai.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/localai.yml).
 
 
 ### Mistral
@@ -91,7 +91,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local mistral my-mistral-agent`
   - create a global agent: `!bai agent create-global mistral my-mistral-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/mistral.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/mistral.yml).
 
 
 ### Ollama
@@ -105,7 +105,7 @@ You don't need to choose just one though. The bot supports [mixing & matching mo
   - create a room-local agent: `!bai agent create-room-local ollama my-ollama-agent`
   - create a global agent: `!bai agent create-global ollama my-ollama-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/ollama.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/ollama.yml).
 
 
 ### OpenAI
@@ -122,7 +122,7 @@ For services which are not fully compatible with the OpenAI API, consider using
   - create a room-local agent: `!bai agent create-room-local openai my-openai-agent`
   - create a global agent: `!bai agent create-global openai my-openai-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/openai.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/openai.yml).
 
 
 ### OpenAI Compatible
@@ -139,7 +139,7 @@ This provider is just as featureful as the [OpenAI](#openai) provider, but is mo
   - create a room-local agent: `!bai agent create-room-local openai-compatible my-openai-compatible-agent`
   - create a global agent: `!bai agent create-global openai-compatible my-openai-compatible-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/openai-compatible.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/openai-compatible.yml).
 
 
 ### OpenRouter
@@ -153,7 +153,7 @@ This provider is just as featureful as the [OpenAI](#openai) provider, but is mo
   - create a room-local agent: `!bai agent create-room-local openrouter my-openrouter-agent`
   - create a global agent: `!bai agent create-global openrouter my-openrouter-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/openrouter.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/openrouter.yml).
 
 
 ### Together AI
@@ -167,4 +167,4 @@ This provider is just as featureful as the [OpenAI](#openai) provider, but is mo
   - create a room-local agent: `!bai agent create-room-local together-ai my-together-ai-agent`
   - create a global agent: `!bai agent create-global together-ai my-together-ai-agent`
 
-💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](../sample-provider-configs/together-ai.yml).
+💡 When creating an agent, the bot will show you an up-to-date sample configuration for this provider which looks [like this](./sample-provider-configs/together-ai.yml).

src/agent/provider/openai_compat/controller.rs

@@ -1,7 +1,7 @@
-use openai_api_rust::audio::{AudioApi, AudioBody};
+use etke_openai_api_rust::audio::{AudioApi, AudioBody};
-use openai_api_rust::chat::{ChatApi, ChatBody};
+use etke_openai_api_rust::chat::{ChatApi, ChatBody};
-use openai_api_rust::images::{ImagesApi, ImagesBody};
+use etke_openai_api_rust::images::{ImagesApi, ImagesBody};
-use openai_api_rust::{Auth, Message, OpenAI};
+use etke_openai_api_rust::{Auth, Message, OpenAI};
 
 use super::super::ControllerTrait;
 use crate::agent::utils::base64_decode;

src/agent/provider/openai_compat/utils.rs

@@ -1,4 +1,4 @@
-use openai_api_rust::{Message, Role};
+use etke_openai_api_rust::{Message, Role};
 
 use crate::agent::provider::openai::Config as OpenAIConfig;
 

src/bot/messaging.rs

@@ -317,6 +317,13 @@ impl Messaging {
 
         let start_time = std::time::Instant::now();
 
+        let _typing_notice_guard = self
+            .bot
+            .matrix_link()
+            .rooms()
+            .start_typing_notice(message_context.room())
+            .await;
+
         let event_span = tracing::error_span!("message_controller", ?controller_type);
 
         crate::controller::dispatch_controller(&controller_type, &message_context, &self.bot)

src/bot/reacting.rs

@@ -244,6 +244,13 @@ impl Reacting {
 
         tracing::info!("Handling reaction via reaction controller");
 
+        let _typing_notice_guard = self
+            .bot
+            .matrix_link()
+            .rooms()
+            .start_typing_notice(message_context.room())
+            .await;
+
         let event_span = tracing::error_span!("reaction_controller");
 
         crate::controller::reaction::handle(

src/controller/agent/create/mod.rs

@@ -100,8 +100,6 @@ pub async fn handle_room_local(
         return Ok(());
     };
 
-    message_context.room().typing_notice(true).await?;
-
     if !try_to_ping_agent_or_complain(bot, message_context, &parsed_config.agent).await {
         return Ok(());
     }
@@ -215,8 +213,6 @@ pub async fn handle_global(
         return Ok(());
     };
 
-    message_context.room().typing_notice(true).await?;
-
     if !try_to_ping_agent_or_complain(bot, message_context, &parsed_config.agent).await {
         return Ok(());
     }

src/controller/chat_completion/mod.rs

@@ -337,8 +337,6 @@ async fn handle_stage_text_generation(
     )
     .await?;
 
-    _ = message_context.room().typing_notice(true).await;
-
     let prefixes_to_strip = match controller_type {
         ChatCompletionControllerType::ViaText { prefixes_to_strip } => prefixes_to_strip.clone(),
         ChatCompletionControllerType::ViaAudio => vec![],
@@ -498,8 +496,6 @@ async fn handle_stage_speech_to_text_actual_transcribing(
         .get_media_content(&media_request, true)
         .await?;
 
-    _ = message_context.room().typing_notice(true).await;
-
     let span = tracing::debug_span!(
         "speech_to_text_generation",
         agent_id = agent.identifier().as_string()

src/controller/image/generation.rs

@@ -56,8 +56,6 @@ pub async fn handle_image(
         original_prompt.to_owned()
     };
 
-    message_context.room().typing_notice(true).await?;
-
     let span = tracing::debug_span!(
         "image_generation",
         agent_id = agent.identifier().as_string()
@@ -139,8 +137,6 @@ pub async fn handle_sticker(
         return Ok(());
     };
 
-    message_context.room().typing_notice(true).await?;
-
     let span = tracing::debug_span!(
         "sticker_generation",
         agent_id = agent.identifier().as_string()

src/controller/utils/text_to_speech.rs

@@ -18,8 +18,6 @@ pub async fn generate_and_send_tts_for_message(
     text_message_event_id: &OwnedEventId,
     text_content: &str,
 ) -> bool {
-    _ = message_context.room().typing_notice(true).await;
-
     let reaction_event_response = bot
         .reacting()
         .react_no_fail(