Added a legal check assistant & the possibility to preselect some options (#94)

2025-04-27 23:19:46 +00:00 · 2024-08-23 21:47:07 +02:00 · 2024-08-23 21:47:07 +02:00 · 4aaa2fcbea
commit 4aaa2fcbea
parent d855a33e6f
11 changed files with 167 additions and 0 deletions
--- a/Studio/Assistants/LegalCheck/AssistantLegalCheck.razor
+++ b/Studio/Assistants/LegalCheck/AssistantLegalCheck.razor
@ -0,0 +1,15 @@
+@attribute [Route(Routes.ASSISTANT_LEGAL_CHECK)]
+@inherits AssistantBaseCore
+
+@if (!this.SettingsManager.ConfigurationData.LegalCheck.HideWebContentReader)
+{
+    <ReadWebContent @bind-Content="@this.inputLegalDocument" ProviderSettings="@this.providerSettings" @bind-AgentIsRunning="@this.isAgentRunning" Preselect="@(this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions && this.SettingsManager.ConfigurationData.LegalCheck.PreselectWebContentReader)" PreselectContentCleanerAgent="@(this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions && this.SettingsManager.ConfigurationData.LegalCheck.PreselectContentCleanerAgent)"/>
+}
+
+<MudTextField T="string" Disabled="@this.isAgentRunning" @bind-Text="@this.inputLegalDocument" Validation="@this.ValidatingLegalDocument" AdornmentIcon="@Icons.Material.Filled.DocumentScanner" Adornment="Adornment.Start" Label="Legal document" Variant="Variant.Outlined" Lines="12" AutoGrow="@true" MaxLines="24" Class="mb-3" UserAttributes="@USER_INPUT_ATTRIBUTES"/>
+<MudTextField T="string" Disabled="@this.isAgentRunning" @bind-Text="@this.inputQuestions" Validation="@this.ValidatingQuestions" AdornmentIcon="@Icons.Material.Filled.QuestionAnswer" Adornment="Adornment.Start" Label="Your questions" Variant="Variant.Outlined" Lines="6" AutoGrow="@true" MaxLines="12" Class="mb-3" UserAttributes="@USER_INPUT_ATTRIBUTES"/>
+<ProviderSelection @bind-ProviderSettings="@this.providerSettings" ValidateProvider="@this.ValidatingProvider"/>
+
+<MudButton Disabled="@this.isAgentRunning" Variant="Variant.Filled" Class="mb-3" OnClick="() => this.AksQuestions()">
+    Ask your questions
+</MudButton>
--- a/Studio/Assistants/LegalCheck/AssistantLegalCheck.razor.cs
+++ b/Studio/Assistants/LegalCheck/AssistantLegalCheck.razor.cs
@ -0,0 +1,103 @@
+using AIStudio.Tools;
+
+namespace AIStudio.Assistants.LegalCheck;
+
+public partial class AssistantLegalCheck : AssistantBaseCore
+{
+    protected override string Title => "Legal Check";
+    
+    protected override string Description =>
+        """
+        Provide a legal document and ask a question about it. This assistant does not
+        replace legal advice. Consult a lawyer to get professional advice. Remember
+        that LLMs can invent answers and facts. Please do not rely on this answers.
+        """;
+    
+    protected override string SystemPrompt => 
+        """
+        You are an expert in legal matters. You have studied international law and are familiar with the law in
+        various countries. You receive a legal document and answer the user's questions. You are a friendly and
+        professional assistant. You respond to the user in the language in which the questions were asked. If
+        you are unsure, unfamiliar with the legal area, or do not know the answers, you inform the user.
+        Never invent facts!
+        """;
+    
+    protected override IReadOnlyList<IButtonData> FooterButtons =>
+    [
+        new SendToButton
+        {
+            Self = SendTo.LEGAL_CHECK_ASSISTANT,
+        },
+    ];
+    
+    protected override void ResetFrom()
+    {
+        this.inputLegalDocument = string.Empty;
+        this.inputQuestions = string.Empty;
+        this.MightPreselectValues();
+    }
+    
+    protected override bool MightPreselectValues()
+    {
+        if (this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions)
+        {
+            this.providerSettings = this.SettingsManager.ConfigurationData.Providers.FirstOrDefault(x => x.Id == this.SettingsManager.ConfigurationData.LegalCheck.PreselectedProvider);
+            return true;
+        }
+        
+        return false;
+    }
+    
+    private bool isAgentRunning;
+    private string inputLegalDocument = string.Empty;
+    private string inputQuestions = string.Empty;
+    
+    #region Overrides of ComponentBase
+
+    protected override async Task OnInitializedAsync()
+    {
+        this.MightPreselectValues();
+        var deferredContent = MessageBus.INSTANCE.CheckDeferredMessages<string>(Event.SEND_TO_LEGAL_CHECK_ASSISTANT).FirstOrDefault();
+        if (deferredContent is not null)
+            this.inputQuestions = deferredContent;
+        
+        await base.OnInitializedAsync();
+    }
+
+    #endregion
+    
+    private string? ValidatingLegalDocument(string text)
+    {
+        if(string.IsNullOrWhiteSpace(text))
+            return "Please provide a legal document as input. You might copy the desired text from a document or a website.";
+        
+        return null;
+    }
+    
+    private string? ValidatingQuestions(string text)
+    {
+        if(string.IsNullOrWhiteSpace(text))
+            return "Please provide your questions as input.";
+        
+        return null;
+    }
+    
+    private async Task AksQuestions()
+    {
+        await this.form!.Validate();
+        if (!this.inputIsValid)
+            return;
+        
+        this.CreateChatThread();
+        var time = this.AddUserRequest(
+            $"""
+                # The legal document
+                {this.inputLegalDocument}
+                
+                # The questions
+                {this.inputQuestions}
+             """);
+
+        await this.AddAIResponseAsync(time);
+    }
+}
--- a/Studio/Pages/Assistants.razor
+++ b/Studio/Pages/Assistants.razor
@ -22,6 +22,7 @@
    <MudStack Row="@true" Wrap="@Wrap.Wrap" Class="mb-3">
        <AssistantBlock Name="E-Mail" Description="Generate an e-mail for a given context." Icon="@Icons.Material.Filled.Email" Link="@Routes.ASSISTANT_EMAIL"/>
        <AssistantBlock Name="Agenda Planner" Description="Generate an agenda for a given meeting, seminar, etc." Icon="@Icons.Material.Filled.CalendarToday" Link="@Routes.ASSISTANT_AGENDA"/>
+        <AssistantBlock Name="Legal Check" Description="Ask a question about a legal document." Icon="@Icons.Material.Filled.Gavel" Link="@Routes.ASSISTANT_LEGAL_CHECK"/>
        <AssistantBlock Name="Icon Finder" Description="Using a LLM to find an icon for a given context." Icon="@Icons.Material.Filled.FindInPage" Link="@Routes.ASSISTANT_ICON_FINDER"/>
    </MudStack>

--- a/Studio/Pages/Settings.razor
+++ b/Studio/Pages/Settings.razor
@ -216,6 +216,16 @@
                <ConfigurationProviderSelection Data="@this.availableProviders" Disabled="@(() => !this.SettingsManager.ConfigurationData.EMail.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.EMail.PreselectedProvider)" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.EMail.PreselectedProvider = selectedValue)"/>
            </MudPaper>
        </ExpansionPanel>
+
+        <ExpansionPanel HeaderIcon="@Icons.Material.Filled.Gavel" HeaderText="Assistant: Legal Check">
+            <ConfigurationOption OptionDescription="Hide the web content reader?" LabelOn="Web content reader is hidden" LabelOff="Web content reader is shown" State="@(() => this.SettingsManager.ConfigurationData.LegalCheck.HideWebContentReader)" StateUpdate="@(updatedState => this.SettingsManager.ConfigurationData.LegalCheck.HideWebContentReader = updatedState)" OptionHelp="When activated, the web content reader is hidden and cannot be used. As a result, the user interface becomes a bit easier to use."/>
+            <MudPaper Class="pa-3 mb-8 border-dashed border rounded-lg">
+                <ConfigurationOption OptionDescription="Preselect legal check options?" LabelOn="Legal check options are preselected" LabelOff="No legal check options are preselected" State="@(() => this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions)" StateUpdate="@(updatedState => this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions = updatedState)" OptionHelp="When enabled, you can preselect some legal check options. This is might be useful when you prefer a specific LLM model."/>
+                <ConfigurationOption OptionDescription="Preselect the web content reader?" Disabled="@(() => !this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions || this.SettingsManager.ConfigurationData.LegalCheck.HideWebContentReader)" LabelOn="Web content reader is preselected" LabelOff="Web content reader is not preselected" State="@(() => this.SettingsManager.ConfigurationData.LegalCheck.PreselectWebContentReader)" StateUpdate="@(updatedState => this.SettingsManager.ConfigurationData.LegalCheck.PreselectWebContentReader = updatedState)" OptionHelp="When enabled, the web content reader is preselected. This is might be useful when you prefer to load legal content from the web very often."/>
+                <ConfigurationOption OptionDescription="Preselect the content cleaner agent?" Disabled="@(() => !this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions || this.SettingsManager.ConfigurationData.LegalCheck.HideWebContentReader)" LabelOn="Content cleaner agent is preselected" LabelOff="Content cleaner agent is not preselected" State="@(() => this.SettingsManager.ConfigurationData.LegalCheck.PreselectContentCleanerAgent)" StateUpdate="@(updatedState => this.SettingsManager.ConfigurationData.LegalCheck.PreselectContentCleanerAgent = updatedState)" OptionHelp="When enabled, the content cleaner agent is preselected. This is might be useful when you prefer to clean up the legal content before translating it."/>
+                <ConfigurationProviderSelection Data="@this.availableProviders" Disabled="@(() => !this.SettingsManager.ConfigurationData.LegalCheck.PreselectOptions)" SelectedValue="@(() => this.SettingsManager.ConfigurationData.LegalCheck.PreselectedProvider)" SelectionUpdate="@(selectedValue => this.SettingsManager.ConfigurationData.LegalCheck.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">
--- a/Studio/Routes.razor.cs
+++ b/Studio/Routes.razor.cs
@ -18,5 +18,6 @@ public sealed partial class Routes
    public const string ASSISTANT_CODING = "/assistant/coding";
    public const string ASSISTANT_AGENDA = "/assistant/agenda";
    public const string ASSISTANT_EMAIL = "/assistant/email";
+    public const string ASSISTANT_LEGAL_CHECK = "/assistant/legal-check";
    // ReSharper restore InconsistentNaming
 }
--- a/Studio/Settings/DataModel/Data.cs
+++ b/Studio/Settings/DataModel/Data.cs
@ -44,4 +44,6 @@ public sealed class Data
    public DataRewriteImprove RewriteImprove { get; init; } = new();

    public DataEMail EMail { get; set; } = new();
+    
+    public DataLegalCheck LegalCheck { get; set; } = new();
 }
--- a/Studio/Settings/DataModel/DataLegalCheck.cs
+++ b/Studio/Settings/DataModel/DataLegalCheck.cs
@ -0,0 +1,29 @@
+namespace AIStudio.Settings.DataModel;
+
+public class DataLegalCheck
+{
+    /// <summary>
+    /// Do you want to preselect any legal check options?
+    /// </summary>
+    public bool PreselectOptions { get; set; }
+    
+    /// <summary>
+    /// Hide the web content reader?
+    /// </summary>
+    public bool HideWebContentReader { get; set; }
+
+    /// <summary>
+    /// Preselect the web content reader?
+    /// </summary>
+    public bool PreselectWebContentReader { get; set; }
+
+    /// <summary>
+    /// Preselect the content cleaner agent?
+    /// </summary>
+    public bool PreselectContentCleanerAgent { get; set; }
+    
+    /// <summary>
+    /// The preselected translator provider.
+    /// </summary>
+    public string PreselectedProvider { get; set; } = string.Empty;
+}
--- a/Studio/Tools/Event.cs
+++ b/Studio/Tools/Event.cs
@ -26,4 +26,5 @@ public enum Event
    SEND_TO_TEXT_SUMMARIZER_ASSISTANT,
    SEND_TO_CHAT,
    SEND_TO_EMAIL_ASSISTANT,
+    SEND_TO_LEGAL_CHECK_ASSISTANT,
 }
--- a/Studio/Tools/SendTo.cs
+++ b/Studio/Tools/SendTo.cs
@ -12,6 +12,7 @@ public enum SendTo
    CODING_ASSISTANT,
    TEXT_SUMMARIZER_ASSISTANT,
    EMAIL_ASSISTANT,
+    LEGAL_CHECK_ASSISTANT,
    
    CHAT,
 }
--- a/Studio/Tools/SendToExtensions.cs
+++ b/Studio/Tools/SendToExtensions.cs
@ -12,6 +12,7 @@ public static class SendToExtensions
        SendTo.AGENDA_ASSISTANT => "Agenda Assistant",
        SendTo.CODING_ASSISTANT => "Coding Assistant",
        SendTo.EMAIL_ASSISTANT => "E-Mail Assistant",
+        SendTo.LEGAL_CHECK_ASSISTANT => "Legal Check Assistant",
        
        SendTo.CHAT => "New Chat",
        
@ -28,6 +29,7 @@ public static class SendToExtensions
        SendTo.ICON_FINDER_ASSISTANT => new(Event.SEND_TO_ICON_FINDER_ASSISTANT, Routes.ASSISTANT_ICON_FINDER),
        SendTo.GRAMMAR_SPELLING_ASSISTANT => new(Event.SEND_TO_GRAMMAR_SPELLING_ASSISTANT, Routes.ASSISTANT_GRAMMAR_SPELLING),
        SendTo.TEXT_SUMMARIZER_ASSISTANT => new(Event.SEND_TO_TEXT_SUMMARIZER_ASSISTANT, Routes.ASSISTANT_SUMMARIZER),
+        SendTo.LEGAL_CHECK_ASSISTANT => new(Event.SEND_TO_LEGAL_CHECK_ASSISTANT, Routes.ASSISTANT_LEGAL_CHECK),
            
        SendTo.CHAT => new(Event.SEND_TO_CHAT, Routes.CHAT),
            
--- a/Studio/wwwroot/changelog/v0.8.13.md
+++ b/Studio/wwwroot/changelog/v0.8.13.md
@ -0,0 +1,2 @@
+# v0.8.13, build 175
+- Added a legal check assistant & the possibility to preselect some options.