Merge pull request #62 from wisedev-code/43-include-grammar-in-chat-agent-contexts

feat: include grammar in chat agent contexts

Author: wisedev-pstach

Examples/Examples/Chat/ChatCustomGrammarExample.cs

@@ -0,0 +1,31 @@
+using LLama.Sampling;
+using MaIN.Core.Hub;
+using MaIN.Domain.Entities;
+
+namespace Examples;
+
+public class ChatCustomGrammarExample : IExample
+{
+    public async Task Start()
+    {
+        Console.WriteLine("ChatExample with grammar is running!");
+
+        var personGrammar = """
+                            root ::= person
+                            person ::= "{" ws "\"name\":" ws name "," ws "\"age\":" ws age "," ws "\"city\":" ws city ws "}"
+                            name ::= "\"" [A-Za-z ]+ "\""
+                            age ::= [1-9] | [1-9][0-9]
+                            city ::= "\"" [A-Za-z ]+ "\""
+                            ws ::= [ \t]*
+                            """;
+
+        await AIHub.Chat()
+            .WithInferenceParams(new InferenceParams()
+            {
+                Grammar = personGrammar
+            })
+            .WithModel("gemma2:2b")
+            .WithMessage("Generate random person")
+            .CompleteAsync(interactive: true);
+    }
+}

Examples/Examples/Program.cs

@@ -42,6 +42,7 @@ static void RegisterExamples(IServiceCollection services)
     services.AddTransient<ExampleRegistry>();
     services.AddTransient<McpExample>();
     services.AddTransient<ChatExample>();
+    services.AddTransient<ChatCustomGrammarExample>();
     services.AddTransient<ChatWithFilesExample>();
     services.AddTransient<ChatWithFilesFromStreamExample>();
     services.AddTransient<ChatWithVisionExample>();
@@ -128,6 +129,7 @@ public class ExampleRegistry(IServiceProvider serviceProvider)
         {
             ("\u25a0 Basic Chat", serviceProvider.GetRequiredService<ChatExample>()),
             ("\u25a0 Chat with Files", serviceProvider.GetRequiredService<ChatWithFilesExample>()),
+            ("\u25a0 Chat with custom grammar", serviceProvider.GetRequiredService<ChatCustomGrammarExample>()),
             ("\u25a0 Chat with Files from stream", serviceProvider.GetRequiredService<ChatWithFilesFromStreamExample>()),
             ("\u25a0 Chat with Vision", serviceProvider.GetRequiredService<ChatWithVisionExample>()),
             ("\u25a0 Chat with Image Generation", serviceProvider.GetRequiredService<ChatWithImageGenExample>()),

Releases/0.2.7.md

@@ -0,0 +1,5 @@
+# 0.2.7 release
+
+- Include grammar as inference param (allow you to enforce format that model should use for response)
+- New example
+- Fix issues with "infer" cli command (visual models for openai & gemini)

src/MaIN.Core/.nuspec

@@ -2,7 +2,7 @@
 <package>
   <metadata>
     <id>MaIN.NET</id>
-    <version>0.2.6</version>
+    <version>0.2.7</version>
     <authors>Wisedev</authors>
     <owners>Wisedev</owners>
     <icon>favicon.png</icon>

src/MaIN.Domain/Entities/InferenceParams.cs

@@ -1,3 +1,5 @@
+using LLama.Sampling;
+
 namespace MaIN.Domain.Entities;
 
 public class InferenceParams
@@ -17,4 +19,5 @@ public class InferenceParams
 
     public int TopK { get; init; } = 40;
     public float TopP { get; init; } = 0.9f;
+    public string? Grammar { get; init; } 
 }

src/MaIN.Domain/Entities/MemoryParams.cs

@@ -16,4 +16,6 @@ public class MemoryParams
     public int AnswerTokens { get; set; } = 500;
 
     public bool MultiModalMode { get; set; } = false;
+    
+    public string? Grammar { get; init; }
 }

src/MaIN.InferPage/Program.cs

@@ -81,7 +81,7 @@
         settings.BackendType = BackendType.OpenAi;
     });
 }
-if (Utils.Gemini)
+else if (Utils.Gemini)
 {
     builder.Services.AddMaIN(builder.Configuration, settings =>
     {

src/MaIN.InferPage/Utils.cs

@@ -6,7 +6,7 @@ public static class Utils
 {
     public static string? Model = "gemma2:2b";
     public static bool Visual => VisualModels.Contains(Model);
-    private static readonly string[] VisualModels = ["FLUX.1_Shnell", "dall-e-3"];
+    private static readonly string[] VisualModels = ["FLUX.1_Shnell", "FLUX.1", "dall-e-3", "dall-e", "imagen", "imagen-3"]; //user might type different names
     public static bool OpenAi { get; set; }
     public static bool Gemini { get; set; }
     public static string? Path { get; set; }

src/MaIN.Infrastructure/Models/InterferenceParamsDocument.cs

@@ -1,3 +1,5 @@
+using LLama.Sampling;
+
 namespace MaIN.Infrastructure.Models;
 
 public class InferenceParamsDocument
@@ -15,4 +17,5 @@ public class InferenceParamsDocument
     public int MaxTokens { get; set; }
     public int TopK { get; init; }
     public float TopP { get; init; }
+    public string? Grammar { get; set; }
 }

src/MaIN.Infrastructure/Models/MemoryParamsDocument.cs

@@ -9,4 +9,5 @@ public class MemoryParamsDocument
     public float Temperature { get; set; } 
     public int AnswerTokens { get; set; }
     public bool MultiModalMode { get; set; }
+    public string? Grammar { get; set; }
 }