add /learn command

[sudoskys]

Provide methods to customize system prompt

Summary by CodeRabbit

• New Features

  • Added /learn command across various platforms (Discord, Slack, Kook, Telegram) to set and reset the system prompt.
  • Enhanced help messages and command descriptions in Telegram for better user interaction.

• Bug Fixes

  • Corrected the key for fetching links in the DuckDuckGo search functionality to improve accuracy.

• Refactor

  • Streamlined message history processing by reducing the number of lines read, enhancing performance.
  • Implemented sorting of trigger phrases by priority for more efficient processing.

• Documentation

  • Updated and added new function documentation and type hints to improve code readability and maintenance.

[coderabbitai]

Walkthrough

The recent updates focus on enhancing user interaction with various messaging platforms by introducing a /learn command to set system prompts. Modifications include reducing history lines in middleware, adding new functions across sender modules, refining help messages, and improving search functionality. Additionally, a key bug fix in search and refined logic in instruction handling enhance overall system robustness and user experience.

Changes

File Path	Change Summary
.../middleware/llm_task.py	Reduced history lines from 10 to 8.
.../sender/discord/..., .../kook/..., .../slack/..., .../telegram/...	Introduced /learn command handling and updated help messages.
.../util_func.py, .../kv_manager/instruction.py	Added learn_instruction function and refined instruction handling logic.
llmkira/extra/plugins/search/engine.py	Corrected key used in search function from "Href" to "href".
llmkira/openapi/trigger/__init__.py	Improved trigger phrase sorting by priority.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 32389d4 and 95cd3ed.

Files ignored due to path filters (1)

• pyproject.toml is excluded by !**/*.toml

Files selected for processing (13)

• app/middleware/llm_task.py (1 hunks)
• app/sender/discord/init.py (2 hunks)
• app/sender/discord/event.py (1 hunks)
• app/sender/kook/init.py (2 hunks)
• app/sender/kook/event.py (1 hunks)
• app/sender/slack/init.py (2 hunks)
• app/sender/slack/event.py (1 hunks)
• app/sender/telegram/init.py (3 hunks)
• app/sender/telegram/event.py (1 hunks)
• app/sender/util_func.py (3 hunks)
• llmkira/extra/plugins/search/engine.py (1 hunks)
• llmkira/kv_manager/instruction.py (1 hunks)
• llmkira/openapi/trigger/init.py (1 hunks)

Files skipped from review due to trivial changes (1)

• app/sender/slack/event.py

Additional comments not posted (13)

app/sender/telegram/event.py (1)

17-17: The addition of the /learn command to the help message is correctly implemented.

Please ensure that the integration of the /learn command with the Telegram bot's command handling logic is thoroughly tested.

app/sender/discord/event.py (1)

22-22: The addition of the /learn command to the help message is correctly implemented.

Please ensure that the integration of the /learn command with the Discord bot's command handling logic is thoroughly tested.

llmkira/kv_manager/instruction.py (1)

26-32: Enhancement to read_instruction method to handle absent or short instructions is well-implemented.

Please ensure that unit tests are added to verify the behavior of the read_instruction method when the instruction is absent or shorter than 5 characters.

app/sender/kook/event.py (1)

41-41: The addition of the /learn command to the help message is correctly implemented.

Please ensure that the integration of the /learn command with the Kook bot's command handling logic is thoroughly tested.

llmkira/openapi/trigger/__init__.py (1)

47-50: Sorting of trigger phrases by priority before processing is a good enhancement for managing triggers effectively.

Please ensure that the integration of the sorted trigger handling with the rest of the system is thoroughly tested, especially in scenarios with multiple competing triggers.

llmkira/extra/plugins/search/engine.py (1)

65-65: Correction of the key used to retrieve the link in search_in_duckduckgo function is necessary and well-implemented.

Please ensure that the integration of the corrected search functionality with the rest of the system is thoroughly tested.

app/sender/util_func.py (2)

144-161: Addition of the learn_instruction function to handle the /learn command is well-implemented.

Please ensure that the integration of the learn_instruction function with the rest of the system is thoroughly tested, especially in scenarios where the instruction text is at the boundary conditions of length.

---

162-169: Updates to the login function with documentation and type hints improve maintainability and clarity.

Please ensure that the integration of the updated login function with the rest of the system is thoroughly tested.

app/middleware/llm_task.py (1)

154-154: Reduction in the number of lines read from the message history is implemented as described.

Please ensure that the reduction in the number of lines read does not negatively impact the functionality of the system, particularly in scenarios where the message history is critical for context.

app/sender/slack/__init__.py (1)

227-238: The implementation of the /learn command in Slack looks correct and adheres to the expected functionality.

app/sender/kook/__init__.py (1)

279-293: The implementation of the /learn command in Kook looks correct and adheres to the expected functionality.

app/sender/telegram/__init__.py (1)

230-238: The implementation of the /learn command in Telegram looks correct and adheres to the expected functionality.

app/sender/discord/__init__.py (1)

266-277: The implementation of the /learn command in Discord looks correct and adheres to the expected functionality.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.