Showing sources coming from data providers (#559)

Author: SommerEngineering

app/MindWork AI Studio/Agents/AgentDataSourceSelection.cs

@@ -131,7 +131,7 @@ public override async Task<ContentBlock> ProcessInput(ContentBlock input, IDicti
 
     #endregion
 
-    public async Task<List<SelectedDataSource>> PerformSelectionAsync(IProvider provider, IContent lastPrompt, ChatThread chatThread, AllowedSelectedDataSources dataSources, CancellationToken token = default)
+    public async Task<List<SelectedDataSource>> PerformSelectionAsync(IProvider provider, IContent lastUserPrompt, ChatThread chatThread, AllowedSelectedDataSources dataSources, CancellationToken token = default)
     {
         logger.LogInformation("The AI should select the appropriate data sources.");
 
@@ -154,7 +154,7 @@ public async Task<List<SelectedDataSource>> PerformSelectionAsync(IProvider prov
         //
         // 2. Prepare the current system and user prompts as input for the agent: 
         //
-        var lastPromptContent = lastPrompt switch
+        var lastPromptContent = lastUserPrompt switch
         {
             ContentText text => text.Text,
 

app/MindWork AI Studio/Agents/AgentRetrievalContextValidation.cs

@@ -147,12 +147,12 @@ public void SetLLMProvider(IProvider provider)
     /// <summary>
     /// Validate all retrieval contexts against the last user and the system prompt.
     /// </summary>
-    /// <param name="lastPrompt">The last user prompt.</param>
+    /// <param name="lastUserPrompt">The last user prompt.</param>
     /// <param name="chatThread">The chat thread.</param>
     /// <param name="retrievalContexts">All retrieval contexts to validate.</param>
     /// <param name="token">The cancellation token.</param>
     /// <returns>The validation results.</returns>
-    public async Task<IReadOnlyList<RetrievalContextValidationResult>> ValidateRetrievalContextsAsync(IContent lastPrompt, ChatThread chatThread, IReadOnlyList<IRetrievalContext> retrievalContexts, CancellationToken token = default)
+    public async Task<IReadOnlyList<RetrievalContextValidationResult>> ValidateRetrievalContextsAsync(IContent lastUserPrompt, ChatThread chatThread, IReadOnlyList<IRetrievalContext> retrievalContexts, CancellationToken token = default)
     {
         // Check if the retrieval context validation is enabled:
         if (!this.SettingsManager.ConfigurationData.AgentRetrievalContextValidation.EnableRetrievalContextValidation)
@@ -178,7 +178,7 @@ public async Task<IReadOnlyList<RetrievalContextValidationResult>> ValidateRetri
             await semaphore.WaitAsync(token);
 
             // Start the next validation task:
-            validationTasks.Add(this.ValidateRetrievalContextAsync(lastPrompt, chatThread, retrievalContext, token, semaphore));
+            validationTasks.Add(this.ValidateRetrievalContextAsync(lastUserPrompt, chatThread, retrievalContext, token, semaphore));
         }
 
         // Wait for all validation tasks to complete:
@@ -193,13 +193,13 @@ public async Task<IReadOnlyList<RetrievalContextValidationResult>> ValidateRetri
     /// can call this method in parallel for each retrieval context. You might use
     /// the ValidateRetrievalContextsAsync method to validate all retrieval contexts.
     /// </remarks>
-    /// <param name="lastPrompt">The last user prompt.</param>
+    /// <param name="lastUserPrompt">The last user prompt.</param>
     /// <param name="chatThread">The chat thread.</param>
     /// <param name="retrievalContext">The retrieval context to validate.</param>
     /// <param name="token">The cancellation token.</param>
     /// <param name="semaphore">The optional semaphore to limit the number of parallel validations.</param>
     /// <returns>The validation result.</returns>
-    public async Task<RetrievalContextValidationResult> ValidateRetrievalContextAsync(IContent lastPrompt, ChatThread chatThread, IRetrievalContext retrievalContext, CancellationToken token = default, SemaphoreSlim? semaphore = null)
+    public async Task<RetrievalContextValidationResult> ValidateRetrievalContextAsync(IContent lastUserPrompt, ChatThread chatThread, IRetrievalContext retrievalContext, CancellationToken token = default, SemaphoreSlim? semaphore = null)
     {
         try
         {
@@ -214,7 +214,7 @@ public async Task<RetrievalContextValidationResult> ValidateRetrievalContextAsyn
             //
             // 1. Prepare the current system and user prompts as input for the agent: 
             //
-            var lastPromptContent = lastPrompt switch
+            var lastPromptContent = lastUserPrompt switch
             {
                 ContentText text => text.Text,
 

app/MindWork AI Studio/Assistants/I18N/allTexts.lua

@@ -4882,9 +4882,6 @@ UI_TEXT_CONTENT["AISTUDIO::PROVIDER::LLMPROVIDERSEXTENSIONS::T3424652889"] = "Un
 -- no model selected
 UI_TEXT_CONTENT["AISTUDIO::PROVIDER::MODEL::T2234274832"] = "no model selected"
 
--- Sources
-UI_TEXT_CONTENT["AISTUDIO::PROVIDER::SOURCEEXTENSIONS::T2730980305"] = "Sources"
-
 -- Use no chat template
 UI_TEXT_CONTENT["AISTUDIO::SETTINGS::CHATTEMPLATE::T4258819635"] = "Use no chat template"
 
@@ -5641,6 +5638,12 @@ UI_TEXT_CONTENT["AISTUDIO::TOOLS::SERVICES::UPDATESERVICE::T1015418291"] = "No u
 -- Failed to install update automatically. Please try again manually.
 UI_TEXT_CONTENT["AISTUDIO::TOOLS::SERVICES::UPDATESERVICE::T3709709946"] = "Failed to install update automatically. Please try again manually."
 
+-- Sources provided by the data providers
+UI_TEXT_CONTENT["AISTUDIO::TOOLS::SOURCEEXTENSIONS::T4174900468"] = "Sources provided by the data providers"
+
+-- Sources provided by the AI
+UI_TEXT_CONTENT["AISTUDIO::TOOLS::SOURCEEXTENSIONS::T4261248356"] = "Sources provided by the AI"
+
 -- The hostname is not a valid HTTP(S) URL.
 UI_TEXT_CONTENT["AISTUDIO::TOOLS::VALIDATION::DATASOURCEVALIDATION::T1013354736"] = "The hostname is not a valid HTTP(S) URL."
 

app/MindWork AI Studio/Chat/ContentBlockComponent.razor

@@ -1,7 +1,6 @@
 @using AIStudio.Tools
 @using MudBlazor
 @using AIStudio.Components
-@using AIStudio.Provider
 @inherits AIStudio.Components.MSGComponentBase
 <MudCard Class="@this.CardClasses" Outlined="@true">
     <MudCardHeader>

app/MindWork AI Studio/Chat/ContentImage.cs

@@ -31,7 +31,7 @@ public sealed class ContentImage : IContent, IImageSource
     public List<Source> Sources { get; set; } = [];
 
     /// <inheritdoc />
-    public Task<ChatThread> CreateFromProviderAsync(IProvider provider, Model chatModel, IContent? lastPrompt, ChatThread? chatChatThread, CancellationToken token = default)
+    public Task<ChatThread> CreateFromProviderAsync(IProvider provider, Model chatModel, IContent? lastUserPrompt, ChatThread? chatChatThread, CancellationToken token = default)
     {
         throw new NotImplementedException();
     }

app/MindWork AI Studio/Chat/ContentText.cs

@@ -11,6 +11,8 @@ namespace AIStudio.Chat;
 /// </summary>
 public sealed class ContentText : IContent
 {
+    private static readonly ILogger<ContentText> LOGGER = Program.LOGGER_FACTORY.CreateLogger<ContentText>();
+    
     /// <summary>
     /// The minimum time between two streaming events, when the user
     /// enables the energy saving mode.
@@ -39,30 +41,28 @@ public sealed class ContentText : IContent
     public List<Source> Sources { get; set; } = [];
 
     /// <inheritdoc />
-    public async Task<ChatThread> CreateFromProviderAsync(IProvider provider, Model chatModel, IContent? lastPrompt, ChatThread? chatThread, CancellationToken token = default)
+    public async Task<ChatThread> CreateFromProviderAsync(IProvider provider, Model chatModel, IContent? lastUserPrompt, ChatThread? chatThread, CancellationToken token = default)
     {
         if(chatThread is null)
             return new();
 
         if(!chatThread.IsLLMProviderAllowed(provider))
         {
-            var logger = Program.SERVICE_PROVIDER.GetService<ILogger<ContentText>>()!;
-            logger.LogError("The provider is not allowed for this chat thread due to data security reasons. Skipping the AI process.");
+            LOGGER.LogError("The provider is not allowed for this chat thread due to data security reasons. Skipping the AI process.");
             return chatThread;
         }
 
         // Call the RAG process. Right now, we only have one RAG process:
-        if (lastPrompt is not null)
+        if (lastUserPrompt is not null)
         {
             try
             {
                 var rag = new AISrcSelWithRetCtxVal();
-                chatThread = await rag.ProcessAsync(provider, lastPrompt, chatThread, token);
+                chatThread = await rag.ProcessAsync(provider, lastUserPrompt, chatThread, token);
             }
             catch (Exception e)
             {
-                var logger = Program.SERVICE_PROVIDER.GetService<ILogger<ContentText>>()!;
-                logger.LogError(e, "Skipping the RAG process due to an error.");
+                LOGGER.LogError(e, "Skipping the RAG process due to an error.");
             }
         }
 

app/MindWork AI Studio/Chat/IContent.cs

@@ -41,13 +41,17 @@ public interface IContent
     /// <summary>
     /// The provided sources, if any.
     /// </summary>
+    /// <remarks>
+    /// We cannot use ISource here because System.Text.Json does not support
+    /// interface serialization. So we have to use a concrete class.
+    /// </remarks>
     [JsonIgnore]
     public List<Source> Sources { get; set; }
 
     /// <summary>
     /// Uses the provider to create the content.
     /// </summary>
-    public Task<ChatThread> CreateFromProviderAsync(IProvider provider, Model chatModel, IContent? lastPrompt, ChatThread? chatChatThread, CancellationToken token = default);
+    public Task<ChatThread> CreateFromProviderAsync(IProvider provider, Model chatModel, IContent? lastUserPrompt, ChatThread? chatChatThread, CancellationToken token = default);
 
     /// <summary>
     /// Creates a deep copy

app/MindWork AI Studio/Plugins/languages/de-de-43065dbc-78d0-45b7-92be-f14c2926e2dc/plugin.lua

@@ -4884,9 +4884,6 @@ UI_TEXT_CONTENT["AISTUDIO::PROVIDER::LLMPROVIDERSEXTENSIONS::T3424652889"] = "Un
 -- no model selected
 UI_TEXT_CONTENT["AISTUDIO::PROVIDER::MODEL::T2234274832"] = "Kein Modell ausgewählt"
 
--- Sources
-UI_TEXT_CONTENT["AISTUDIO::PROVIDER::SOURCEEXTENSIONS::T2730980305"] = "Quellen"
-
 -- Use no chat template
 UI_TEXT_CONTENT["AISTUDIO::SETTINGS::CHATTEMPLATE::T4258819635"] = "Keine Chat-Vorlage verwenden"
 
@@ -5643,6 +5640,12 @@ UI_TEXT_CONTENT["AISTUDIO::TOOLS::SERVICES::UPDATESERVICE::T1015418291"] = "Kein
 -- Failed to install update automatically. Please try again manually.
 UI_TEXT_CONTENT["AISTUDIO::TOOLS::SERVICES::UPDATESERVICE::T3709709946"] = "Fehler bei der automatischen Installation des Updates. Bitte versuchen Sie es manuell erneut."
 
+-- Sources provided by the data providers
+UI_TEXT_CONTENT["AISTUDIO::TOOLS::SOURCEEXTENSIONS::T4174900468"] = "Von den Datenanbietern bereitgestellte Quellen"
+
+-- Sources provided by the AI
+UI_TEXT_CONTENT["AISTUDIO::TOOLS::SOURCEEXTENSIONS::T4261248356"] = "Von der KI bereitgestellte Quellen"
+
 -- The hostname is not a valid HTTP(S) URL.
 UI_TEXT_CONTENT["AISTUDIO::TOOLS::VALIDATION::DATASOURCEVALIDATION::T1013354736"] = "Der Hostname ist keine gültige HTTP(S)-URL."
 

app/MindWork AI Studio/Plugins/languages/en-us-97dfb1ba-50c4-4440-8dfa-6575daf543c8/plugin.lua

@@ -4884,9 +4884,6 @@ UI_TEXT_CONTENT["AISTUDIO::PROVIDER::LLMPROVIDERSEXTENSIONS::T3424652889"] = "Un
 -- no model selected
 UI_TEXT_CONTENT["AISTUDIO::PROVIDER::MODEL::T2234274832"] = "no model selected"
 
--- Sources
-UI_TEXT_CONTENT["AISTUDIO::PROVIDER::SOURCEEXTENSIONS::T2730980305"] = "Sources"
-
 -- Use no chat template
 UI_TEXT_CONTENT["AISTUDIO::SETTINGS::CHATTEMPLATE::T4258819635"] = "Use no chat template"
 
@@ -5643,6 +5640,12 @@ UI_TEXT_CONTENT["AISTUDIO::TOOLS::SERVICES::UPDATESERVICE::T1015418291"] = "No u
 -- Failed to install update automatically. Please try again manually.
 UI_TEXT_CONTENT["AISTUDIO::TOOLS::SERVICES::UPDATESERVICE::T3709709946"] = "Failed to install update automatically. Please try again manually."
 
+-- Sources provided by the data providers
+UI_TEXT_CONTENT["AISTUDIO::TOOLS::SOURCEEXTENSIONS::T4174900468"] = "Sources provided by the data providers"
+
+-- Sources provided by the AI
+UI_TEXT_CONTENT["AISTUDIO::TOOLS::SOURCEEXTENSIONS::T4261248356"] = "Sources provided by the AI"
+
 -- The hostname is not a valid HTTP(S) URL.
 UI_TEXT_CONTENT["AISTUDIO::TOOLS::VALIDATION::DATASOURCEVALIDATION::T1013354736"] = "The hostname is not a valid HTTP(S) URL."
 

app/MindWork AI Studio/Provider/OpenAI/ChatCompletionAnnotationStreamLine.cs

@@ -30,7 +30,7 @@ public IList<ISource> GetSources()
             {
                 // Check if the annotation is of the expected type and extract the source information:
                 if (annotation is ChatCompletionAnnotatingURL urlAnnotation)
-                    sources.Add(new Source(urlAnnotation.UrlCitation.Title, urlAnnotation.UrlCitation.URL));
+                    sources.Add(new Source(urlAnnotation.UrlCitation.Title, urlAnnotation.UrlCitation.URL, SourceOrigin.LLM));
 
                 //
                 // Check for the unexpected annotation type of the Responses API.
@@ -46,7 +46,7 @@ public IList<ISource> GetSources()
                 //   we are calling the chat completion endpoint.
                 //
                 if (annotation is ResponsesAnnotatingUrlCitationData citationData)
-                    sources.Add(new Source(citationData.Title, citationData.URL));
+                    sources.Add(new Source(citationData.Title, citationData.URL, SourceOrigin.LLM));
             }
         }