ServerAssistantAI 1.3.2

IMPORTANT: After updating, update your prompt files by either:

1. Deleting the files and letting them regenerate.
2. Manually deleting the prompt tokens from the files (e.g., <|START_OF_TURN_TOKEN|><|SYSTEM_TOKEN|>, <|END_OF_TURN_TOKEN|><|START_OF_TURN_TOKEN|><|USER_TOKEN|>) and adding and write the response within the same line. to the last line of your prompt-header.txt files.
3. Using the paste links below to update the file contents:
   
   1. Minecraft:
      
      1. prompt-header.txt: https://paste.code-solutions.dev/acedivosap.text
      2. information-message.txt: https://paste.code-solutions.dev/wuhovuqatu.text
      3. question-message.txt: https://paste.code-solutions.dev/ayodojogaj.text

Discord:

1. prompt-header.txt: https://paste.code-solutions.dev/ebiwinamic.text
2. information-message.txt: https://paste.code-solutions.dev/sucekaqize.text
3. question-message.txt: https://paste.code-solutions.dev/cemehuceqi.text

New Features:

1. Introduced a global limits system for both Minecraft and Discord to help manage usage.
2. Added title and bossbar support for in-game replying animation, now supporting TITLE, SUBTITLE, and BOSSBAR. Defaults to BOSSBAR.
3. Support for Discord user interactions and new separate interaction message files for Minecraft and Discord in the new interaction-messages/ directory, with the Discord Embed Creator now supporting interaction messages for both platforms as well.

Enhancements:

1. Removed token prompts and updated Discord and Minecraft prompts to generate single-line responses.
2. Rewrote API Response classes for Cohere to make sure it works with any Jackson version on any version.
3. Improved performance by handling the usage command mostly on executor service threads.
4. Added a configurable sound for when the AI starts processing a question.
5. Added a maximum character limit to both Minecraft and Discord.
6. Added xAI as a pre-configured provider for both Embedding and Chat Models.
7. Added Nvidia-Models as a pre-configured provider for Chat Models.
8. Added OpenAI-Variant as a pre-configured provider to be used for providers requiring custom base_url.

Bug Fixes & Improvements:

1. On Discord, if a user sends a message but immediately deletes the message or the message is auto-deleted by a bot, the handling process will be stopped.
2. On Discord, if a user tags the bot, the skip keyword will no longer be factored in.
3. Fixed some issues related to parsing history.
4. Fixed Jackson embedding store codec issues that were occurring on some servers.
5. Updated the replying_title field name in messages.yml file to just replying.

Addon Updates:

1. Google AI Studio Addon:
   
   1. Embedding model support has been added back. We recommend using text-embedding-004 for embeddings.

IMPORTANT: After updating, please make the following changes:

1. Delete the interaction-message.json file and let it regenerate.
2. Manually add the {channel} placeholder for Discord’s question-message.txt file or use the paste link below:
   Discord question-message.txt: https://paste.code-solutions.dev/utoyozunuv.text
3. Manually add the {ignore-question} placeholder in the question-message.txt for both Minecraft and Discord or use the following paste links below:
   Minecraft question-message.txt: https://paste.code-solutions.dev/ukeyodanot.text
   Discord question-message.txt: https://paste.code-solutions.dev/utoyozunuv.text

Enhancements:

1. Migrated Cohere’s API from v1 to their new v2 API
2. Added {channel} placeholder for question-message.txt file for Discord messages
3. Added a new comment line regarding how to obtain API keys for each provider in the credentials.yml header
4. Added {ignore-question} placeholder in the question-message.txt file for both Minecraft and Discord
5. Added Github-Models as a Pre-configured Provider

Config Changes:

1. Removed unnecessary thumbnail.icon_url field from the thumbnail section in default interaction-message.json file

After months of development, we are excited to announce the release of ServerAssistantAI v1.3, packed with exciting new features, improvements, and bug fixes! All the detailed information for the new features in v1.3 are included on our wiki.

IMPORTANT: After updating, please make the following changes:

• Delete the interaction-message.json file and let it regenerate.
• Manually add the new history exclude message.
• If you are using an addon, be sure to update the addon to the latest version.
• Update the prompts in the information-message.txt, prompt-header.txt and question-message.txt files for both Minecraft and Discord, as well as the updated ignore_question. Deleting these files will also regenerate with the updated text. The updated prompts are available on our wiki, as well as the following paste links:
  • Minecraft prompt-header.txt: [url]https://paste.code-solutions.dev/xuxuciqiqa.text[/url]
  • Minecraft information-message.txt: [url]https://paste.code-solutions.dev/vojejezibi.text[/url]
  • Minecraft question-message.txt: [url]https://paste.code-solutions.dev/afujekerih.text[/url]
  • Discord prompt-header.txt: [url]https://paste.code-solutions.dev/xarefuqoye.text[/url]
  • Discord information-message.txt: [url]https://paste.code-solutions.dev/fuyekunoco.text[/url]
  • Discord question-message.txt: [url]https://paste.code-solutions.dev/ukagicucur.text[/url]
  • Minecraft and Discord ignore_question: [url]https://paste.code-solutions.dev/ofuhiwuzog.yaml[/url]
• Update exclude: [url]https://paste.code-solutions.dev/yotinotuko.yaml[/url]

Major New Features:

• Complete removal of required dependencies like DiscordSRV and DiscordSRVUtils for Discord features, now using built-in JDA 5 (Java Discord API) for improved Discord integration
• New messages.yml file for customizing most of the text on Minecraft and Discord
• Support for multiple information file types (.txt, .md, .pdf, Word, Excel, PowerPoint) and files in the new documents/ directory instead of just one document.txt file, including sub-folders within the new directory for better organization
• New Continuous Chat Mode for a continuous private conversation with the AI with context across multiple messages for Minecraft
• JSON mode to receive AI responses in JSON format and reduce unnecessary additional text
• Implemented chat history support for Minecraft
• Question detection for Discord with support for channels, forums, categories, and threads

New Commands: Minecraft:

• /serverassistantai chat: Start a continuous private conversation mode with the AI
• /serverassistantai reset: Resets a specific player's usage for the day
• /serverassistantai usage now has an option for admins or those with permissions to check other users' usage

Discord:

• /ai toggle: Toggle automatically answering user's questions on Discord
• /ai reset: Resets a specific user's usage for the day on Discord
• /ai usage now has an option for admins or those with permissions to check other users' usage
• Ask AI App: Right-click any message, select 'Apps' > 'Ask AI' for an AI response to that message, even if it's not your own message

Enhancements:

• Major improvements related to providers and credentials system, more information about this available here
• Small API & JavaDoc improvements
• Updated default ignore_question text for better AI decision-making
• Improved prompt-header.txt, information-message.txt, and question-message.txt prompts for both Minecraft and Discord for better AI responses
• The help command now only shows commands that the player has permission for

Config Changes:

• Improved helpful_information section with detailed paste option and separate Discord/Minecraft settings
• Added reply_format for Discord responses with options for either embeds or plain text with custom messages, along with a new default footer text. Embed responses can be customized using our new Embed Creator interface, which also offers embed support for interaction-message.json file
• Added bot_status to set a custom status for your standalone Discord bot
• Added webhook_url option for sending interaction messages instead of using the Discord bot
• Added max_history and chat_max_history options to set the maximum number of messages sent to the AI model for context
• Updated default ignore_question text
• Added json_mode option to prompt the bot to respond in JSON format
• Added question_detection_channels to specify Discord channels, forums, or categories where the bot will detect and respond to questions
• Added admin_roles to specify Discord roles that can check the usage of other users and reset daily limits
• Added respond_to_pings to control whether the bot should respond to users on Discord who ping it in a message
• Question detection provider can now be set to 'none' to disable question detection

Other Changes:

• When helpful_information is enabled for Discord, buttons are now shown instead of embedded links
• Response time is now included in the response paste when helpful_information is enabled
• Added .text to the end of every paste URL when helpful_information is enabled

Addon Updates:

• All addons have been updated to be compatible with ServerAssistantAI v1.3. Make sure to download the latest versions from the #saai-addons channel on our Discord server
• Advanced Question Detection Addon: Fixed compatibility issue with Minecraft versions 1.20.2 and older

New Chat Listener Feature:

1. Added a chat_listener section to the config to help with compatibility issues with other plugins. You can now configure the chat listener priority, whether to use Paper's AsyncChatEvent, and ignore cancelled chat events.

Enhancements:

1. Added sample text in the document.txt file that provides a template for the document.
2. Discord functionality is now disabled by default when the plugin directory is first loaded.
3. The plugin will now fallback to old methods of getting the username if new methods are not available for compatibility with older DiscordSRV versions.
4. The Minecraft config section is now above the Discord section for better organization.
5. If the bot is tagged on Discord, the minimum word count for a response will no longer apply.
6. Updated the domain for uploading pastes when helpful_information is enabled in the config to paste.code-solutions.dev.
7. The Discord folder will now always generate even if DiscordSRV is not installed.
8. Improved some comments to better explain fields in the config.
9. More built-in texts that are automatically removed from AI responses to improve filtering.
10. Further small changes to the default prompt files for better AI interactions.
11. When helpful_information is enabled, the Result and Information text will now be shown as emojis on the same line at the end of the response for a cleaner look.
12. The Minecraft version will now show in the startup splash for servers that support it.

API Changes:

1. Removed langchain4j-embeddings from the Javadoc since it no longer applies.

Bug Fixes:

1. Fixed the /serverassistantai reload command not working properly on Folia servers.
2. Fixed issues with the plugin not loading properly on some Spigot servers.

Addon Updates:

1. Google AI Studio Addon (NEW!):
   1. Leverage Google's most advanced Gemini generative AI models for free, including Gemini 1.5 Flash and Gemini 1.5 Pro.
   2. Access Google's powerful embedding models.

Advanced Question Detection Addon:

1. Added support for regex patterns in the minecraft.question_detection.regex field of the config to detect questions more flexibly.
2. New debug_in_game option that will show the probability of each message being a question in-game to OPs and players with the serverassistantai.advanced-question-detection.debug permission.

New Discord Command:

1. Added a new /ai usage slash command on Discord that allows users to privately check their daily AI usage statistics, including the number of questions asked and remaining daily limit.

Enhancements:

1. Small changes to the default prompt files for better AI interactions.
2. Renamed /ai stats in-game command to /ai usage for clarity.
3. Implemented an update checker to notify server owners about new ServerAssistantAI updates.
4. Added a new permission serverassistantai.updatecheck that allows players to be notified about ServerAssistantAI updates. This permission is granted to all OP players by default.

Config Changes:

1. Added support for defining multiple user groups with different daily limits for both Minecraft and Discord.
   • In-game users can be assigned to a specific group using the permission serverassistantai.group.<group>.
   • Discord users can be assigned to a group using either the role ID or role name in the config.
2. Introduced a new Response Filtering section in the config:
   • Added an exclude list to specify elements that should be removed from the AI's responses (case-insensitive). This is in addition to the built-in list of elements that are always removed.
   • Added a stop list to define words that will cause the AI to stop a response immediately after encountering them.
3. Added a new blocked_roles option in the Discord config section to restrict specific roles from using the AI.Made some changes to the config comments for better clarity and understanding.

API Changes:

1. Renamed JDAManager#isStarted() to isReady() for more accurate naming.
2. Added API methods for getting current player/user limits.

Bug Fixes:

1. Fixed an issue where the plugin did not properly notify the player of an internal error if DiscordSRVUtils was not installed.
2. Split Cohere embedding requests if there are more than 96 segments to avoid exceeding the API limit.

Other Changes:

1. The plugin now fails to reload if there are syntax errors or type errors in the config, providing better error handling.

Bug Fixes:

1. Fixed some bugs related to the {history} placeholder in the information-message.txt file.

API Changes:

1. Added JDAManager#isStarted() method to check if the JDAManager has been started.
2. Improved JDAManager Javadoc for better documentation and clarity.

Enhancements:

1. Moved the history section for Discord to the information-message.txt file.
2. Allow {history} placeholder in information-message.txt.

Bug Fixes:

1. Fixed an issue with the DiscordSRV standalone bot not starting up.

API Changes:

1. When you add the plugin's API using maven/gradle it will no longer try to download langchain4j-embeddings and DiscordSRV dependencies.

Other Changes:

1. Update splitter.max_segment comment to provide information for longer documents.

New Default Provider:

1. Added Cohere as the new default free provider for both embedding and chat models, replacing HuggingFace. Cohere’s models significantly improve response quality and speed.

New Features:

1. Added a config option to disable Discord functionality features.
2. Allow setting the base URL of OpenAI API compatible chat model/embedding model.
3. Added a config option to change or disable the sound played when player receives a response in-game.

New API Features:

1. Added isPrivately() to PreMinecraftHandleEvent and PostMinecraftHandleEvent.
2. Added waitForPlugin() to API which forces ServerAssistantAI to wait for a plugin to enable before loading configurations.

Enhancements:

1. Updated default message prompts to work best with Cohere.
2. Allow more properties to be set for built-in providers.
3. Use minimum words for both Minecraft and Discord, defaulting both to 3.
4. Further improved responses starting on the next line.
5. Allow setting frequency & presence penalty for Cohere & OpenAI chat model providers.

Bug Fixes:

1. Fixed credentials not calling fillDefaults().

Other Changes:

1. HuggingFace is now available as an addon since it has been replaced by Cohere as the default free provider.
2. Print a message on successful configurations load.
3. Changed website in plugin.yml to code-solutions.dev.
4. Avoid automatic remapping on paper servers as it is not needed since NMS is not used.
5. Added a workaround for some Spigot versions not properly loading libraries.