Added defaults and fixed message formatting for some elements

Author: Tomasz Juszczak

Readme.md

@@ -90,6 +90,12 @@ You can start your message with the name of the model without parameters eg:
 
 Will use gpt-3.5-turbo instead of the default gpt-4 model. See GptClient for more aliases.
 
+### Built-in Parameters
+There are some built in parameters. Use `/gpt help` to see them. You can modify the parameters in `appsettings.json` file,
+or per request.
+
+See GptDefaults.cs for more information about the defaults or `appsettings.Example.json`.
+
 ### Custom parameters
 You can add you own custom parameters to the bot to minimize the typing for each repated request. To do so, add the it's definition
 to the `GptCommands` section in `appsettings.json`. For example:
@@ -115,65 +121,6 @@ usage:
 
 > @GPT-4 -refactor `public class Foo { public void Bar() { Console.WriteLine("Hello World"); } }`
 
-### Parameters
-**FAQ: Fine-tuning requests using parameters**
-
-**Q1: How do I use the parameters?**
-
-A1: You can use these parameters at the beginning of your request to fine-tune the model's output. To utilize them, pass
-the desired parameter name followed by its value. For example: `-maxTokens 50`. The request should be followed by your
-output. eg:
-
-> @GPT-4 -maxTokens 50 How are you today?
-
-Please note that the parameters should be separated by a space. Should be at the beginning of the request. Right after
-the bot's name. And should be followed by a space. For parameters that have spaces in them `"`.
-
-**Q2: What does the `-maxTokens` parameter do?**
-
-A2: The `-maxTokens` parameter limits the number of tokens (words or word segments) in the generated output. You can set
-this value by passing an integer to the parameter. Example usage: `-maxTokens 100`. Default is 2048 tokens. GPT-3.5 has a
-limit of 4000 and GPT-4 has a limit of 8000 tokens.
-
-**Q3: How does the `-temperature` parameter work?**
-
-A3: The `-temperature` parameter controls the randomness of the model's output. Higher values (e.g., 1.0) make the output
-more random, while lower values (e.g., 0.1) make it more deterministic. You can set this value by passing a float to the
-parameter. Example usage: `-temperature 0.7`. Default is 0.7
-
-**Q4: What is the `-topP` parameter?**
-
-A4: The `-topP` parameter (also known as "nucleus sampling") filters the model's token choices based on cumulative
-probability. You can set this value by passing a float between 0 and 1 to the parameter. Lower values make the output
-more focused, while higher values allow for more diversity. Example usage: `-topP 0.9`. Default is 1.
-
-**Q5: How do I use the `-presencePenalty` parameter?**
-
-A5: The `-presencePenalty` parameter penalizes tokens that are already present in the generated text. A higher value
-discourages repetition, while a lower value allows for more repetition. You can set this value by passing a float to the
-parameter. Example usage: `-presencePenalty 0.5`. Default is 0.
-
-**Q6: What does the `-frequencyPenalty` parameter do?**
-
-A6: The `-frequencyPenalty` parameter discourages the use of tokens that appear frequently in the training data. A higher
-value will make the output more creative, while a lower value will make it more common. You can set this value by
-passing a float to the parameter. Example usage: `-frequencyPenalty 0.3`. Default is 0.
-
-**Q7: What is the -model parameter?**
-
-A7: The -model parameter allows you to specify the name of the model you want to use for generating the output. You can
-set this value by passing a string to the parameter. Example usage: `-model "gpt-3.5-turbo"`. Default is gpt-4.
-Available models:
- - gpt-4
- - gpt-3.5-turbo
-
-**Q8: How do I use the -system parameter?**
-
-A8: The -system parameter lets you specify the system message that the model should use. The default message is "You are
-a helpful assistant. Today is {Current Date}", but you can use anything you want. Eg
-> @GPT-4 -system "You are a Math tutor, your task is to help but not to provide answers so that the student can think
-for themselves." I don't know how mutch is 37 * 12, please give me an answer.
-
 ## Docker
 
 You can start the docker container with the following command:

Slack-GPT-Socket/ApiSettings.cs

@@ -15,6 +15,7 @@ public class GptClient
     private readonly OpenAIClient _api;
     private readonly GptCustomCommands _customCommands;
     private readonly ILogger _log;
+    private readonly GptDefaults _gptDefaults;
 
     /// <summary>
     ///     Initializes static members of the <see cref="GptClient" /> class.
@@ -34,7 +35,7 @@ static GptClient()
     /// <param name="customCommands">Custom commands handler</param>
     /// <param name="log">The logger instance.</param>
     /// <param name="settings">The API settings.</param>
-    public GptClient(GptCustomCommands customCommands, ILogger<GptClient> log, IOptions<ApiSettings> settings)
+    public GptClient(GptCustomCommands customCommands, ILogger<GptClient> log, IOptions<GptDefaults> gptDefaults, IOptions<ApiSettings> settings)
     {
         var httpClient = new HttpClient()
         {
@@ -43,6 +44,7 @@ public GptClient(GptCustomCommands customCommands, ILogger<GptClient> log, IOpti
         _api = new OpenAIClient(settings.Value.OpenAIKey, OpenAIClientSettings.Default, httpClient);
         _customCommands = customCommands;
         _log = log;
+        _gptDefaults = gptDefaults.Value;
     }
 
     /// <summary>
@@ -55,18 +57,16 @@ public async Task<GptResponse> GeneratePrompt(List<WritableChatPrompt> chatPromp
     {
         // get the last prompt
         var userPrompt = chatPrompts.Last(chatPrompt => chatPrompt.Role == "user");
-        var prompt = new GptRequest
-        {
-            UserId = userId,
-            Prompt = userPrompt.Content
-        };
+        var prompt = GptRequest.Default(_gptDefaults);
+        prompt.UserId = userId;
+        prompt.Prompt = userPrompt.Content;
 
         var chatRequest = ParseRequest(chatPrompts, prompt);
 
         try
         {
             var result = await _api.ChatEndpoint.GetCompletionAsync(chatRequest);
-            _log.LogInformation("GPT-3 response: {Response}", result.FirstChoice);
+            _log.LogInformation("GPT response: {Response}", result.FirstChoice);
 
             return new GptResponse
             {
@@ -96,7 +96,8 @@ private ChatRequest ParseRequest(List<WritableChatPrompt> chatPrompts, GptReques
     {
         foreach (var chatPrompt in chatPrompts)
         {
-            var content = new GptRequest { Prompt = chatPrompt.Content };
+            var content = GptRequest.Default(_gptDefaults);
+            content.Prompt = chatPrompt.Content;
             ResolveModel(ref content);
             ResolveParameters(ref content);
             chatPrompt.Content = content.Prompt;
@@ -106,12 +107,12 @@ private ChatRequest ParseRequest(List<WritableChatPrompt> chatPrompts, GptReques
         ResolveParameters(ref request);
 
         WritableChatPrompt system;
-        if (request.System != null)
-            system = new WritableChatPrompt("system", request.System);
+        if (request.System.ShoudReplace)
+            system = new WritableChatPrompt("system", request.System.Build());
         else
         {
             system = new WritableChatPrompt("system",
-                $"You are a helpful assistant. Today is {DateTime.Now:yyyy-MM-ddTHH:mm:ssZ}");
+                $"You are a helpful assistant. Today is {DateTime.Now:yyyy-MM-ddTHH:mm:ssZ} " + request.System.Build());
         }
 
         var requestPrompts = new List<WritableChatPrompt>();
@@ -162,9 +163,13 @@ public static void ResolveModel(ref GptRequest input)
             }
         }
 
-        if (!modelFound)
+        if (modelFound) return;
+        
+        var inputModel = input.Model;
+        // check if current model is valid
+        if (Models.All(modelInfo => modelInfo.Model != inputModel))
         {
-            // if no match is found, set model property of input to the model of the first item in the models array
+            // if not, set model property of input to the model of the first item in the models array
             input.Model = Models[0].Model;
         }
     }
@@ -187,14 +192,7 @@ public void ResolveParameters(ref GptRequest input)
             var paramValueTrim = match.Groups[2]?.Value.Trim() ?? string.Empty;
             var paramValue = paramValueTrim.Trim('"');
 
-            var paramNameIndex = inputPrompt.IndexOf(paramName, StringComparison.InvariantCultureIgnoreCase);
-            var paramEndIndex = paramNameIndex + paramName.Length + paramValueTrim.Length + 2;
-
-            if (lastIndex + 5 < paramNameIndex) break;
-
-            lastIndex = paramEndIndex;
-            input.Prompt = input.Prompt.Replace(paramName + " " + paramValueTrim, "").Trim();
-
+            bool hasValue = true;
             try
             {
                 switch (paramName)
@@ -218,19 +216,49 @@ public void ResolveParameters(ref GptRequest input)
                         input.Model = paramValue.ToLowerInvariant();
                         break;
                     case "-system":
-                        input.System = paramValue;
+                        input.System.Replace(paramValue);
                         break;
                     default:
                         if (_customCommands.TryResolveCommand(paramName, out var prompt))
                         {
-                            input.Prompt = prompt + "\n" + input.Prompt;
+                            if (prompt.AsSystem)
+                            {
+                                input.System.Append(prompt!.Prompt);
+                            }
+                            else
+                            {
+                                input.Prompt = prompt!.Prompt + "\n" + input.Prompt;
+                            }
+                            hasValue = false;
                         }
                         else
                         {
                             Console.WriteLine($"Unrecognized parameter: {paramName}");
                         }
                         break;
                 }
+                
+                // Trim the input Prompt to remove the parameter,
+                // update last index to check if we've reached the end of the parameters
+                int paramNameIndex = inputPrompt.IndexOf(paramName, StringComparison.InvariantCultureIgnoreCase);
+            
+                int paramEndIndex;
+                string searchString;
+                if (hasValue)
+                {
+                    paramEndIndex = paramNameIndex + paramName.Length + paramValueTrim.Length + 2;
+                    searchString = paramName + " " + paramValueTrim;
+                }
+                else
+                {
+                    paramEndIndex = paramNameIndex + paramName.Length + 2;
+                    searchString = paramName + " ";
+                }
+
+                if (lastIndex + 5 < paramNameIndex) break;
+
+                lastIndex = paramEndIndex;
+                input.Prompt = input.Prompt.Replace(searchString, "").Trim();
             }
             catch (Exception e)
             {

Slack-GPT-Socket/GptApi/GptClient.cs

@@ -21,18 +21,17 @@ public GptCustomCommands(IOptionsMonitor<GptCommands> gptCommands)
     ///     Checks if the command is a custom command and returns the prompt if it is.
     /// </summary>
     /// <param name="command">Command to resolve</param>
-    /// <param name="prompt">Prompt to add to the request</param>
+    /// <param name="result">GptCommand object</param>
     /// <returns>True if found</returns>
-    public bool TryResolveCommand(string command, out string prompt)
+    public bool TryResolveCommand(string command, out GptCommand? result)
     {
-        prompt = string.Empty;
+        result = null;
         foreach (var gptCommand in _gptCommands.CurrentValue.Commands)
         {
-            if (gptCommand.Command == command)
-            {
-                prompt = gptCommand.Prompt;
-                return true;
-            }
+            if (gptCommand.Command != command) continue;
+            
+            result = gptCommand;
+            return true;
         }
 
         return false;

Slack-GPT-Socket/GptApi/GptCustomCommands.cs

@@ -5,6 +5,36 @@
 /// </summary>
 public class GptRequest
 {
+    /// <summary>
+    ///     Creates a new GPT request with default values.
+    /// </summary>
+    /// <param name="defaults"></param>
+    /// <returns></returns>
+    public static GptRequest Default(GptDefaults defaults)
+    {
+        var request = new GptRequest();
+        if (defaults.MaxTokens.HasValue)
+            request.MaxTokens = defaults.MaxTokens.Value;
+        if (defaults.Temperature.HasValue)
+            request.Temperature = defaults.Temperature.Value;
+        if (defaults.TopP.HasValue)
+            request.TopP = defaults.TopP.Value;
+        if (defaults.PresencePenalty.HasValue)
+            request.PresencePenalty = defaults.PresencePenalty.Value;
+        if (defaults.FrequencyPenalty.HasValue)
+            request.FrequencyPenalty = defaults.FrequencyPenalty.Value;
+        if (defaults.Model != null)
+            request.Model = defaults.Model;
+        if (defaults.System != null)
+            request.System.Replace(defaults.System);
+        return request;
+    }
+    
+    /// <summary>
+    ///     Hide the default constructor.
+    /// </summary>
+    private GptRequest(){}
+    
     /// <summary>
     ///     Gets or sets the user identifier.
     /// </summary>
@@ -48,5 +78,5 @@ public class GptRequest
     /// <summary>
     ///     Gets or sets the system identifier (optional).
     /// </summary>
-    public string? System { get; set; }
+    public GptSystemMessageBuilder System { get; set; } = new();
 }