Skip to content

Commit

Permalink
📝 docs(README.md): clarify changes in configuration methods to suppor…
Browse files Browse the repository at this point in the history
…t multiple bots

Clarified that the changes in configuration methods in version 3 are to support multiple bots.
Additionally, added a heading to the table to emphasize the section for individual bot settings. This makes the guidelines clearer for users when configuring multiple bots.
Fixed table collapse on GitHub.
  • Loading branch information
takuya-o committed Dec 31, 2024
1 parent d300de7 commit 41d241a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
> **Note** đź‘€
> - Configuration methods have changed in version 3.
> - Configuration methods have changed in version 3 for support multiple bots
> - After version 3.1 have backward compatibility for enviromnent variables configurations on single instance.
> - Recommend manually rewrite environment variables into `config.yaml` for multi instance.
Expand Down Expand Up @@ -140,7 +140,7 @@ BOT_INSTRUCTION: "You are a helpful assistant. Whenever users asks you for help
| OPENAI_TEMPERATURE | no | 1 | The sampling temperature to use, between 0 and 2. Higher values make the output more random, while lower values make it more focused and deterministic. This is default for all bots. | OPENAI_TEMPERATURE |
| MAX_PROMPT_TOKENS | no | 2000 | Maximum number of prompt tokens. This is default for all bots. | MAX_PROMPT_TOKENS |
| BOT_INSTRUCTION | no | 'You are a helpful assistant...` | Extra instruction to give your assistance. How should the assistant behave? This setting used by all bots. | BOT_INSTRUCTION |
|
| **Individual bot settings** |||||
| name | yes | none | The name of the bot. | |
| mattermostUrl | no | none | The URL to the Mattermost server for the bot. | MATTERMOST_URL |
| mattermostToken | yes | none | The authentication token for the Mattermost bot. | \${name}_MATTERMOST_TOKEN, \${type}_MATTERMOST_TOKEN, MATTERMOST_TOKEN |
Expand Down

0 comments on commit 41d241a

Please sign in to comment.