Added the OpenRouter provider (#595)

app/MindWork AI Studio/Provider/LLMProviders.cs

@@ -15,7 +15,8 @@ public enum LLMProviders
     DEEP_SEEK = 11,
     ALIBABA_CLOUD = 12,
     PERPLEXITY = 14,
-    
+    OPEN_ROUTER = 15,
+
     FIREWORKS = 5,
     GROQ = 6,
     HUGGINGFACE = 13,

app/MindWork AI Studio/Provider/LLMProvidersExtensions.cs

@@ -9,6 +9,7 @@ using AIStudio.Provider.Helmholtz;
 using AIStudio.Provider.HuggingFace;
 using AIStudio.Provider.Mistral;
 using AIStudio.Provider.OpenAI;
+using AIStudio.Provider.OpenRouter;
 using AIStudio.Provider.Perplexity;
 using AIStudio.Provider.SelfHosted;
 using AIStudio.Provider.X;
@@ -42,7 +43,8 @@ public static class LLMProvidersExtensions
         LLMProviders.DEEP_SEEK => "DeepSeek",
         LLMProviders.ALIBABA_CLOUD => "Alibaba Cloud",
         LLMProviders.PERPLEXITY => "Perplexity",
-        
+        LLMProviders.OPEN_ROUTER => "OpenRouter",
+
         LLMProviders.GROQ => "Groq",
         LLMProviders.FIREWORKS => "Fireworks.ai",
         LLMProviders.HUGGINGFACE => "Hugging Face",
@@ -92,7 +94,9 @@ public static class LLMProvidersExtensions
         LLMProviders.ALIBABA_CLOUD => Confidence.CHINA_NO_TRAINING.WithRegion("Asia").WithSources("https://www.alibabacloud.com/help/en/model-studio/support/faq-about-alibaba-cloud-model-studio").WithLevel(settingsManager.GetConfiguredConfidenceLevel(llmProvider)),
             
         LLMProviders.PERPLEXITY => Confidence.USA_NO_TRAINING.WithRegion("America, U.S.").WithSources("https://www.perplexity.ai/hub/legal/perplexity-api-terms-of-service").WithLevel(settingsManager.GetConfiguredConfidenceLevel(llmProvider)),
-        
+
+        LLMProviders.OPEN_ROUTER => Confidence.USA_HUB.WithRegion("America, U.S.").WithSources("https://openrouter.ai/privacy", "https://openrouter.ai/terms").WithLevel(settingsManager.GetConfiguredConfidenceLevel(llmProvider)),
+
         LLMProviders.SELF_HOSTED => Confidence.SELF_HOSTED.WithLevel(settingsManager.GetConfiguredConfidenceLevel(llmProvider)),
         
         LLMProviders.HELMHOLTZ => Confidence.GDPR_NO_TRAINING.WithRegion("Europe, Germany").WithSources("https://helmholtz.cloud/services/?serviceID=d7d5c597-a2f6-4bd1-b71e-4d6499d98570").WithLevel(settingsManager.GetConfiguredConfidenceLevel(llmProvider)),
@@ -128,7 +132,8 @@ public static class LLMProvidersExtensions
         LLMProviders.DEEP_SEEK => false,
         LLMProviders.HUGGINGFACE => false,
         LLMProviders.PERPLEXITY => false,
-        
+        LLMProviders.OPEN_ROUTER => true,
+
         //
         // Self-hosted providers are treated as a special case anyway.
         //
@@ -171,7 +176,8 @@ public static class LLMProvidersExtensions
                 LLMProviders.DEEP_SEEK => new ProviderDeepSeek { InstanceName = instanceName, AdditionalJsonApiParameters = expertProviderApiParameter },
                 LLMProviders.ALIBABA_CLOUD => new ProviderAlibabaCloud { InstanceName = instanceName, AdditionalJsonApiParameters = expertProviderApiParameter },
                 LLMProviders.PERPLEXITY => new ProviderPerplexity { InstanceName = instanceName, AdditionalJsonApiParameters = expertProviderApiParameter },
-                
+                LLMProviders.OPEN_ROUTER => new ProviderOpenRouter { InstanceName = instanceName, AdditionalJsonApiParameters = expertProviderApiParameter },
+
                 LLMProviders.GROQ => new ProviderGroq { InstanceName = instanceName, AdditionalJsonApiParameters = expertProviderApiParameter },
                 LLMProviders.FIREWORKS => new ProviderFireworks { InstanceName = instanceName, AdditionalJsonApiParameters = expertProviderApiParameter },
                 LLMProviders.HUGGINGFACE => new ProviderHuggingFace(inferenceProvider, model) { InstanceName = instanceName, AdditionalJsonApiParameters = expertProviderApiParameter }, 
@@ -201,7 +207,8 @@ public static class LLMProvidersExtensions
         LLMProviders.DEEP_SEEK => "https://platform.deepseek.com/sign_up",
         LLMProviders.ALIBABA_CLOUD => "https://account.alibabacloud.com/register/intl_register.htm",
         LLMProviders.PERPLEXITY => "https://www.perplexity.ai/account/api",
-     
+        LLMProviders.OPEN_ROUTER => "https://openrouter.ai/keys",
+
         LLMProviders.GROQ => "https://console.groq.com/",
         LLMProviders.FIREWORKS => "https://fireworks.ai/login",
         LLMProviders.HUGGINGFACE => "https://huggingface.co/login",
@@ -224,8 +231,9 @@ public static class LLMProvidersExtensions
         LLMProviders.DEEP_SEEK => "https://platform.deepseek.com/usage",
         LLMProviders.ALIBABA_CLOUD => "https://usercenter2-intl.aliyun.com/billing",
         LLMProviders.PERPLEXITY => "https://www.perplexity.ai/account/api/",
+        LLMProviders.OPEN_ROUTER => "https://openrouter.ai/activity",
         LLMProviders.HUGGINGFACE => "https://huggingface.co/settings/billing",
-        
+
         _ => string.Empty,
     };
 
@@ -241,8 +249,9 @@ public static class LLMProvidersExtensions
         LLMProviders.DEEP_SEEK => true,
         LLMProviders.ALIBABA_CLOUD => true,
         LLMProviders.PERPLEXITY => true,
+        LLMProviders.OPEN_ROUTER => true,
         LLMProviders.HUGGINGFACE => true,
-        
+
         _ => false,
     };
 
@@ -288,7 +297,8 @@ public static class LLMProvidersExtensions
         LLMProviders.DEEP_SEEK => true,
         LLMProviders.ALIBABA_CLOUD => true,
         LLMProviders.PERPLEXITY => true,
-        
+        LLMProviders.OPEN_ROUTER => true,
+
         LLMProviders.GROQ => true,
         LLMProviders.FIREWORKS => true,
         LLMProviders.HELMHOLTZ => true,
@@ -310,7 +320,8 @@ public static class LLMProvidersExtensions
         LLMProviders.DEEP_SEEK => true,
         LLMProviders.ALIBABA_CLOUD => true,
         LLMProviders.PERPLEXITY => true,
-        
+        LLMProviders.OPEN_ROUTER => true,
+
         LLMProviders.GROQ => true,
         LLMProviders.FIREWORKS => true,
         LLMProviders.HELMHOLTZ => true,

app/MindWork AI Studio/Provider/OpenRouter/OpenRouterModel.cs

@@ -0,0 +1,8 @@
+namespace AIStudio.Provider.OpenRouter;
+
+/// <summary>
+/// A data model for an OpenRouter model from the API.
+/// </summary>
+/// <param name="Id">The model's ID.</param>
+/// <param name="Name">The model's human-readable display name.</param>
+public readonly record struct OpenRouterModel(string Id, string? Name);

app/MindWork AI Studio/Provider/OpenRouter/OpenRouterModelsResponse.cs

@@ -0,0 +1,7 @@
+namespace AIStudio.Provider.OpenRouter;
+
+/// <summary>
+/// A data model for the response from the OpenRouter models endpoint.
+/// </summary>
+/// <param name="Data">The list of models.</param>
+public readonly record struct OpenRouterModelsResponse(IList<OpenRouterModel> Data);

app/MindWork AI Studio/Provider/OpenRouter/ProviderOpenRouter.cs

@@ -0,0 +1,202 @@
+using System.Net.Http.Headers;
+using System.Runtime.CompilerServices;
+using System.Text;
+using System.Text.Json;
+
+using AIStudio.Chat;
+using AIStudio.Provider.OpenAI;
+using AIStudio.Settings;
+
+namespace AIStudio.Provider.OpenRouter;
+
+public sealed class ProviderOpenRouter() : BaseProvider("https://openrouter.ai/api/v1/", LOGGER)
+{
+    private const string PROJECT_WEBSITE = "https://github.com/MindWorkAI/AI-Studio";
+    private const string PROJECT_NAME = "MindWork AI Studio";
+
+    private static readonly ILogger<ProviderOpenRouter> LOGGER = Program.LOGGER_FACTORY.CreateLogger<ProviderOpenRouter>();
+
+    #region Implementation of IProvider
+
+    /// <inheritdoc />
+    public override string Id => LLMProviders.OPEN_ROUTER.ToName();
+
+    /// <inheritdoc />
+    public override string InstanceName { get; set; } = "OpenRouter";
+
+    /// <inheritdoc />
+    public override async IAsyncEnumerable<ContentStreamChunk> StreamChatCompletion(Model chatModel, ChatThread chatThread, SettingsManager settingsManager, [EnumeratorCancellation] CancellationToken token = default)
+    {
+        // Get the API key:
+        var requestedSecret = await RUST_SERVICE.GetAPIKey(this);
+        if(!requestedSecret.Success)
+            yield break;
+
+        // Prepare the system prompt:
+        var systemPrompt = new Message
+        {
+            Role = "system",
+            Content = chatThread.PrepareSystemPrompt(settingsManager, chatThread),
+        };
+
+        // Parse the API parameters:
+        var apiParameters = this.ParseAdditionalApiParameters();
+        
+        // Build the list of messages:
+        var messages = await chatThread.Blocks.BuildMessages(async n => new Message
+        {
+            Role = n.Role switch
+            {
+                ChatRole.USER => "user",
+                ChatRole.AI => "assistant",
+                ChatRole.AGENT => "assistant",
+                ChatRole.SYSTEM => "system",
+
+                _ => "user",
+            },
+
+            Content = n.Content switch
+            {
+                ContentText text => await text.PrepareContentForAI(),
+                _ => string.Empty,
+            }
+        });
+
+        // Prepare the OpenRouter HTTP chat request:
+        var openRouterChatRequest = JsonSerializer.Serialize(new ChatCompletionAPIRequest
+        {
+            Model = chatModel.Id,
+
+            // Build the messages:
+            // - First of all the system prompt
+            // - Then none-empty user and AI messages
+            Messages = [systemPrompt, ..messages],
+
+            // Right now, we only support streaming completions:
+            Stream = true,
+            AdditionalApiParameters = apiParameters
+        }, JSON_SERIALIZER_OPTIONS);
+
+        async Task<HttpRequestMessage> RequestBuilder()
+        {
+            // Build the HTTP post request:
+            var request = new HttpRequestMessage(HttpMethod.Post, "chat/completions");
+
+            // Set the authorization header:
+            request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", await requestedSecret.Secret.Decrypt(ENCRYPTION));
+            
+            // Set custom headers for project identification:
+            request.Headers.Add("HTTP-Referer", PROJECT_WEBSITE);
+            request.Headers.Add("X-Title", PROJECT_NAME);
+
+            // Set the content:
+            request.Content = new StringContent(openRouterChatRequest, Encoding.UTF8, "application/json");
+            return request;
+        }
+
+        await foreach (var content in this.StreamChatCompletionInternal<ChatCompletionDeltaStreamLine, NoChatCompletionAnnotationStreamLine>("OpenRouter", RequestBuilder, token))
+            yield return content;
+    }
+
+    #pragma warning disable CS1998 // Async method lacks 'await' operators and will run synchronously
+    /// <inheritdoc />
+    public override async IAsyncEnumerable<ImageURL> StreamImageCompletion(Model imageModel, string promptPositive, string promptNegative = FilterOperator.String.Empty, ImageURL referenceImageURL = default, [EnumeratorCancellation] CancellationToken token = default)
+    {
+        yield break;
+    }
+    #pragma warning restore CS1998 // Async method lacks 'await' operators and will run synchronously
+
+    /// <inheritdoc />
+    public override Task<IEnumerable<Model>> GetTextModels(string? apiKeyProvisional = null, CancellationToken token = default)
+    {
+        return this.LoadModels(token, apiKeyProvisional);
+    }
+
+    /// <inheritdoc />
+    public override Task<IEnumerable<Model>> GetImageModels(string? apiKeyProvisional = null, CancellationToken token = default)
+    {
+        return Task.FromResult(Enumerable.Empty<Model>());
+    }
+
+    /// <inheritdoc />
+    public override Task<IEnumerable<Model>> GetEmbeddingModels(string? apiKeyProvisional = null, CancellationToken token = default)
+    {
+        return this.LoadEmbeddingModels(token, apiKeyProvisional);
+    }
+
+    #endregion
+
+    private async Task<IEnumerable<Model>> LoadModels(CancellationToken token, string? apiKeyProvisional = null)
+    {
+        var secretKey = apiKeyProvisional switch
+        {
+            not null => apiKeyProvisional,
+            _ => await RUST_SERVICE.GetAPIKey(this) switch
+            {
+                { Success: true } result => await result.Secret.Decrypt(ENCRYPTION),
+                _ => null,
+            }
+        };
+
+        if (secretKey is null)
+            return [];
+
+        using var request = new HttpRequestMessage(HttpMethod.Get, "models");
+        request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", secretKey);
+        
+        // Set custom headers for project identification:
+        request.Headers.Add("HTTP-Referer", PROJECT_WEBSITE);
+        request.Headers.Add("X-Title", PROJECT_NAME);
+
+        using var response = await this.httpClient.SendAsync(request, token);
+        if(!response.IsSuccessStatusCode)
+            return [];
+
+        var modelResponse = await response.Content.ReadFromJsonAsync<OpenRouterModelsResponse>(token);
+
+        // Filter out non-text models (image, audio, embedding models) and convert to Model
+        return modelResponse.Data
+            .Where(n =>
+                !n.Id.Contains("whisper", StringComparison.OrdinalIgnoreCase) &&
+                !n.Id.Contains("dall-e", StringComparison.OrdinalIgnoreCase) &&
+                !n.Id.Contains("tts", StringComparison.OrdinalIgnoreCase) &&
+                !n.Id.Contains("embedding", StringComparison.OrdinalIgnoreCase) &&
+                !n.Id.Contains("moderation", StringComparison.OrdinalIgnoreCase) &&
+                !n.Id.Contains("stable-diffusion", StringComparison.OrdinalIgnoreCase) &&
+                !n.Id.Contains("flux", StringComparison.OrdinalIgnoreCase) &&
+                !n.Id.Contains("midjourney", StringComparison.OrdinalIgnoreCase))
+            .Select(n => new Model(n.Id, n.Name));
+    }
+
+    private async Task<IEnumerable<Model>> LoadEmbeddingModels(CancellationToken token, string? apiKeyProvisional = null)
+    {
+        var secretKey = apiKeyProvisional switch
+        {
+            not null => apiKeyProvisional,
+            _ => await RUST_SERVICE.GetAPIKey(this) switch
+            {
+                { Success: true } result => await result.Secret.Decrypt(ENCRYPTION),
+                _ => null,
+            }
+        };
+
+        if (secretKey is null)
+            return [];
+
+        using var request = new HttpRequestMessage(HttpMethod.Get, "embeddings/models");
+        request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", secretKey);
+        
+        // Set custom headers for project identification:
+        request.Headers.Add("HTTP-Referer", PROJECT_WEBSITE);
+        request.Headers.Add("X-Title", PROJECT_NAME);
+
+        using var response = await this.httpClient.SendAsync(request, token);
+        if(!response.IsSuccessStatusCode)
+            return [];
+
+        var modelResponse = await response.Content.ReadFromJsonAsync<OpenRouterModelsResponse>(token);
+
+        // Convert all embedding models to Model
+        return modelResponse.Data.Select(n => new Model(n.Id, n.Name));
+    }
+}