Add a grammar and spell checker assistant (#72)

2026-10-13 18:33:48 +00:00 · 2024-08-13 08:57:58 +02:00
1 parent 77e7e044e3
commit 05a7e44de4
@@ -49,6 +49,7 @@
                <ThirdPartyComponent Name="flexi_logger" Developer="emabee & Open Source Community" LicenseName="MIT & Apache-2.0" LicenseUrl="https://github.com/emabee/flexi_logger" RepositoryUrl="https://github.com/emabee/flexi_logger" UseCase="This Rust library is used to output the app's messages to the terminal. This is helpful during development and troubleshooting. This feature is initially invisible; when the app is started via the terminal, the messages become visible."/>
                <ThirdPartyComponent Name="HtmlAgilityPack" Developer="ZZZ Projects & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/zzzprojects/html-agility-pack/blob/master/LICENSE" RepositoryUrl="https://github.com/zzzprojects/html-agility-pack" UseCase="We use the HtmlAgilityPack to extract content from the web. This is necessary, e.g., when you provide a URL as input for an assistant."/>
                <ThirdPartyComponent Name="ReverseMarkdown" Developer="Babu Annamalai & Open Source Community" LicenseName="MIT" LicenseUrl="https://github.com/mysticmind/reversemarkdown-net/blob/master/LICENSE" RepositoryUrl="https://github.com/mysticmind/reversemarkdown-net" UseCase="This library is used to convert HTML to Markdown. This is necessary, e.g., when you provide a URL as input for an assistant."/>
+                <ThirdPartyComponent Name="wikEd diff" Developer="Cacycle & Open Source Community" LicenseName="None (public domain)" LicenseUrl="https://en.wikipedia.org/wiki/User:Cacycle/diff#License" RepositoryUrl="https://en.wikipedia.org/wiki/User:Cacycle/diff" UseCase="This library is used to display the differences between two texts. This is necessary, e.g., for the grammar and spelling assistant."/>
            </MudGrid>
        </ExpansionPanel>
        <ExpansionPanel HeaderIcon="@Icons.Material.Filled.Verified" HeaderText="License: FSL-1.1-MIT">
@@ -12,6 +12,7 @@
    <MudStack Row="@true" Wrap="@Wrap.Wrap" Class="mb-3">
        <AssistantBlock Name="Text Summarizer" Description="Using a LLM to summarize a given text." Icon="@Icons.Material.Filled.TextSnippet" Link="/assistant/summarizer"/>
        <AssistantBlock Name="Translation" Description="Translate text into another language." Icon="@Icons.Material.Filled.Translate" Link="/assistant/translation"/>
+        <AssistantBlock Name="Grammar & Spelling" Description="Check grammar and spelling of a given text." Icon="@Icons.Material.Filled.Edit" Link="/assistant/grammar-spelling"/>
    </MudStack>

    <MudText Typo="Typo.h4" Class="mb-2 mr-3 mt-6">
@@ -0,0 +1,11 @@
+@using AIStudio.Tools
+@page "/assistant/grammar-spelling"
+@inherits AssistantBaseCore
+
+<MudTextField T="string" @bind-Text="@this.inputText" Validation="@this.ValidateText" AdornmentIcon="@Icons.Material.Filled.DocumentScanner" Adornment="Adornment.Start" Label="Your input to check" Variant="Variant.Outlined" Lines="6" AutoGrow="@true" MaxLines="12" Class="mb-3" UserAttributes="@USER_INPUT_ATTRIBUTES"/>
+<EnumSelection T="CommonLanguages" NameFunc="@(language => language.NameSelectingOptional())" @bind-Value="@this.selectedTargetLanguage" Icon="@Icons.Material.Filled.Translate" Label="Language" AllowOther="@true" OtherValue="CommonLanguages.OTHER" @bind-OtherInput="@this.customTargetLanguage" ValidateOther="@this.ValidateCustomLanguage" LabelOther="Custom language" />
+<ProviderSelection @bind-ProviderSettings="@this.providerSettings" ValidateProvider="@this.ValidatingProvider"/>
+
+<MudButton Variant="Variant.Filled" Class="mb-3" OnClick="() => this.ProofreadText()">
+    Proofread
+</MudButton>
@@ -0,0 +1,84 @@
+using AIStudio.Tools;
+
+namespace AIStudio.Components.Pages.GrammarSpelling;
+
+public partial class AssistantGrammarSpelling : AssistantBaseCore
+{
+    protected override string Title => "Grammar and Spelling Checker";
+    
+    protected override string Description =>
+        """
+        Check the grammar and spelling of a text.
+        """;
+    
+    protected override string SystemPrompt => 
+        $"""
+        You are an expert in languages and their rules. For example, you know how US and UK English or German in
+        Germany and German in Austria differ. You receive text as input. You check the spelling and grammar of
+        this text according to the rules of {this.SystemPromptLanguage()}. You never add information. You
+        never ask the user for additional information. You do not attempt to improve the wording of the text.
+        Your response includes only the corrected text. Do not explain your changes. If no changes are needed,
+        you return the text unchanged.
+        """;
+
+    protected override bool ShowResult => false;
+    
+    protected override IReadOnlyList<ButtonData> FooterButtons => new[]
+    {
+        new ButtonData("Copy corrected text", Icons.Material.Filled.ContentCopy, Color.Default, string.Empty, this.CopyToClipboard),
+    };
+
+    private string inputText = string.Empty;
+    private CommonLanguages selectedTargetLanguage;
+    private string customTargetLanguage = string.Empty;
+    private string correctedText = string.Empty;
+
+    private string? ValidateText(string text)
+    {
+        if(string.IsNullOrWhiteSpace(text))
+            return "Please provide a text as input. You might copy the desired text from a document or a website.";
+        
+        return null;
+    }
+    
+    private string? ValidateCustomLanguage(string language)
+    {
+        if(this.selectedTargetLanguage == CommonLanguages.OTHER && string.IsNullOrWhiteSpace(language))
+            return "Please provide a custom language.";
+        
+        return null;
+    }
+    
+    private string SystemPromptLanguage()
+    {
+        var lang = this.selectedTargetLanguage switch
+        {
+            CommonLanguages.AS_IS => "the source language",
+            CommonLanguages.OTHER => this.customTargetLanguage,
+            
+            _ => $"{this.selectedTargetLanguage.Name()}",
+        };
+
+        if (string.IsNullOrWhiteSpace(lang))
+            return "the source language";
+
+        return lang;
+    }
+
+    private async Task ProofreadText()
+    {
+        if (!this.inputIsValid)
+            return;
+        
+        this.CreateChatThread();
+        var time = this.AddUserRequest(this.inputText);
+        
+        this.correctedText = await this.AddAIResponseAsync(time);
+        await this.JsRuntime.GenerateAndShowDiff(this.inputText, this.correctedText);
+    }
+    
+    private async Task CopyToClipboard()
+    {
+        await this.Rust.CopyText2Clipboard(this.JsRuntime, this.Snackbar, this.correctedText);
+    }
+}