serge-chat
Implement Stopping Prompt Response Generation
This implements new functionality to the trash can button below messages to stop a response during or before generation. However, it also means that now the /api/chat/{chat_id}/prompt DELETE method does not always delete anything upon success. Please let me know if you would like the endpoint to be changed to better reflect its functionality.
Fixes: #746
Walkthrough
The changes introduce a new POST endpoint for stopping or deleting prompts in the chat API, enhancing the handling of invalid deletion attempts by setting a Redis flag instead of raising errors. The chat component in Svelte has been updated to improve user feedback when prompts are managed, particularly during response generation. Modifications also include variable renaming for clarity and enhancements in error handling and response generation to ensure a more user-friendly experience.
Changes
| Files | Change Summary |
|---|---|
| api/src/serge/routers/chat.py | Added POST endpoint for stopping/deleting prompts; modified logic for invalid index handling; renamed client to llama_client; updated event generator for stop condition checks; refined error handling and return statements. |
| web/src/routes/chat/[id]/+page.svelte | Enhanced deletePrompt function to handle server responses for user feedback; removed handling for 202 status code to simplify error handling; retained toast notifications for user updates. |
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Ability to stop response in progress (#746) | ✅ |
🐇 In the chat, where prompts do play,
A delete command brightens the day!
With flags in Redis, we gracefully stop,
User feedback now makes the chat pop!
So click that trash can, don’t hesitate,
For smoother chats, we celebrate! 🎉
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?
🪧 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>, please review it. -
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
@coderabbitaiin 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
@coderabbitaiin 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -
@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. -
@coderabbitai help me debug CodeRabbit configuration file.
-
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 using PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
![coderabbitai[bot] avatar](https://avatars.githubusercontent.com/in/347564?v=4 "Published by a pub.dev verified publisher"){kind=small}
@gaby I want to change the endpoint to POST and rename it to delete_or_stop_prompt to improve readability. Otherwise, the comments from CodeRabbit seem to be nitpicks or unimportant for this pull request.
@gaby I want to change the endpoint to POST and rename it to delete_or_stop_prompt to improve readability. Otherwise, the comments from CodeRabbit seem to be nitpicks or unimportant for this pull request.
Sure, go ahead