From 58ad1209518f0a6092bf1273259a1785b6f794ef Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 18 Jan 2025 17:25:56 +0900 Subject: [PATCH] Update docs/configuring-playbook-bot-baibot.md (#3960) * Update docs/configuring-playbook-bot-baibot.md Signed-off-by: Suguru Hirahara * Update docs/configuring-playbook-bot-baibot.md: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara --------- Signed-off-by: Suguru Hirahara Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-bot-baibot.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index 3b6abcedc..0874095d5 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -146,15 +146,13 @@ matrix_bot_baibot_config_agents_static_definitions_anthropic_enabled: true matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key: "YOUR_API_KEY_HERE" -# If you'd like to use another text-generation agent, uncomment and adjust: +# Uncomment and adjust this part if you'd like to use another text-generation agent # matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_model_id: claude-3-5-sonnet-20240620 # The playbook defines a default prompt for all statically-defined agents. # You can adjust it in the `matrix_bot_baibot_config_agents_static_definitions_prompt` variable, # or you can adjust it below only for the Anthropic agent. # matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_prompt: "{{ matrix_bot_baibot_config_agents_static_definitions_prompt }}" - -# See `defaults/main.yml` in the baibot role for more configuration options. ``` If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below. @@ -184,8 +182,6 @@ matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_m # # matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_enabled: true # matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_model_id: whisper-large-v3 - -# See `defaults/main.yml` in the baibot role for more configuration options. ``` Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/groq`. @@ -212,8 +208,6 @@ matrix_bot_baibot_config_agents_static_definitions_mistral_config_api_key: "YOUR # Uncomment and adjust this part if you're not happy with these defaults: # matrix_bot_baibot_config_agents_static_definitions_mistral_config_text_generation_model_id: mistral-large-latest - -# See `defaults/main.yml` in the baibot role for more configuration options. ``` Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/mistral`. @@ -242,8 +236,6 @@ matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key: "YOUR_ # If you'd like to use another text-generation agent, uncomment and adjust: # matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_model_id: gpt-4o - -# See `defaults/main.yml` in the baibot role for more configuration options. ``` Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/openai`. @@ -362,6 +354,15 @@ matrix_bot_baibot_config_initial_global_config_handler_image_generation: null **Note**: these are initial defaults for the bot's global configuration. As such, changing any of these values subsequently has no effect on the bot's behavior. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands. +### Extending the configuration + +There are some additional things you may wish to configure about the bot. + +Take a look at: + +- `roles/custom/matrix-bot-baibot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file +- `roles/custom/matrix-bot-baibot/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_baibot_configuration_extension_yaml` variable + ## Installing After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: