Feature: Implement /rewrite command for message improvement using Cha… #1378
+236
−16
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,184 @@ | ||
| package org.togetherjava.tjbot.features.messages; | ||
|
|
||
| import net.dv8tion.jda.api.entities.Message; | ||
| import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent; | ||
| import net.dv8tion.jda.api.interactions.commands.OptionMapping; | ||
| import net.dv8tion.jda.api.interactions.commands.OptionType; | ||
| import net.dv8tion.jda.api.interactions.commands.build.OptionData; | ||
| import org.jetbrains.annotations.Nullable; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import org.togetherjava.tjbot.features.CommandVisibility; | ||
| import org.togetherjava.tjbot.features.SlashCommandAdapter; | ||
| import org.togetherjava.tjbot.features.chatgpt.ChatGptModel; | ||
| import org.togetherjava.tjbot.features.chatgpt.ChatGptService; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * The implemented command is {@code /rewrite}, which allows users to have their message rewritten | ||
| * in a clearer, more professional, or better structured form using AI. | ||
| * <p> | ||
| * The rewritten message is shown as an ephemeral message visible only to the user who triggered the | ||
| * command. | ||
| * <p> | ||
| * Users can optionally specify a tone/style for the rewrite. | ||
| */ | ||
| public final class RewriteCommand extends SlashCommandAdapter { | ||
| private static final Logger logger = LoggerFactory.getLogger(RewriteCommand.class); | ||
| private static final String COMMAND_NAME = "rewrite"; | ||
| private static final String MESSAGE_OPTION = "message"; | ||
| private static final String TONE_OPTION = "tone"; | ||
|
|
||
| private static final int MAX_MESSAGE_LENGTH = Message.MAX_CONTENT_LENGTH; | ||
| private static final int MIN_MESSAGE_LENGTH = 3; | ||
|
|
||
| private final ChatGptService chatGptService; | ||
|
|
||
| private static ChatGptModel selectAiModel(MessageTone tone) { | ||
|
Contributor
There was a problem hiding this comment. Nit: can we move all |
||
| return switch (tone) { | ||
|
Contributor
There was a problem hiding this comment. Optional: Just add the ChatGptModel to the enum and remove this entire function. |
||
| case CLEAR, PROFESSIONAL -> ChatGptModel.FASTEST; | ||
| case DETAILED, TECHNICAL -> ChatGptModel.HIGH_QUALITY; | ||
| }; | ||
| } | ||
|
|
||
| private static String createAiPrompt(String userMessage, MessageTone tone) { | ||
| return """ | ||
| You are rewriting a Discord text chat message for clarity and professionalism. | ||
| Keep it conversational and casual—NOT email or formal document format. | ||
|
Contributor
There was a problem hiding this comment.
Contributor
There was a problem hiding this comment. Additionally, let's move this out into a constant e.g. private static final String AI_REWRITE_PROMPT_TEMPLATE = """
You are rewriting a Discord text chat message for clarity and professionalism.
Keep it conversational and casual, not email or formal document format.
Tone: %s
Rewrite the message to:
- Improve clarity and structure
- Maintain the original meaning
- Avoid em-dashes (—)
- Stay under %d characters (strict limit)
If the message is already well-written, make only minor improvements.
Message to rewrite:
%s
""".stripIndent();
...
private static String createAiPrompt(String userMessage, MessageTone tone) {
return AI_REWRITE_PROMPT_TEMPLATE.formatted(
tone.description,
MAX_MESSAGE_LENGTH,
userMessage
);
} |
||
| Tone: %s | ||
| Rewrite the message to: | ||
| - Improve clarity and structure | ||
| - Maintain the original meaning | ||
| - Avoid em-dashes (—) | ||
| - Stay under %d characters (strict limit) | ||
|
Contributor
There was a problem hiding this comment.
|
||
| If the message is already well-written, make only minor improvements. | ||
| Message to rewrite: | ||
| %s""".stripIndent().formatted(tone.description, MAX_MESSAGE_LENGTH, userMessage); | ||
| } | ||
|
|
||
| /** | ||
| * Creates the slash command definition and configures available options for rewriting messages. | ||
| * | ||
| * @param chatGptService service for interacting with ChatGPT | ||
| */ | ||
| public RewriteCommand(ChatGptService chatGptService) { | ||
| super(COMMAND_NAME, "Let AI rephrase and improve your message", CommandVisibility.GUILD); | ||
|
|
||
| this.chatGptService = chatGptService; | ||
|
|
||
| final OptionData messageOption = | ||
| new OptionData(OptionType.STRING, MESSAGE_OPTION, "The message you want to rewrite", | ||
| true) | ||
| .setMinLength(MIN_MESSAGE_LENGTH) | ||
| .setMaxLength(MAX_MESSAGE_LENGTH); | ||
Zabuzard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| final OptionData toneOption = new OptionData(OptionType.STRING, TONE_OPTION, | ||
| "The tone/style for the rewritten message (default: " | ||
| + MessageTone.CLEAR.displayName + ")", | ||
| false); | ||
Taz03 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Arrays.stream(MessageTone.values()) | ||
| .forEach(tone -> toneOption.addChoice(tone.displayName, tone.name())); | ||
|
|
||
| getData().addOptions(messageOption, toneOption); | ||
| } | ||
|
|
||
| @Override | ||
| public void onSlashCommand(SlashCommandInteractionEvent event) { | ||
tj-wazei marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| final OptionMapping messageOption = event.getOption(MESSAGE_OPTION); | ||
|
|
||
| if (messageOption == null) { | ||
| throw new IllegalStateException("Required option '" + MESSAGE_OPTION + "' is missing"); | ||
|
Contributor
There was a problem hiding this comment. Nit: technically correct but semantically, I'd prefer |
||
| } | ||
|
|
||
| final String userMessage = messageOption.getAsString(); | ||
| final MessageTone tone = parseTone(event.getOption(TONE_OPTION)); | ||
|
|
||
| event.deferReply(true).queue(); | ||
|
|
||
| Optional<String> rewrittenMessage = rewrite(userMessage, tone); | ||
|
|
||
| if (rewrittenMessage.isEmpty()) { | ||
| logger.debug("Failed to obtain a response for /{}, original message: '{}'", | ||
| COMMAND_NAME, userMessage); | ||
|
|
||
| event.getHook() | ||
| .editOriginal( | ||
tj-wazei marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "An error occurred while processing your request. Please try again later.") | ||
| .queue(); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| final String rewrittenText = rewrittenMessage.orElseThrow(); | ||
tj-wazei marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| logger.debug("Rewrite successful; rewritten message length: {}", rewrittenText.length()); | ||
|
|
||
| event.getHook().sendMessage(rewrittenText).setEphemeral(true).queue(); | ||
| } | ||
|
|
||
| private MessageTone parseTone(@Nullable OptionMapping toneOption) | ||
| throws IllegalArgumentException { | ||
|
|
||
| if (toneOption == null) { | ||
| logger.debug("Tone option not provided, using default '{}'", MessageTone.CLEAR.name()); | ||
| return MessageTone.CLEAR; | ||
| } | ||
|
|
||
| final String toneValue = toneOption.getAsString(); | ||
|
Contributor
There was a problem hiding this comment. This can be inlined i.e. |
||
|
|
||
| return MessageTone.valueOf(toneValue); | ||
| } | ||
|
|
||
| private Optional<String> rewrite(String userMessage, MessageTone tone) { | ||
|
|
||
| final ChatGptModel aiModel = selectAiModel(tone); | ||
|
|
||
| final String rewritePrompt = createAiPrompt(userMessage, tone); | ||
|
|
||
| Optional<String> attempt = chatGptService.askRaw(rewritePrompt, aiModel); | ||
|
|
||
| if (attempt.isEmpty()) { | ||
| return attempt; | ||
| } | ||
|
|
||
| final String response = attempt.get(); | ||
|
|
||
| if (response.length() <= Message.MAX_CONTENT_LENGTH) { | ||
| return attempt; | ||
| } | ||
|
|
||
| logger.debug("Rewritten message exceeded {} characters; retrying with stricter constraint", | ||
|
Contributor
There was a problem hiding this comment. The rest of this code can be removed if you use the max token parameter. This method can then be: private Optional<String> rewrite(String userMessage, MessageTone tone) {
return chatGptService.askRaw(createAiPrompt(userMessage, tone), selectAiModel(tone)); // if updating askRaw pass the MAX_CONTENT_LENGTH as a parameter
} |
||
| MAX_MESSAGE_LENGTH); | ||
|
|
||
| final String shortenPrompt = rewritePrompt | ||
| + "\n\nConstraint reminder: Your previous rewrite exceeded " + MAX_MESSAGE_LENGTH | ||
| + " characters. Provide a revised rewrite strictly under " + MAX_MESSAGE_LENGTH | ||
| + " characters while preserving meaning and tone."; | ||
|
|
||
| return chatGptService.askRaw(shortenPrompt, aiModel); | ||
| } | ||
|
|
||
| private enum MessageTone { | ||
|
Contributor
There was a problem hiding this comment. As mentioned earlier, you can add the ChatGptModel here and entirely remove the |
||
| CLEAR("Clear", "Make it clear and easy to understand."), | ||
| PROFESSIONAL("Professional", "Use a professional and polished tone."), | ||
| DETAILED("Detailed", "Expand with more detail and explanation."), | ||
| TECHNICAL("Technical", "Use technical and specialized language where appropriate."); | ||
|
|
||
| private final String displayName; | ||
| private final String description; | ||
|
|
||
| MessageTone(String displayName, String description) { | ||
| this.displayName = displayName; | ||
| this.description = description; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we're here now, something we've learned is that the
MAX_TOKENSshould not exceed 2000. Please can you updateMAX_TOKENSto equalMessage.MAX_CONTENT_LENGTH