implement ITextCompletion and IStreamableTextCompletion, misc

SpongeEngine · Jan 26, 2025 · 6beeaa1 · 6beeaa1
1 parent 74e5b6b
commit 6beeaa1
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 29 deletions.
diff --git a/SpongeEngine.LMStudioSharp.Tests/Common/LmStudioTestBase.cs b/SpongeEngine.LMStudioSharp.Tests/Common/LmStudioTestBase.cs
@@ -9,7 +9,7 @@ namespace SpongeEngine.LMStudioSharp.Tests.Common
     public abstract class LmStudioTestBase : IDisposable
     {
         protected readonly ITestOutputHelper Output;
-        protected LmStudioSharpClient Client { get; init; } = null!;
+        protected LMStudioSharpClient Client { get; init; } = null!;
         protected Model? DefaultModel { get; set; }
 
         protected LmStudioTestBase(ITestOutputHelper output)

diff --git a/SpongeEngine.LMStudioSharp.Tests/Integration/IntegrationTests.cs b/SpongeEngine.LMStudioSharp.Tests/Integration/IntegrationTests.cs
@@ -16,7 +16,7 @@ public class IntegrationTests : LmStudioTestBase
     {
         public IntegrationTests(ITestOutputHelper output) : base(output)
         {
-            Client = new LmStudioSharpClient(new LmStudioClientOptions()
+            Client = new LMStudioSharpClient(new LMStudioClientOptions()
             {
                 HttpClient = new HttpClient
                 {

diff --git a/SpongeEngine.LMStudioSharp.Tests/Unit/UnitTests.cs b/SpongeEngine.LMStudioSharp.Tests/Unit/UnitTests.cs
@@ -18,7 +18,7 @@ public class UnitTests : UnitTestBase
     {
         public UnitTests(ITestOutputHelper output) : base(output)
         {
-            Client = new LmStudioSharpClient(new LmStudioClientOptions()
+            Client = new LMStudioSharpClient(new LMStudioClientOptions()
             {
                 HttpClient = new HttpClient
                 {

diff --git a/SpongeEngine.LMStudioSharp/LMStudioClientOptions.cs b/SpongeEngine.LMStudioSharp/LMStudioClientOptions.cs
@@ -0,0 +1,6 @@
+using SpongeEngine.SpongeLLM.Core;
+
+namespace SpongeEngine.LMStudioSharp
+{
+    public class LMStudioClientOptions : LLMClientBaseOptions {}
+}
diff --git a/...gine.LMStudioSharp/LmStudioSharpClient.cs → ...gine.LMStudioSharp/LMStudioSharpClient.cs b/...gine.LMStudioSharp/LmStudioSharpClient.cs → ...gine.LMStudioSharp/LMStudioSharpClient.cs
@@ -4,12 +4,12 @@
 using System.Text.Json;
 using System.Text.Json.Serialization;
 using Microsoft.Extensions.Logging;
-using SpongeEngine.LLMSharp.Core;
-using SpongeEngine.LLMSharp.Core.Exceptions;
-using SpongeEngine.LLMSharp.Core.Interfaces;
-using SpongeEngine.LLMSharp.Core.Models;
 using SpongeEngine.LMStudioSharp.Models.Completion;
 using SpongeEngine.LMStudioSharp.Models.Model;
+using SpongeEngine.SpongeLLM.Core;
+using SpongeEngine.SpongeLLM.Core.Exceptions;
+using SpongeEngine.SpongeLLM.Core.Interfaces;
+using SpongeEngine.SpongeLLM.Core.Models;
 using ChatRequest = SpongeEngine.LMStudioSharp.Models.Chat.ChatRequest;
 using ChatResponse = SpongeEngine.LMStudioSharp.Models.Chat.ChatResponse;
 using CompletionRequest = SpongeEngine.LMStudioSharp.Models.Completion.CompletionRequest;
@@ -18,9 +18,9 @@
 
 namespace SpongeEngine.LMStudioSharp
 {
-    public class LmStudioSharpClient : LlmClientBase, ICompletionService
+    public class LMStudioSharpClient : LLMClientBase, ITextCompletion, IStreamableTextCompletion
     {
-        public override LmStudioClientOptions Options { get; }
+        public override LMStudioClientOptions Options { get; }
 
         private const string API_VERSION = "v0";
         private const string BASE_PATH = $"/api/{API_VERSION}";
@@ -29,7 +29,7 @@ public class LmStudioSharpClient : LlmClientBase, ICompletionService
         private const string COMPLETIONS_ENDPOINT = $"{BASE_PATH}/completions";
         private const string EMBEDDINGS_ENDPOINT = $"{BASE_PATH}/embeddings";
 
-        public LmStudioSharpClient(LmStudioClientOptions options) : base(options)
+        public LMStudioSharpClient(LMStudioClientOptions options) : base(options)
         {
             Options = options;
         }
@@ -260,10 +260,8 @@ public class StreamChoice
                 public string? FinishReason { get; set; }
             }
         }
-
-        public async Task<CompletionResult> CompleteAsync(
-            LLMSharp.Core.Models.CompletionRequest request,
-            CancellationToken cancellationToken = default)
+
+        public async Task<TextCompletionResult> CompleteTextAsync(TextCompletionRequest request, CancellationToken cancellationToken = new CancellationToken())
         {
             // Convert LLMSharp Core request to LMStudio request
             var lmStudioRequest = new Models.Completion.CompletionRequest
@@ -292,11 +290,11 @@ public async Task<CompletionResult> CompleteAsync(
             var completionText = response.Choices.FirstOrDefault()?.GetText() ?? string.Empty;
 
             // Convert LMStudio response to LLMSharp Core response
-            return new CompletionResult
+            return new TextCompletionResult
             {
                 Text = completionText,
                 ModelId = response.Model,
-                TokenUsage = new CompletionTokenUsage
+                TokenUsage = new TextCompletionTokenUsage
                 {
                     PromptTokens = response.Usage.PromptTokens,
                     CompletionTokens = response.Usage.CompletionTokens ?? 0,
@@ -318,10 +316,8 @@ public async Task<CompletionResult> CompleteAsync(
                 }
             };
         }
-
-        public async IAsyncEnumerable<CompletionToken> StreamCompletionAsync(
-            LLMSharp.Core.Models.CompletionRequest request,
-            [EnumeratorCancellation] CancellationToken cancellationToken = default)
+
+        public async IAsyncEnumerable<TextCompletionToken> CompleteTextStreamAsync(TextCompletionRequest request, CancellationToken cancellationToken = new CancellationToken())
         {
             // Convert LLMSharp Core request to LMStudio request
             var lmStudioRequest = new Models.Completion.CompletionRequest
@@ -352,7 +348,7 @@ public async IAsyncEnumerable<CompletionToken> StreamCompletionAsync(
                 var tokenCount = token.Split(new[] { ' ', '\n' }, StringSplitOptions.RemoveEmptyEntries).Length;
                 totalTokens += tokenCount;
 
-                yield return new CompletionToken
+                yield return new TextCompletionToken
                 {
                     Text = token,
                     TokenCount = totalTokens,

diff --git a/SpongeEngine.LMStudioSharp/LmStudioClientOptions.cs b/SpongeEngine.LMStudioSharp/LmStudioClientOptions.cs
diff --git a/SpongeEngine.LMStudioSharp/SpongeEngine.LMStudioSharp.csproj b/SpongeEngine.LMStudioSharp/SpongeEngine.LMStudioSharp.csproj
@@ -41,7 +41,7 @@
         <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.1" Condition="'$(TargetFramework)' == 'net7.0'" />
         <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.1" Condition="'$(TargetFramework)' == 'net8.0'" />
         <PackageReference Include="Polly" Version="8.5.1" />
-        <PackageReference Include="SpongeEngine.LLMSharp.Core" Version="2.0.1" />
+        <PackageReference Include="SpongeEngine.SpongeLLM.Core" Version="0.0.3" />
         <PackageReference Include="System.Linq.Async" Version="6.0.1" />
     </ItemGroup>
 

diff --git a/...gine.LMStudioSharp/Utils/LmStudioUtils.cs → ...gine.LMStudioSharp/Utils/LMStudioUtils.cs b/...gine.LMStudioSharp/Utils/LmStudioUtils.cs → ...gine.LMStudioSharp/Utils/LMStudioUtils.cs
@@ -6,7 +6,7 @@
 
 namespace SpongeEngine.LMStudioSharp.Utils
 {
-    public static class LmStudioUtils
+    public static class LMStudioUtils
     {
         /// <summary>
         /// Creates a default completion request with common settings