From 1b100f6c7ed197885be4380b102444164bbe8cde Mon Sep 17 00:00:00 2001
From: Thorsten Sommer <mail@tsommer.org>
Date: Mon, 17 Feb 2025 22:49:27 +0100
Subject: [PATCH] Added the common augmentation interface

---
 .../Tools/RAG/IAugmentationProcess.cs         | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 app/MindWork AI Studio/Tools/RAG/IAugmentationProcess.cs

diff --git a/app/MindWork AI Studio/Tools/RAG/IAugmentationProcess.cs b/app/MindWork AI Studio/Tools/RAG/IAugmentationProcess.cs
new file mode 100644
index 00000000..81bb6da7
--- /dev/null
+++ b/app/MindWork AI Studio/Tools/RAG/IAugmentationProcess.cs	
@@ -0,0 +1,33 @@
+using AIStudio.Chat;
+using AIStudio.Provider;
+
+namespace AIStudio.Tools.RAG;
+
+public interface IAugmentationProcess
+{
+    /// <summary>
+    /// How is the augmentation process called?
+    /// </summary>
+    public string TechnicalName { get; }
+
+    /// <summary>
+    /// How is the augmentation process called in the UI?
+    /// </summary>
+    public string UIName { get; }
+
+    /// <summary>
+    /// How works the augmentation process?
+    /// </summary>
+    public string Description { get; }
+    
+    /// <summary>
+    /// Starts the augmentation process.
+    /// </summary>
+    /// <param name="provider">The LLM provider. Gets used, e.g., for automatic retrieval context validation.</param>
+    /// <param name="lastPrompt">The last prompt that was issued by the user.</param>
+    /// <param name="chatThread">The chat thread.</param>
+    /// <param name="retrievalContexts">The retrieval contexts that were issued by the retrieval process.</param>
+    /// <param name="token">The cancellation token.</param>
+    /// <returns>The altered chat thread.</returns>
+    public Task<ChatThread> ProcessAsync(IProvider provider, IContent lastPrompt, ChatThread chatThread, IReadOnlyList<IRetrievalContext> retrievalContexts, CancellationToken token = default);
+}
\ No newline at end of file