Merge branch 'main' into custom-tokenizer

app/MindWork AI Studio/Provider/BaseProvider.cs

@@ -29,7 +29,7 @@ public abstract class BaseProvider : IProvider, ISecretId
     /// <summary>
     /// The HTTP client to use it for all requests.
     /// </summary>
-    protected readonly HttpClient httpClient = new();
+    protected readonly HttpClient HttpClient = new();
     
     /// <summary>
     /// The logger to use.
@@ -73,7 +73,7 @@ public abstract class BaseProvider : IProvider, ISecretId
         this.Provider = provider;
 
         // Set the base URL:
-        this.httpClient.BaseAddress = new(url);
+        this.HttpClient.BaseAddress = new(url);
     }
     
     #region Handling of IProvider, which all providers must implement
@@ -93,6 +93,9 @@ public abstract class BaseProvider : IProvider, ISecretId
     /// <inheritdoc />
     public string TokenizerPath { get; init; } = string.Empty;
 
+    /// <inheritdoc />
+    public abstract bool HasModelLoadingCapability { get; }
+
     /// <inheritdoc />
     public abstract IAsyncEnumerable<ContentStreamChunk> StreamChatCompletion(Model chatModel, ChatThread chatThread, SettingsManager settingsManager, CancellationToken token = default);
     
@@ -106,16 +109,16 @@ public abstract class BaseProvider : IProvider, ISecretId
     public abstract Task<IReadOnlyList<IReadOnlyList<float>>> EmbedTextAsync(Model embeddingModel, SettingsManager settingsManager, CancellationToken token = default, params List<string> texts);
     
     /// <inheritdoc />
-    public abstract Task<IEnumerable<Model>> GetTextModels(string? apiKeyProvisional = null, CancellationToken token = default);
+    public abstract Task<ModelLoadResult> GetTextModels(string? apiKeyProvisional = null, CancellationToken token = default);
     
     /// <inheritdoc />
-    public abstract Task<IEnumerable<Model>> GetImageModels(string? apiKeyProvisional = null, CancellationToken token = default);
+    public abstract Task<ModelLoadResult> GetImageModels(string? apiKeyProvisional = null, CancellationToken token = default);
     
     /// <inheritdoc />
-    public abstract Task<IEnumerable<Model>> GetEmbeddingModels(string? apiKeyProvisional = null, CancellationToken token = default);
+    public abstract Task<ModelLoadResult> GetEmbeddingModels(string? apiKeyProvisional = null, CancellationToken token = default);
 
     /// <inheritdoc />
-    public abstract Task<IEnumerable<Model>> GetTranscriptionModels(string? apiKeyProvisional = null, CancellationToken token = default);
+    public abstract Task<ModelLoadResult> GetTranscriptionModels(string? apiKeyProvisional = null, CancellationToken token = default);
     
     #endregion
     
@@ -131,6 +134,71 @@ public abstract class BaseProvider : IProvider, ISecretId
     public string SecretName => this.InstanceName;
 
     #endregion
+
+    protected static ModelLoadResult SuccessfulModelLoadResult(IEnumerable<Model> models) => ModelLoadResult.FromModels(models);
+
+    protected static ModelLoadResult FailedModelLoadResult(ModelLoadFailureReason failureReason, string? technicalDetails = null) => ModelLoadResult.Failure(failureReason, technicalDetails);
+
+    protected async Task<string?> GetModelLoadingSecretKey(SecretStoreType storeType, string? apiKeyProvisional = null, bool isTryingSecret = false) => apiKeyProvisional switch
+    {
+        not null => apiKeyProvisional,
+        _ => await RUST_SERVICE.GetAPIKey(this, storeType, isTrying: isTryingSecret) switch
+        {
+            { Success: true } result => await result.Secret.Decrypt(ENCRYPTION),
+            _ => null,
+        }
+    };
+
+    protected static ModelLoadFailureReason GetDefaultModelLoadFailureReason(HttpResponseMessage response) => response.StatusCode switch
+    {
+        HttpStatusCode.Unauthorized => ModelLoadFailureReason.INVALID_OR_MISSING_API_KEY,
+        HttpStatusCode.Forbidden => ModelLoadFailureReason.AUTHENTICATION_OR_PERMISSION_ERROR,
+        
+        _ => ModelLoadFailureReason.PROVIDER_UNAVAILABLE,
+    };
+
+    protected async Task<ModelLoadResult> LoadModelsResponse<TResponse>(
+        SecretStoreType storeType,
+        string requestPath,
+        Func<TResponse, IEnumerable<Model>> modelFactory,
+        CancellationToken token,
+        string? apiKeyProvisional = null,
+        Func<HttpResponseMessage, string, ModelLoadFailureReason>? failureReasonSelector = null,
+        Action<HttpRequestMessage, string>? requestConfigurator = null,
+        JsonSerializerOptions? jsonSerializerOptions = null,
+        bool isTryingSecret = false)
+    {
+        var secretKey = await this.GetModelLoadingSecretKey(storeType, apiKeyProvisional, isTryingSecret);
+        if (string.IsNullOrWhiteSpace(secretKey) && !isTryingSecret)
+            return FailedModelLoadResult(ModelLoadFailureReason.INVALID_OR_MISSING_API_KEY, "No API key available for model loading.");
+
+        using var request = new HttpRequestMessage(HttpMethod.Get, requestPath);
+        if (requestConfigurator is not null)
+            requestConfigurator(request, secretKey ?? string.Empty);
+        else if (!string.IsNullOrWhiteSpace(secretKey))
+            request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", secretKey);
+
+        using var response = await this.HttpClient.SendAsync(request, token);
+        var responseBody = await response.Content.ReadAsStringAsync(token);
+        if (!response.IsSuccessStatusCode)
+        {
+            var failureReason = failureReasonSelector?.Invoke(response, responseBody) ?? GetDefaultModelLoadFailureReason(response);
+            return FailedModelLoadResult(failureReason, $"Status={(int)response.StatusCode} {response.ReasonPhrase}; Body='{responseBody}'");
+        }
+
+        try
+        {
+            var parsedResponse = JsonSerializer.Deserialize<TResponse>(responseBody, jsonSerializerOptions ?? JSON_SERIALIZER_OPTIONS);
+            if (parsedResponse is null)
+                return FailedModelLoadResult(ModelLoadFailureReason.INVALID_RESPONSE, "Model list response could not be deserialized.");
+
+            return SuccessfulModelLoadResult(modelFactory(parsedResponse));
+        }
+        catch (Exception e)
+        {
+            return FailedModelLoadResult(ModelLoadFailureReason.INVALID_RESPONSE, e.Message);
+        }
+    }
     
     /// <summary>
     /// Sends a request and handles rate limiting by exponential backoff.
@@ -158,7 +226,7 @@ public abstract class BaseProvider : IProvider, ISecretId
             // Please notice: We do not dispose the response here. The caller is responsible
             // for disposing the response object. This is important because the response
             // object is used to read the stream.
-            var nextResponse = await this.httpClient.SendAsync(request, HttpCompletionOption.ResponseHeadersRead, token);
+            var nextResponse = await this.HttpClient.SendAsync(request, HttpCompletionOption.ResponseHeadersRead, token);
             if (nextResponse.IsSuccessStatusCode)
             {
                 response = nextResponse;
@@ -568,6 +636,78 @@ public abstract class BaseProvider : IProvider, ISecretId
         streamReader.Dispose();
     }
 
+    /// <summary>
+    /// Streams the chat completion from an OpenAI-compatible provider using the Chat Completion API.
+    /// </summary>
+    /// <param name="providerName">The provider name for logging and error reporting.</param>
+    /// <param name="chatModel">The selected chat model.</param>
+    /// <param name="chatThread">The current chat thread.</param>
+    /// <param name="settingsManager">The settings manager.</param>
+    /// <param name="requestFactory">Builds the provider-specific request body.</param>
+    /// <param name="storeType">The secret store type.</param>
+    /// <param name="isTryingSecret">Whether the API key is optional.</param>
+    /// <param name="systemPromptRole">The system prompt role to use.</param>
+    /// <param name="requestPath">The request path, relative to the provider base URL.</param>
+    /// <param name="headersAction">Optional additional headers to add.</param>
+    /// <param name="token">The cancellation token.</param>
+    /// <typeparam name="TRequest">The request DTO type.</typeparam>
+    /// <typeparam name="TDelta">The delta stream line type.</typeparam>
+    /// <typeparam name="TAnnotation">The annotation stream line type.</typeparam>
+    /// <returns>The streamed content chunks.</returns>
+    protected async IAsyncEnumerable<ContentStreamChunk> StreamOpenAICompatibleChatCompletion<TRequest, TDelta, TAnnotation>(
+        string providerName,
+        Model chatModel,
+        ChatThread chatThread,
+        SettingsManager settingsManager,
+        Func<TextMessage, IDictionary<string, object>, Task<TRequest>> requestFactory,
+        SecretStoreType storeType = SecretStoreType.LLM_PROVIDER,
+        bool isTryingSecret = false,
+        string systemPromptRole = "system",
+        string requestPath = "chat/completions",
+        Action<HttpRequestHeaders>? headersAction = null,
+        [EnumeratorCancellation] CancellationToken token = default)
+        where TDelta : IResponseStreamLine
+        where TAnnotation : IAnnotationStreamLine
+    {
+        // Get the API key:
+        var requestedSecret = await RUST_SERVICE.GetAPIKey(this, storeType, isTrying: isTryingSecret);
+        if(!requestedSecret.Success && !isTryingSecret)
+            yield break;
+
+        // Prepare the system prompt:
+        var systemPrompt = new TextMessage
+        {
+            Role = systemPromptRole,
+            Content = chatThread.PrepareSystemPrompt(settingsManager),
+        };
+
+        // Parse the API parameters:
+        var apiParameters = this.ParseAdditionalApiParameters();
+
+        // Prepare the provider HTTP chat request:
+        var providerChatRequest = JsonSerializer.Serialize(await requestFactory(systemPrompt, apiParameters), JSON_SERIALIZER_OPTIONS);
+
+        async Task<HttpRequestMessage> RequestBuilder()
+        {
+            // Build the HTTP post request:
+            var request = new HttpRequestMessage(HttpMethod.Post, requestPath);
+
+            // Set the authorization header:
+            if (requestedSecret.Success)
+                request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", await requestedSecret.Secret.Decrypt(ENCRYPTION));
+
+            // Set provider-specific headers:
+            headersAction?.Invoke(request.Headers);
+
+            // Set the content:
+            request.Content = new StringContent(providerChatRequest, Encoding.UTF8, "application/json");
+            return request;
+        }
+
+        await foreach (var content in this.StreamChatCompletionInternal<TDelta, TAnnotation>(providerName, RequestBuilder, token))
+            yield return content;
+    }
+
     protected async Task<string> PerformStandardTranscriptionRequest(RequestedSecret requestedSecret, Model transcriptionModel, string audioFilePath, Host host = Host.NONE, CancellationToken token = default)
     {
         try
@@ -627,7 +767,7 @@ public abstract class BaseProvider : IProvider, ISecretId
                     break;
             }
             
-            using var response = await this.httpClient.SendAsync(request, token);
+            using var response = await this.HttpClient.SendAsync(request, token);
             var responseBody = response.Content.ReadAsStringAsync(token).Result;
         
             if (!response.IsSuccessStatusCode)
@@ -697,7 +837,7 @@ public abstract class BaseProvider : IProvider, ISecretId
             
             // Set the content:
             request.Content = new StringContent(embeddingRequest, Encoding.UTF8, "application/json");
-            using var response = await this.httpClient.SendAsync(request, token);
+            using var response = await this.HttpClient.SendAsync(request, token);
             var responseBody = response.Content.ReadAsStringAsync(token).Result;
         
             if (!response.IsSuccessStatusCode)