refactor: apply sugestions from comments in PR Refactor/model configuration #119

- Make TTS models implement ITTSModel
- Fix and add tests
- Cleanup

Author: srebrek

Examples/Examples.SimpleConsole/Program.cs

@@ -1,6 +1,5 @@
 using MaIN.Core;
 using MaIN.Core.Hub;
-using MaIN.Domain.Models.Abstract;
 using MaIN.Domain.Models.Concrete;
 
 MaINBootstrapper.Initialize();

Examples/Examples/Chat/ChatExampleGemini.cs

@@ -27,4 +27,4 @@ await AIHub.Chat()
             .WithMessage("Is the killer whale the smartest animal?")
             .CompleteAsync(interactive: true);
     }
-}
+}

Examples/Examples/Chat/ChatWithTextToSpeechExample.cs

@@ -22,7 +22,7 @@ public async Task Start()
         await AIHub.Chat()
             .WithModel<Gemma2_2b>()
             .WithMessage("Generate a 4 sentence poem.")
-            .Speak(new TextToSpeechParams("kokoro:82m", voice, true))
+            .Speak(new TextToSpeechParams(new Kokoro_82m(), voice, true))
             .CompleteAsync(interactive: true);
 
         Console.WriteLine("Done!");

src/MaIN.Core.UnitTests/ChatContextTests.cs

@@ -1,5 +1,6 @@
 using MaIN.Core.Hub.Contexts;
 using MaIN.Domain.Entities;
+using MaIN.Domain.Models.Abstract;
 using MaIN.Services.Services.Abstract;
 using MaIN.Services.Services.Models;
 using Moq;
@@ -88,6 +89,7 @@ public async Task CompleteAsync_ShouldCallChatService()
             .ReturnsAsync(chatResult);
 
         _chatContext.WithMessage("User message");
+        _chatContext.WithModel(new GenericLocalModel("test-model"));
 
         // Act
         var result = await _chatContext.CompleteAsync();
@@ -110,4 +112,19 @@ public async Task GetCurrentChat_ShouldCallChatService()
         // Assert
         Assert.Equal(chat, result);
     }
-}
+
+    [Fact]
+    public async Task WithModel_ShouldSetModelIdAndInstance()
+    {
+        // Arrange
+        var model = new GenericLocalModel("default");
+
+        // Act
+        await _chatContext.WithModel(model)
+            .WithMessage("User message")
+            .CompleteAsync();
+        
+        // Assert
+        _mockChatService.Verify(s => s.Completions(It.Is<Chat>(c => c.ModelId == "default" && c.ModelInstance == model), It.IsAny<bool>(), It.IsAny<bool>(), null), Times.Once);
+    }
+}

src/MaIN.Core/Hub/Contexts/ChatContext.cs

@@ -3,6 +3,7 @@
 using MaIN.Domain.Entities;
 using MaIN.Domain.Entities.Tools;
 using MaIN.Domain.Exceptions.Chats;
+using MaIN.Domain.Exceptions.Models;
 using MaIN.Domain.Models;
 using MaIN.Domain.Models.Abstract;
 using MaIN.Services;
@@ -53,7 +54,16 @@ public IChatMessageBuilder WithModel(AIModel model)
     [Obsolete("Use WithModel(AIModel model) or WithModel<TModel>() instead.")]
     public IChatMessageBuilder WithModel(string modelId)
     {
-        var model = ModelRegistry.GetById(modelId);
+        AIModel model;
+        try
+        {
+            model = ModelRegistry.GetById(modelId);
+        }
+        catch (Exception ex)
+        {
+
+            throw new Exception($"Model with ID '{modelId}' not found in registry. Use WithModel(AIModel model) or WithModel<TModel>() instead.", ex);
+        }
         SetModel(model);
         return this;
     }
@@ -192,7 +202,7 @@ public async Task<ChatResult> CompleteAsync(
     {
         if (_chat.ModelInstance is null)
         {
-            throw new ChatNotInitializedException();
+            throw new MissingModelInstanceException();
         }
         if (_chat.Messages.Count == 0)
         {

src/MaIN.Core/Hub/Contexts/ModelContext.cs

@@ -113,7 +113,7 @@ public IModelContext Download(string modelId)
         var model = ModelRegistry.GetById(modelId) ?? throw new ModelNotSupportedException(modelId);
         if (model is not LocalModel localModel)
         {
-            throw new MissingModelIdException(nameof(LocalModel));
+            throw new InvalidModelTypeException(nameof(LocalModel));
         }
 
         if (localModel.DownloadUrl is null)

src/MaIN.Domain/Entities/Chat.cs

@@ -9,12 +9,25 @@ public class Chat
 {
     public string Id { get; init; } = string.Empty;
     public required string Name { get; init; }
-    public required string ModelId { get; set; }
+    public required string ModelId
+    {
+        get => _modelInstance?.Id ?? string.Empty;
+        set
+        {
+            if (string.IsNullOrEmpty(value))
+            {
+                _modelInstance = null;
+                return;
+            }
+
+            _modelInstance = ModelRegistry.GetById(value);
+        }
+    }
     private AIModel? _modelInstance;
     public AIModel? ModelInstance
     {
-        get => _modelInstance ??= ModelRegistry.GetById(ModelId);
-        set => (_modelInstance, ModelId) = (value, value?.Id ?? ModelId);
+        get => _modelInstance;
+        set => (_modelInstance, ModelId) = (value, value?.Id ?? string.Empty);
     }
     public List<Message> Messages { get; set; } = [];
     public ChatType Type { get; set; } = ChatType.Conversation;

src/MaIN.Domain/Entities/TextToSpeechParams.cs

@@ -1,15 +1,5 @@
-namespace MaIN.Domain.Entities;
+using MaIN.Domain.Models.Abstract;
 
-public class TextToSpeechParams
-{
-    public string Model { get; set; }
-    public Voice Voice { get;  set; }
-    public bool Playback { get; set; }
+namespace MaIN.Domain.Entities;
 
-    public TextToSpeechParams(string model, Voice voice, bool playback = false)
-    {
-        Model = model;  
-        Voice = voice;
-        Playback = playback;
-    }
-}
+public sealed record TextToSpeechParams(AIModel Model, Voice Voice, bool Playback = false);

src/MaIN.Domain/Exceptions/ModelException.cs

@@ -5,6 +5,6 @@ namespace MaIN.Domain.Exceptions.Models.LocalModels;
 public class DownloadUrlNullOrEmptyException()
     : MaINCustomException("Download url cannot be null or empty.")
 {
-    public override string PublicErrorMessage => "Download url cannot be null or empty.";
+    public override string PublicErrorMessage => Message;
     public override HttpStatusCode HttpStatusCode => HttpStatusCode.BadRequest;
-}
+}