Refactored to make AI control more independent from rest of the project

Author: mitchcapper

RegExpressWPFNET/RegExpressLibrary/IRegexEngine.cs

@@ -15,7 +15,66 @@ namespace RegExpressLibrary
     public delegate void RegexEngineOptionsChanged( IRegexEngine sender, RegexEngineOptionsChangedArgs args );
 
 
-    public interface IRegexEngine
+    public interface IBaseEngine
+    {
+        string Name { get; }
+        string? ExportOptions( ); // (JSON)
+    }
+    
+    public interface IAIEngine
+    {
+        public enum REFERENCE_TEXT_REPLACE_ACTION
+        {
+            /// <summary>
+            /// Disable reference text functionality, will not show in UI either
+            /// </summary>
+            ReferenceTextDisabled,
+            /// <summary>
+            /// This will change the old reference text to a placeholder indicating it has changed and the new version will appear later in the chat history, exact placeholder text can be controlled via PlaceholderTextForReferenceTextRemoval.
+            /// </summary>
+            ChangeOldToPlaceholder,
+            /// <summary>
+            /// This leaves the old reference text in place in the chat history even if it changes later. It may eat up excess tokens but hopefully shouldn't be too confusing to the AI as it can see the newer version later.  It also allows the AI to understand how the reference text has changed over time.
+            /// </summary>
+            LeaveOldInplace,
+            /// <summary>
+            /// UpdateInPlace means it appears in the chat history where it originally appeared, this might be confusing as the AI's answers were based on the old text and it may confuse the current AI as why the AI previously responded as it did.
+            /// </summary>
+            UpdateInPlace,
+            /// <summary>
+            /// This deletes the old reference text from the chat history entirely when it changes. This might cause confusion for the current AI as it won't know exactly what the previous AI was basing its responses off.
+            /// </summary>
+            DeleteOld,
+
+        }
+        /// <summary>
+        /// For large reference texts we don't want to keep sending them in the chat history if they change so this controls how we handle them.  Depending on the action may cause confusion for the AI or waste tokens, ChangeOldToPlaceholder is likely best.
+        /// </summary>
+        REFERENCE_TEXT_REPLACE_ACTION ReplaceAction => REFERENCE_TEXT_REPLACE_ACTION.ChangeOldToPlaceholder;
+        string GetSystemPrompt( );
+        /// <summary>
+        /// This is the message header used at the start of a message to the AI providing some sort of reference text that will appear in a codeblock. For example "Users current webpage html"
+        /// </summary>
+        string ReferenceTextHeader => "Reference Text";
+        string PlaceholderTextForReferenceTextRemoval => $"The old content for {ReferenceTextHeader} was here but changed. It has been removed to shorten history new version found later.";
+        bool IsReferenceTextEnabled => ReplaceAction != REFERENCE_TEXT_REPLACE_ACTION.ReferenceTextDisabled;
+    }
+    public interface IOurAIEngine : IAIEngine, IBaseEngine
+    {
+        string AIPatternType => "Regex";
+        string AIPatternCodeblockType => "regex";
+        string AIAdditionalSystemPrompt => "If the language supports named capture groups, use these by default. " +
+                   "If the user has ignoring patterned whitespace enabled in the options, use multi-lines and minimal in-regex comments for complex regexes with nice whitespace formatting to make it more readable. ";
+
+        string IAIEngine.ReferenceTextHeader => "Users current target text";
+        string IAIEngine.GetSystemPrompt( ) => $"You are a {Name} {AIPatternType} expert assistant. The user has questions about their {AIPatternType} patterns and target text. " +
+                   $"Provide {AIPatternType} patterns inside Markdown code blocks (```{AIPatternCodeblockType} ... ```). " +
+                   "Explain how the pattern works briefly. " +
+                    AIAdditionalSystemPrompt +
+                   $"They currently have these engine options enabled:\n```json\n{ExportOptions( )}\n```";
+    }
+
+    public interface IRegexEngine : IOurAIEngine
     {
         event RegexEngineOptionsChanged? OptionsChanged;
         event EventHandler? FeatureMatrixReady;
@@ -26,8 +85,6 @@ public interface IRegexEngine
 
         (string Kind, string? Version) CombinedId => (Kind, Version);
 
-        string Name { get; }
-
         string Subtitle { get; }
 
         RegexEngineCapabilityEnum Capabilities { get; }
@@ -36,8 +93,6 @@ public interface IRegexEngine
 
         Control GetOptionsControl( );
 
-        string? ExportOptions( ); // (JSON)
-
         void ImportOptions( string? json );
 
         RegexMatches GetMatches( ICancellable cnc, [StringSyntax( StringSyntaxAttribute.Regex )] string pattern, string text );

RegExpressWPFNET/RegExpressWPFNET/Code/AIService.cs

@@ -10,87 +10,71 @@
 
 namespace RegExpressWPFNET.Code
 {
-
+    public class AiModelProvider
+    {
+        public string Id { get; set; }
+        public string Name { get; set; }
+        public string Description { get; set; }
+        public string ModelHint { get; set; }
+        public string TokenHint { get; set; }
+        public string TokenHelp { get; set; }
+        public string EndpointHint { get; set; } = "ie: http://localhost:11434/v1";
+
+        public bool IsGithubCopilot { get; set; }
+        public bool AllowEndpointCustomization { get; set; }
+
+        public string Endpoint { get; set; }
+        public string ModelId { get; set; }
+        public bool TokenRequired {get;set; } = true;
+        public string Token { get; set; }
+        public List<KeyValuePair<string, string>> HTTPHeadersToAdd { get; set; } = new( );
+        override public string ToString( ) => Name;
+    }
     public class AiService
     {
+
+
         private IChatCompletionService? _chatService;
         private Kernel? _kernel;
         private HttpClient? _httpClient; // Keep reference to avoid disposal
-        private ChatHistory? _chatHistory; // Persistent conversation history
+        private ChatHistory _chatHistory = new( ); // Persistent conversation history
         public bool IsConfigured => _chatService != null;
 
-        public string EngineName { get; private set; } = string.Empty;
-        public string? EngineOptions { get; private set; }
         public string? CurrentProvider { get; private set; }
         public string? CurrentModelId { get; private set; }
+        public IAIEngine Engine { get; private set; }
+        public Action<string>? DebugAction;
+
 
-        public void Configure( string provider, string apiKey, string modelId, string endpoint )
+        public void Configure( AiModelProvider provider )
         {
             // Dispose previous HttpClient if any
             _httpClient?.Dispose( );
             _httpClient = null;
 
             var builder = Kernel.CreateBuilder( );
+            _httpClient = new HttpClient( );
+            foreach( var header in provider.HTTPHeadersToAdd )
+                _httpClient.DefaultRequestHeaders.TryAddWithoutValidation( header.Key, header.Value );
+
+            builder.AddOpenAIChatCompletion(
+                modelId: provider.ModelId,
+                apiKey: provider.Token,
+                httpClient: _httpClient,
+                endpoint: string.IsNullOrWhiteSpace( provider.Endpoint ) ? null : new Uri( provider.Endpoint )
+            );
+
 
-            switch( provider )
-            {
-            case "OpenAI":
-                builder.AddOpenAIChatCompletion( modelId, apiKey );
-                break;
-
-            case "GitHub Copilot":
-                // GitHub Copilot uses a two-step auth flow:
-                // 1. OAuth token → API token exchange (done before calling Configure)
-                // 2. API token + dynamic endpoint for requests
-                // The apiKey here is the API token (not OAuth), endpoint is from token exchange
-                if( string.IsNullOrWhiteSpace( modelId ) )
-                    throw new ArgumentException( "GitHub Copilot must have the modelId" );
-                if( string.IsNullOrWhiteSpace( endpoint ) )
-                    throw new ArgumentException( "GitHub Copilot requires the API endpoint from token exchange" );
-
-                _httpClient = new HttpClient { BaseAddress = new Uri( endpoint ) };
-                _httpClient.DefaultRequestHeaders.TryAddWithoutValidation( "User-Agent", "GitHubCopilotChat/0.24.2025012401" );
-                _httpClient.DefaultRequestHeaders.Add( "Copilot-Integration-Id", "vscode-chat" );
-                _httpClient.DefaultRequestHeaders.Add( "Editor-Version", "vscode/1.103.2" );
-                _httpClient.DefaultRequestHeaders.Add( "x-github-api-version", "2025-05-01" );
-                builder.AddOpenAIChatCompletion(
-                    modelId: modelId,
-                    apiKey: apiKey,
-                    httpClient: _httpClient
-                );
-                break;
-
-            case "GitHub Models":
-                // GitHub Models uses the OpenAI connector but with a specific endpoint
-                _httpClient = new HttpClient { BaseAddress = new Uri( "https://models.inference.ai.azure.com" ) };
-                builder.AddOpenAIChatCompletion(
-                    modelId: modelId,
-                    apiKey: apiKey,
-                    httpClient: _httpClient
-                );
-                break;
-
-            case "Local (Ollama)":
-                // Connects to local Ollama instance (usually http://localhost:11434/v1)
-                builder.AddOpenAIChatCompletion(
-                    modelId: modelId, // e.g., "llama3"
-                    apiKey: apiKey, // Ollama ignores the key
-                    endpoint: new Uri( endpoint )
-                );
-                break;
-            }
 
             _kernel = builder.Build( );
             _chatService = _kernel.GetRequiredService<IChatCompletionService>( );
-            CurrentProvider = provider;
-            CurrentModelId = modelId;
 
             // Initialize fresh chat history with system prompt
             _chatHistory = new ChatHistory( );
             lastTargetText = string.Empty;
             SetSystemPromptIfChanged( true );
         }
-        private string lastPrompt;
+        private string? lastPrompt;
         private void SetSystemPromptIfChanged( bool force = false )
         {
             var curPrompt = GetSystemPrompt( );
@@ -103,31 +87,23 @@ private void SetSystemPromptIfChanged( bool force = false )
             lastPrompt = curPrompt;
         }
 
-        private string GetSystemPrompt( )
-        {
-            return $"You are a {EngineName} Regex expert assistant. The user has questions about their regex patterns and target text. " +
-                   "Provide Regex patterns inside Markdown code blocks (```regex ... ```). " +
-                   "Explain how the pattern works briefly. " +
-                   "If the language supports named capture groups, use these by default. " +
-                   "If the user has ignoring patterned whitespace enabled in the options, use multi-lines and minimal in-regex comments for complex regexes with nice whitespace formatting to make it more readable. " +
-                   $"They currently have these engine options enabled: {EngineOptions}";
-        }
+        private string GetSystemPrompt( ) => Engine?.GetSystemPrompt( ) ?? string.Empty;
 
-        public async Task<string> GetSuggestionAsync( string userPrompt, string curRegex, string targetText )
+        public async Task<string> GetSuggestionAsync( string userPrompt, string ReferenceText )
         {
-            if( _chatService == null || _chatHistory == null )
+            if( _chatService == null )
                 return "Error: AI Service not configured. Please go to Settings.";
 
             SetSystemPromptIfChanged( );
             // Build the user message with current context
-            SetOrUpdateTargetTextIfChanged( targetText );
-            string combinedPrompt = $"Current Regex pattern:\n```\n{curRegex}\n```\n\nMy question: {userPrompt}";
+            SetOrUpdateTargetTextIfChanged( ReferenceText );
 
 
             // Add user message to history
-            _chatHistory.AddUserMessage( combinedPrompt );
+            _chatHistory.AddUserMessage( userPrompt );
+
 
-            if( InternalConfig.DEBUG_LOG_AI_MESSAGES )
+            if( DebugAction != null )
             {
                 StringBuilder debugSb = new StringBuilder( );
                 debugSb.AppendLine( "=== AI Chat History ===" );
@@ -136,13 +112,13 @@ public async Task<string> GetSuggestionAsync( string userPrompt, string curRegex
                     debugSb.AppendLine( $"[{message.Role}] {message.Content}" );
                 }
                 debugSb.AppendLine( "=======================" );
-                System.Diagnostics.Debug.WriteLine( debugSb.ToString( ) );
+                DebugAction?.Invoke( debugSb.ToString( ) );
             }
             // Get response
             var result = await _chatService.GetChatMessageContentAsync( _chatHistory );
             var response = result.Content ?? "No response from AI.";
-            if( InternalConfig.DEBUG_LOG_AI_MESSAGES )
-                System.Diagnostics.Debug.WriteLine( $"[AI Response] {response}" );
+
+            DebugAction?.Invoke( $"[AI Response] {response}" );
 
             // Add assistant response to history for context in follow-up questions
             _chatHistory.AddAssistantMessage( response );
@@ -151,31 +127,44 @@ public async Task<string> GetSuggestionAsync( string userPrompt, string curRegex
         }
 
         private string lastTargetText = string.Empty;
-        private const string CUR_TARGET_TEXT_HEADER = "Current Target text is";
+        private const string REFERENCE_TEXT_CODEBLOCK_DELIM = "\n```\n";
+        /// <summary>
+        /// Sadly right now developer or tool both throw an error...
+        /// </summary>
+        private AuthorRole StoreReferenceTextUnder = AuthorRole.User;
         private void SetOrUpdateTargetTextIfChanged( string targetText )
         {
-            if( lastTargetText == targetText )
+            if( lastTargetText == targetText || Engine.ReplaceAction == IAIEngine.REFERENCE_TEXT_REPLACE_ACTION.ReferenceTextDisabled )
                 return;
             lastTargetText = targetText;
-            var msgStr = $"Current Target text is:\n```\n{targetText}\n```\n\n";
-            var curMsg = _chatHistory.FirstOrDefault( x => x.Role == AuthorRole.User && x.Content?.StartsWith( CUR_TARGET_TEXT_HEADER ) == true );
-
-
-
-
+            var PreTarget = $"{Engine.ReferenceTextHeader}:{REFERENCE_TEXT_CODEBLOCK_DELIM}";
+            var msgStr = $"{PreTarget}{targetText}{REFERENCE_TEXT_CODEBLOCK_DELIM}\n";
+            var curMsg = _chatHistory.FirstOrDefault( x => x.Role == StoreReferenceTextUnder && x.Content?.StartsWith( PreTarget ) == true );
 
             if( curMsg != null )
             {
-                if (InternalConfig.DONT_UPDATE_OLD_AI_TEXT_MARK_REMOVED)
-                    curMsg.Content = "The old target text was here but changed, removed to shorten history new version found later.";
-                else
+                switch( Engine.ReplaceAction )
+                {
+                case IAIEngine.REFERENCE_TEXT_REPLACE_ACTION.UpdateInPlace:
                     curMsg.Content = msgStr;
+                    return; // Don't add a new message
+
+                case IAIEngine.REFERENCE_TEXT_REPLACE_ACTION.ChangeOldToPlaceholder:
+                    curMsg.Content = Engine.PlaceholderTextForReferenceTextRemoval;
+                    break;
+
+                case IAIEngine.REFERENCE_TEXT_REPLACE_ACTION.LeaveOldInplace:
+                    break;
+
+                case IAIEngine.REFERENCE_TEXT_REPLACE_ACTION.DeleteOld:
+                    _chatHistory.Remove( curMsg );
+                    break;
+                }
             }
-            if (InternalConfig.DONT_UPDATE_OLD_AI_TEXT_MARK_REMOVED || curMsg == null)
-                _chatHistory.AddUserMessage( content: msgStr );
 
+            // Add the new reference text message
+            _chatHistory.AddMessage( StoreReferenceTextUnder, content: msgStr );
 
-            // Target text:\n```\n{targetText}\n```\n\n
         }
 
         /// <summary>
@@ -192,17 +181,16 @@ public void ClearConversation( )
             }
         }
 
-        internal void SetEngineInfo( string name, string? engine_options )
+        internal void SetEngineInfo( IAIEngine engine )
         {
-            this.EngineName = name;
-            this.EngineOptions = engine_options;
+            this.Engine = engine;
         }
 
         public void Reset( )
         {
             _chatService = null;
             _kernel = null;
-            _chatHistory = null;
+            _chatHistory = new( );
             _httpClient?.Dispose( );
             _httpClient = null;
             CurrentProvider = null;

RegExpressWPFNET/RegExpressWPFNET/Code/CopilotTokenHelper.cs

@@ -62,7 +62,7 @@ public string GetDisplayName( )
                 if( TokenMultiplier.HasValue )
                 {
                     if( TokenMultiplier.Value == 0 )
-                        tags.Add( "FREE" );
+                        tags.Add( "free" );
                     else if( TokenMultiplier.Value == 1.0 )
                         tags.Add( "1x" );
                     else
@@ -760,6 +760,12 @@ public static async Task<FetchModelsResult> FetchAvailableModelsAsync(
                                 if( defaultElement.GetBoolean( ) )
                                     model.IsPreview = false; // Default models are not preview
                             }
+                            if (model.Name.Contains("beta", StringComparison.CurrentCultureIgnoreCase))
+                                model.IsBeta = true;
+                            string[] replace_strs = ["(preview)","(beta)","preview","beta"];
+                            foreach (var str in replace_strs)
+                                model.Name = model.Name.Replace(str, "", StringComparison.OrdinalIgnoreCase);
+                            model.Name = model.Name.Trim().Replace("  ", " ");
 
                             result.Models.Add( model );
                         }

RegExpressWPFNET/RegExpressWPFNET/Code/TabData.cs

@@ -38,7 +38,7 @@ public sealed class TabData
     class AllTabData
     {
         public List<TabData> Tabs { get; set; } = new( );
-        public AIControlData AI { get; set; } = new( );
+        public AIUserConfig AI { get; set; } = new( );
         public bool AITabOpen { get; set; } = false;
     }