Added synonym assistant (#124)

app/MindWork AI Studio/Assistants/Synonym/AssistantSynonyms.razor

@@ -0,0 +1,12 @@
+@attribute [Route(Routes.ASSISTANT_SYNONYMS)]
+@inherits AssistantBaseCore
+
+<MudTextField T="string" @bind-Text="@this.inputText" Validation="@this.ValidatingText" AdornmentIcon="@Icons.Material.Filled.Spellcheck" Adornment="Adornment.Start" Label="Your word or phrase" Variant="Variant.Outlined" Class="mb-3" UserAttributes="@USER_INPUT_ATTRIBUTES"/>
+<MudTextField T="string" @bind-Text="@this.inputContext" AdornmentIcon="@Icons.Material.Filled.Description" Adornment="Adornment.Start" Lines="2" AutoGrow="@false" Label="(Optional) The context for the given word or phrase" Variant="Variant.Outlined" Class="mb-3" UserAttributes="@USER_INPUT_ATTRIBUTES"/>
+
+<EnumSelection T="CommonLanguages" NameFunc="@(language => language.NameSelectingOptional())" @bind-Value="@this.selectedLanguage" Icon="@Icons.Material.Filled.Translate" Label="Language" AllowOther="@true" OtherValue="CommonLanguages.OTHER" @bind-OtherInput="@this.customTargetLanguage" ValidateOther="@this.ValidateCustomLanguage" LabelOther="Custom target language" />
+<ProviderSelection @bind-ProviderSettings="@this.providerSettings" ValidateProvider="@this.ValidatingProvider"/>
+
+<MudButton Variant="Variant.Filled" Class="mb-3" OnClick="() => this.FindSynonyms()">
+    Get synonyms
+</MudButton>

app/MindWork AI Studio/Assistants/Synonym/AssistantSynonyms.razor.cs

@@ -0,0 +1,164 @@
+using AIStudio.Chat;
+
+namespace AIStudio.Assistants.Synonym;
+
+public partial class AssistantSynonyms : AssistantBaseCore
+{
+    protected override Tools.Components Component => Tools.Components.SYNONYMS_ASSISTANT;
+    
+    protected override string Title => "Synonyms";
+    
+    protected override string Description =>
+        """
+        Find synonyms for words or phrases.
+        """;
+    
+    protected override string SystemPrompt => 
+        $"""
+        You have a PhD in linguistics. Therefore, you are an expert in the {this.SystemPromptLanguage()} language.
+        You receive a word or phrase as input. You might also receive some context. You then provide
+        a list of synonyms as a Markdown list.
+        
+        First, derive possible meanings from the word, phrase, and context, when available. Then, provide
+        possible synonyms for each meaning.
+        
+        Example for the word "learn" and the language English (US):
+        
+        Derive possible meanings (*this list is not part of the output*):
+        - Meaning "to learn"
+        - Meaning "to retain"
+        
+        Next, provide possible synonyms for each meaning, which is your output:
+        
+        # Meaning "to learn"
+          - absorb
+          - study
+          - acquire
+          - advance
+          - practice
+        
+        # Meaning "to retain"
+          - remember
+          - note
+          - realize
+        
+        You do not ask follow-up questions and never repeat the task instructions. When you do not know
+        any synonyms for the given word or phrase, you state this. Your output is always in
+        the {this.SystemPromptLanguage()} language.
+        """;
+    
+    protected override IReadOnlyList<IButtonData> FooterButtons => [];
+    
+    protected override ChatThread ConvertToChatThread => (this.chatThread ?? new()) with
+    {
+        SystemPrompt = SystemPrompts.DEFAULT,
+    };
+
+    protected override void ResetFrom()
+    {
+        this.inputText = string.Empty;
+        this.inputContext = string.Empty;
+        if (!this.MightPreselectValues())
+        {
+            this.selectedLanguage = CommonLanguages.AS_IS;
+            this.customTargetLanguage = string.Empty;
+        }
+    }
+    
+    protected override bool MightPreselectValues()
+    {
+        if (this.SettingsManager.ConfigurationData.Synonyms.PreselectOptions)
+        {
+            this.selectedLanguage = this.SettingsManager.ConfigurationData.Synonyms.PreselectedLanguage;
+            this.customTargetLanguage = this.SettingsManager.ConfigurationData.Synonyms.PreselectedOtherLanguage;
+            return true;
+        }
+        
+        return false;
+    }
+    
+    private string inputText = string.Empty;
+    private string inputContext = string.Empty;
+    private CommonLanguages selectedLanguage;
+    private string customTargetLanguage = string.Empty;
+    
+    #region Overrides of ComponentBase
+
+    protected override async Task OnInitializedAsync()
+    {
+        var deferredContent = MessageBus.INSTANCE.CheckDeferredMessages<string>(Event.SEND_TO_SYNONYMS_ASSISTANT).FirstOrDefault();
+        if (deferredContent is not null)
+            this.inputContext = deferredContent;
+        
+        await base.OnInitializedAsync();
+    }
+
+    #endregion
+    
+    private string? ValidatingText(string text)
+    {
+        if(string.IsNullOrWhiteSpace(text))
+            return "Please provide a word or phrase as input.";
+        
+        return null;
+    }
+    
+    private string? ValidateCustomLanguage(string language)
+    {
+        if(this.selectedLanguage == CommonLanguages.OTHER && string.IsNullOrWhiteSpace(language))
+            return "Please provide a custom language.";
+        
+        return null;
+    }
+    
+    private string SystemPromptLanguage()
+    {
+        var lang = this.selectedLanguage switch
+        {
+            CommonLanguages.AS_IS => "source",
+            CommonLanguages.OTHER => this.customTargetLanguage,
+            
+            _ => $"{this.selectedLanguage.Name()}",
+        };
+
+        if (string.IsNullOrWhiteSpace(lang))
+            return "source";
+
+        return lang;
+    }
+
+    private string UserPromptContext()
+    {
+        if(string.IsNullOrWhiteSpace(this.inputContext))
+            return string.Empty;
+        
+        return $"""
+                The given context is:
+                
+                ```
+                {this.inputContext}
+                ```
+                
+                """;
+    }
+    
+    private async Task FindSynonyms()
+    {
+        await this.form!.Validate();
+        if (!this.inputIsValid)
+            return;
+        
+        this.CreateChatThread();
+        var time = this.AddUserRequest(
+            $"""
+                {this.UserPromptContext()}
+                The given word or phrase is:
+                
+                ```
+                {this.inputText}
+                ```
+             """);
+
+        await this.AddAIResponseAsync(time);
+    }
+}

app/MindWork AI Studio/Pages/Assistants.razor

@@ -14,6 +14,7 @@
         <AssistantBlock Name="Translation" Description="Translate text into another language." Icon="@Icons.Material.Filled.Translate" Link="@Routes.ASSISTANT_TRANSLATION"/>
         <AssistantBlock Name="Grammar & Spelling" Description="Check grammar and spelling of a given text." Icon="@Icons.Material.Filled.Edit" Link="@Routes.ASSISTANT_GRAMMAR_SPELLING"/>
         <AssistantBlock Name="Rewrite & Improve" Description="Rewrite and improve a given text for a chosen style." Icon="@Icons.Material.Filled.Edit" Link="@Routes.ASSISTANT_REWRITE"/>
+        <AssistantBlock Name="Synonyms" Description="Find synonyms for a given word or phrase." Icon="@Icons.Material.Filled.Spellcheck" Link="@Routes.ASSISTANT_SYNONYMS"/>
     </MudStack>
 
     <MudText Typo="Typo.h4" Class="mb-2 mr-3 mt-6">

app/MindWork AI Studio/Pages/Settings.razor

@@ -180,7 +180,7 @@
         <ExpansionPanel HeaderIcon="@Icons.Material.Filled.Edit" HeaderText="Assistant: Grammar & Spelling Checker">
             <MudPaper Class="pa-3 mb-8 border-dashed border rounded-lg">
                 <ConfigurationOption OptionDescription="Preselect grammar & spell checker options?" LabelOn="Grammar & spell checker options are preselected" LabelOff="No grammar & spell checker options are preselected" State="@(() => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectOptions)" StateUpdate="@(updatedState => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectOptions = updatedState)" OptionHelp="When enabled, you can preselect the grammar & spell checker options. This is might be useful when you prefer a specific language or LLM model."/>
-                <ConfigurationSelect OptionDescription="Preselect the target language" Disabled="@(() => !this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectedTargetLanguage)" Data="@ConfigurationSelectDataFactory.GetCommonLanguagesTranslationData()" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectedTargetLanguage = selectedValue)" OptionHelp="Which target language should be preselected?"/>
+                <ConfigurationSelect OptionDescription="Preselect the target language" Disabled="@(() => !this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectedTargetLanguage)" Data="@ConfigurationSelectDataFactory.GetCommonLanguagesOptionalData()" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectedTargetLanguage = selectedValue)" OptionHelp="Which target language should be preselected?"/>
                 @if (this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectedTargetLanguage is CommonLanguages.OTHER)
                 {
                     <ConfigurationText OptionDescription="Preselect another target language" Disabled="@(() => !this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectOptions)" Icon="@Icons.Material.Filled.Translate" Text="@(() => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectedOtherLanguage)" TextUpdate="@(updatedText => this.SettingsManager.ConfigurationData.GrammarSpelling.PreselectedOtherLanguage = updatedText)"/>
@@ -192,7 +192,7 @@
         <ExpansionPanel HeaderIcon="@Icons.Material.Filled.Edit" HeaderText="Assistant: Rewrite & Improve Text">
             <MudPaper Class="pa-3 mb-8 border-dashed border rounded-lg">
                 <ConfigurationOption OptionDescription="Preselect rewrite & improve text options?" LabelOn="Rewrite & improve text options are preselected" LabelOff="No rewrite & improve text options are preselected" State="@(() => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectOptions)" StateUpdate="@(updatedState => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectOptions = updatedState)" OptionHelp="When enabled, you can preselect the rewrite & improve text options. This is might be useful when you prefer a specific language or LLM model."/>
-                <ConfigurationSelect OptionDescription="Preselect the target language" Disabled="@(() => !this.SettingsManager.ConfigurationData.RewriteImprove.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectedTargetLanguage)" Data="@ConfigurationSelectDataFactory.GetCommonLanguagesTranslationData()" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectedTargetLanguage = selectedValue)" OptionHelp="Which target language should be preselected?"/>
+                <ConfigurationSelect OptionDescription="Preselect the target language" Disabled="@(() => !this.SettingsManager.ConfigurationData.RewriteImprove.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectedTargetLanguage)" Data="@ConfigurationSelectDataFactory.GetCommonLanguagesOptionalData()" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectedTargetLanguage = selectedValue)" OptionHelp="Which target language should be preselected?"/>
                 @if (this.SettingsManager.ConfigurationData.RewriteImprove.PreselectedTargetLanguage is CommonLanguages.OTHER)
                 {
                     <ConfigurationText OptionDescription="Preselect another target language" Disabled="@(() => !this.SettingsManager.ConfigurationData.RewriteImprove.PreselectOptions)" Icon="@Icons.Material.Filled.Translate" Text="@(() => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectedOtherLanguage)" TextUpdate="@(updatedText => this.SettingsManager.ConfigurationData.RewriteImprove.PreselectedOtherLanguage = updatedText)"/>
@@ -228,6 +228,18 @@
             </MudPaper>
         </ExpansionPanel>
     
+        <ExpansionPanel HeaderIcon="@Icons.Material.Filled.Spellcheck" HeaderText="Assistant: Synonyms">
+            <MudPaper Class="pa-3 mb-8 border-dashed border rounded-lg">
+                <ConfigurationOption OptionDescription="Preselect synonym options?" LabelOn="Synonym options are preselected" LabelOff="No synonym options are preselected" State="@(() => this.SettingsManager.ConfigurationData.Synonyms.PreselectOptions)" StateUpdate="@(updatedState => this.SettingsManager.ConfigurationData.Synonyms.PreselectOptions = updatedState)" OptionHelp="When enabled, you can preselect synonym options. This is might be useful when you prefer a specific language or LLM model."/>
+                <ConfigurationSelect OptionDescription="Preselect the language" Disabled="@(() => !this.SettingsManager.ConfigurationData.Synonyms.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.Synonyms.PreselectedLanguage)" Data="@ConfigurationSelectDataFactory.GetCommonLanguagesOptionalData()" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.Synonyms.PreselectedLanguage = selectedValue)" OptionHelp="Which language should be preselected?"/>
+                @if (this.SettingsManager.ConfigurationData.Synonyms.PreselectedLanguage is CommonLanguages.OTHER)
+                {
+                    <ConfigurationText OptionDescription="Preselect another language" Disabled="@(() => !this.SettingsManager.ConfigurationData.Synonyms.PreselectOptions)" Icon="@Icons.Material.Filled.Translate" Text="@(() => this.SettingsManager.ConfigurationData.Synonyms.PreselectedOtherLanguage)" TextUpdate="@(updatedText => this.SettingsManager.ConfigurationData.Synonyms.PreselectedOtherLanguage = updatedText)"/>
+                }
+                <ConfigurationProviderSelection Data="@this.availableProviders" Disabled="@(() => !this.SettingsManager.ConfigurationData.Synonyms.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.Synonyms.PreselectedProvider)" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.Synonyms.PreselectedProvider = selectedValue)"/>
+            </MudPaper>
+        </ExpansionPanel>
+        
         <ExpansionPanel HeaderIcon="@Icons.Material.Filled.TextFields" HeaderText="Agent: Text Content Cleaner Options">
             <MudPaper Class="pa-3 mb-8 border-dashed border rounded-lg">
                 <MudText Typo="Typo.body1" Class="mb-3">

app/MindWork AI Studio/Routes.razor.cs

@@ -19,5 +19,6 @@ public sealed partial class Routes
     public const string ASSISTANT_AGENDA = "/assistant/agenda";
     public const string ASSISTANT_EMAIL = "/assistant/email";
     public const string ASSISTANT_LEGAL_CHECK = "/assistant/legal-check";
+    public const string ASSISTANT_SYNONYMS = "/assistant/synonyms";
     // ReSharper restore InconsistentNaming
 }

app/MindWork AI Studio/Settings/ConfigurationSelectData.cs

@@ -86,6 +86,15 @@ public static class ConfigurationSelectDataFactory
                 yield return new(language.Name(), language);
     }
     
+    public static IEnumerable<ConfigurationSelectData<CommonLanguages>> GetCommonLanguagesOptionalData()
+    {
+        foreach (var language in Enum.GetValues<CommonLanguages>())
+            if(language is CommonLanguages.AS_IS)
+                yield return new("Do not specify the language", language);
+            else
+                yield return new(language.Name(), language);
+    }
+    
     public static IEnumerable<ConfigurationSelectData<CommonCodingLanguages>> GetCommonCodingLanguagesData()
     {
         foreach (var language in Enum.GetValues<CommonCodingLanguages>())

app/MindWork AI Studio/Settings/DataModel/Data.cs

@@ -46,4 +46,6 @@ public sealed class Data
     public DataEMail EMail { get; set; } = new();
     
     public DataLegalCheck LegalCheck { get; set; } = new();
+    
+    public DataSynonyms Synonyms { get; set; } = new();
 }

app/MindWork AI Studio/Settings/DataModel/DataSynonyms.cs

@@ -0,0 +1,24 @@
+namespace AIStudio.Settings.DataModel;
+
+public sealed class DataSynonyms
+{
+    /// <summary>
+    /// Preselect any rewrite options?
+    /// </summary>
+    public bool PreselectOptions { get; set; }
+    
+    /// <summary>
+    /// Preselect the language?
+    /// </summary>
+    public CommonLanguages PreselectedLanguage { get; set; }
+    
+    /// <summary>
+    /// Preselect any other language?
+    /// </summary>
+    public string PreselectedOtherLanguage { get; set; } = string.Empty;
+    
+    /// <summary>
+    /// Preselect a provider?
+    /// </summary>
+    public string PreselectedProvider { get; set; } = string.Empty;
+}

app/MindWork AI Studio/Settings/SettingsManager.cs

@@ -128,6 +128,7 @@ public sealed class SettingsManager(ILogger<SettingsManager> logger)
             Tools.Components.TEXT_SUMMARIZER_ASSISTANT => this.ConfigurationData.TextSummarizer.PreselectOptions ? this.ConfigurationData.Providers.FirstOrDefault(x => x.Id == this.ConfigurationData.TextSummarizer.PreselectedProvider) : default,
             Tools.Components.EMAIL_ASSISTANT => this.ConfigurationData.EMail.PreselectOptions ? this.ConfigurationData.Providers.FirstOrDefault(x => x.Id == this.ConfigurationData.EMail.PreselectedProvider) : default,
             Tools.Components.LEGAL_CHECK_ASSISTANT => this.ConfigurationData.LegalCheck.PreselectOptions ? this.ConfigurationData.Providers.FirstOrDefault(x => x.Id == this.ConfigurationData.LegalCheck.PreselectedProvider) : default,
+            Tools.Components.SYNONYMS_ASSISTANT => this.ConfigurationData.Synonyms.PreselectOptions ? this.ConfigurationData.Providers.FirstOrDefault(x => x.Id == this.ConfigurationData.Synonyms.PreselectedProvider) : default,
             
             _ => default,
         };

app/MindWork AI Studio/Tools/Components.cs

@@ -13,6 +13,7 @@ public enum Components
     TEXT_SUMMARIZER_ASSISTANT,
     EMAIL_ASSISTANT,
     LEGAL_CHECK_ASSISTANT,
+    SYNONYMS_ASSISTANT,
     
     CHAT,
 }

app/MindWork AI Studio/Tools/Event.cs

@@ -27,4 +27,5 @@ public enum Event
     SEND_TO_CHAT,
     SEND_TO_EMAIL_ASSISTANT,
     SEND_TO_LEGAL_CHECK_ASSISTANT,
+    SEND_TO_SYNONYMS_ASSISTANT,
 }

app/MindWork AI Studio/packages.lock.json

@@ -178,6 +178,6 @@
         "contentHash": "FHNOatmUq0sqJOkTx+UF/9YK1f180cnW5FVqnQMvYUN0elp6wFzbtPSiqbo1/ru8ICp43JM1i7kKkk6GsNGHlA=="
       }
     },
-    "net8.0/osx-x64": {}
+    "net8.0/osx-arm64": {}
   }
 }

app/MindWork AI Studio/wwwroot/changelog/v0.9.4.md

@@ -0,0 +1,3 @@
+# v0.9.4, build 179 (2024-09-06 xx:xx UTC)
+- Added a synonym assistant to find synonyms for words or a phrase.
+- Added possibility to preselect some synonym options on the settings page.