Added Hugging Face inference provider (#397)

Author: peerschuett

app/MindWork AI Studio.sln.DotSettings

@@ -3,14 +3,17 @@
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=EDI/@EntryIndexedValue">EDI</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=ERI/@EntryIndexedValue">ERI</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=GWDG/@EntryIndexedValue">GWDG</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=HF/@EntryIndexedValue">HF</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=LLM/@EntryIndexedValue">LLM</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=LM/@EntryIndexedValue">LM</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=MSG/@EntryIndexedValue">MSG</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=RAG/@EntryIndexedValue">RAG</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UI/@EntryIndexedValue">UI</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=URL/@EntryIndexedValue">URL</s:String>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=agentic/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=groq/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=gwdg/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=huggingface/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=mwais/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=ollama/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=tauri_0027s/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

app/MindWork AI Studio/Components/Settings/SettingsPanelProviders.razor

@@ -29,7 +29,7 @@
         <RowTemplate>
             <MudTd>@context.Num</MudTd>
             <MudTd>@context.InstanceName</MudTd>
-            <MudTd>@context.UsedLLMProvider</MudTd>
+            <MudTd>@context.UsedLLMProvider.ToName()</MudTd>
             <MudTd>
                 @if (context.UsedLLMProvider is not LLMProviders.SELF_HOSTED)
                 {

app/MindWork AI Studio/Components/Settings/SettingsPanelProviders.razor.cs

@@ -65,6 +65,7 @@ private async Task EditLLMProvider(AIStudio.Settings.Provider provider)
             { x => x.IsSelfHosted, provider.IsSelfHosted },
             { x => x.IsEditing, true },
             { x => x.DataHost, provider.Host },
+            { x => x.HfInstanceProviderId, provider.HFInstanceProvider },
         };
 
         var dialogReference = await this.DialogService.ShowAsync<ProviderDialog>("Edit LLM Provider", dialogParameters, DialogOptions.FULLSCREEN);

app/MindWork AI Studio/Dialogs/ProviderDialog.razor

@@ -1,4 +1,5 @@
 @using AIStudio.Provider
+@using AIStudio.Provider.HuggingFace
 @using AIStudio.Provider.SelfHosted
 
 <MudDialog>
@@ -28,38 +29,55 @@
                 InputType="InputType.Password"
                 Validation="@this.providerValidation.ValidatingAPIKey"
             />
-            
-            <MudTextField
-                T="string"
-                @bind-Text="@this.DataHostname"
-                Label="Hostname"
-                Disabled="@(!this.DataLLMProvider.IsHostnameNeeded())"
-                Class="mb-3"
-                Adornment="Adornment.Start"
-                AdornmentIcon="@Icons.Material.Filled.Dns"
-                AdornmentColor="Color.Info"
-                Validation="@this.providerValidation.ValidatingHostname"
-                UserAttributes="@SPELLCHECK_ATTRIBUTES"
-            />
 
-            <MudSelect Disabled="@(!this.DataLLMProvider.IsHostNeeded())" @bind-Value="@this.DataHost" Label="Host" Class="mb-3" OpenIcon="@Icons.Material.Filled.ExpandMore" AdornmentColor="Color.Info" Adornment="Adornment.Start" Validation="@this.providerValidation.ValidatingHost">
-                @foreach (Host host in Enum.GetValues(typeof(Host)))
-                {
-                    <MudSelectItem Value="@host">@host.Name()</MudSelectItem>
-                }
-            </MudSelect>
+            @if (this.DataLLMProvider.IsHostnameNeeded())
+            {
+                <MudTextField
+                    T="string"
+                    @bind-Text="@this.DataHostname"
+                    Label="Hostname"
+                    Disabled="@(!this.DataLLMProvider.IsHostnameNeeded())"
+                    Class="mb-3"
+                    Adornment="Adornment.Start"
+                    AdornmentIcon="@Icons.Material.Filled.Dns"
+                    AdornmentColor="Color.Info"
+                    Validation="@this.providerValidation.ValidatingHostname"
+                    UserAttributes="@SPELLCHECK_ATTRIBUTES"/>
+            }
+
+            @if (this.DataLLMProvider.IsHostNeeded())
+            {
+                <MudSelect Disabled="@(!this.DataLLMProvider.IsHostNeeded())" @bind-Value="@this.DataHost" Label="Host" Class="mb-3" OpenIcon="@Icons.Material.Filled.ExpandMore" AdornmentColor="Color.Info" Adornment="Adornment.Start" Validation="@this.providerValidation.ValidatingHost">
+                    @foreach (Host host in Enum.GetValues(typeof(Host)))
+                    {
+                        <MudSelectItem Value="@host">@host.Name()</MudSelectItem>
+                    }
+                </MudSelect>
+            }
+
+            @if (this.DataLLMProvider.IsHFInstanceProviderNeeded())
+            {
+                <MudSelect Disabled="@(!this.DataLLMProvider.IsHFInstanceProviderNeeded())" @bind-Value="@this.HfInstanceProviderId" Label="HF Instance Provider" Class="mb-3" OpenIcon="@Icons.Material.Filled.Dns" AdornmentColor="Color.Info" Adornment="Adornment.Start" Validation="@this.providerValidation.ValidatingHFInstanceProvider">
+                    @foreach (HFInstanceProvider instanceProvider in Enum.GetValues(typeof(HFInstanceProvider)))
+                    {
+                        <MudSelectItem Value="@instanceProvider">@instanceProvider.ToName()</MudSelectItem>
+                    }
+                </MudSelect>
+                
+                <MudJustifiedText Class="mb-3"> Please double-check if your model name matches the curl specifications provided by the instance provider. If it doesn't, you might get a <b>Not Found</b> error when trying to use the model. Here's a <MudLink Href="https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct?inference_api=true&inference_provider=novita&language=sh" Target="_blank">curl example</MudLink>.</MudJustifiedText>
+            }
 
             <MudStack Row="@true" AlignItems="AlignItems.Center">
                 @if (this.DataLLMProvider.IsLLMModelProvidedManually())
                 {
-                    <MudButton Variant="Variant.Filled" Size="Size.Small" StartIcon="@Icons.Material.Filled.OpenInBrowser" Href="@this.DataLLMProvider.GetModelsOverviewURL()" Target="_blank">Show available models</MudButton>
+                    <MudButton Variant="Variant.Filled" Size="Size.Small" StartIcon="@Icons.Material.Filled.OpenInBrowser" Href="@this.DataLLMProvider.GetModelsOverviewURL(this.HfInstanceProviderId)" Target="_blank">Show available models</MudButton>
                     <MudTextField
                         T="string"
                         @bind-Text="@this.dataManuallyModel"
                         Label="Model"
                         Class="mb-3"
                         Adornment="Adornment.Start"
-                        AdornmentIcon="@Icons.Material.Filled.Dns"
+                        AdornmentIcon="@Icons.Material.Filled.FaceRetouchingNatural"
                         AdornmentColor="Color.Info"
                         Validation="@this.ValidateManuallyModel"
                         UserAttributes="@SPELLCHECK_ATTRIBUTES"

app/MindWork AI Studio/Dialogs/ProviderDialog.razor.cs

@@ -1,4 +1,5 @@
 using AIStudio.Provider;
+using AIStudio.Provider.HuggingFace;
 using AIStudio.Settings;
 using AIStudio.Tools.Services;
 using AIStudio.Tools.Validation;
@@ -47,6 +48,12 @@ public partial class ProviderDialog : ComponentBase, ISecretId
     [Parameter]
     public Host DataHost { get; set; } = Host.NONE;
 
+    /// <summary>
+    /// The HFInstanceProvider to use, e.g., CEREBRAS.
+    /// </summary>
+    [Parameter]
+    public HFInstanceProvider HfInstanceProviderId { get; set; } = HFInstanceProvider.NONE;
+    
     /// <summary>
     /// Is this provider self-hosted?
     /// </summary>
@@ -122,10 +129,16 @@ private AIStudio.Settings.Provider CreateProviderSettings()
             Id = this.DataId,
             InstanceName = this.DataInstanceName,
             UsedLLMProvider = this.DataLLMProvider,
-            Model = this.DataLLMProvider is LLMProviders.FIREWORKS ? new Model(this.dataManuallyModel, null) : this.DataModel,
+            Model = this.DataLLMProvider switch
+            {
+                LLMProviders.FIREWORKS => new Model(this.dataManuallyModel, null),
+                LLMProviders.HUGGINGFACE => new Model(this.dataManuallyModel, null),
+                _ => this.DataModel
+            },
             IsSelfHosted = this.DataLLMProvider is LLMProviders.SELF_HOSTED,
             Hostname = cleanedHostname.EndsWith('/') ? cleanedHostname[..^1] : cleanedHostname,
             Host = this.DataHost,
+            HFInstanceProvider = this.HfInstanceProviderId,
         };
     }
 
@@ -146,8 +159,8 @@ protected override async Task OnInitializedAsync()
         {
             this.dataEditingPreviousInstanceName = this.DataInstanceName.ToLowerInvariant();
 
-            // When using Fireworks, we must copy the model name:
-            if (this.DataLLMProvider is LLMProviders.FIREWORKS)
+            // When using Fireworks or Hugging Face, we must copy the model name:
+            if (this.DataLLMProvider is LLMProviders.FIREWORKS or LLMProviders.HUGGINGFACE)
                 this.dataManuallyModel = this.DataModel.Id;
 
             //
@@ -230,7 +243,7 @@ private async Task Store()
 
     private string? ValidateManuallyModel(string manuallyModel)
     {
-        if (this.DataLLMProvider is LLMProviders.FIREWORKS && string.IsNullOrWhiteSpace(manuallyModel))
+        if ((this.DataLLMProvider is LLMProviders.FIREWORKS or LLMProviders.HUGGINGFACE) && string.IsNullOrWhiteSpace(manuallyModel))
             return "Please enter a model name.";
 
         return null;

app/MindWork AI Studio/Provider/Confidence.cs

@@ -35,10 +35,10 @@ No provider selected. Please select a provider to get see its confidence level.
             """,
     };
 
-    public static readonly Confidence USA_NOT_TRUSTED = new()
+    public static readonly Confidence USA_HUB = new()
     {
-        Level = ConfidenceLevel.UNTRUSTED,
-        Description = "The provider operates its service from the USA and is subject to **U.S. jurisdiction**. In case of suspicion, authorities in the USA can access your data. The provider's terms of service state that **all your data can be used by the provider at will.**",
+        Level = ConfidenceLevel.UNKNOWN,
+        Description = "The provider operates its service from the USA and is subject to **U.S. jurisdiction**. In case of suspicion, authorities in the USA can access your data. Please inform yourself about the use of your data. We do not know if your data is safe.",
     };
 
     public static readonly Confidence UNKNOWN = new()

app/MindWork AI Studio/Provider/HuggingFace/HFInstanceProvider.cs

@@ -0,0 +1,18 @@
+namespace AIStudio.Provider.HuggingFace;
+
+/// <summary>
+/// Enum for instance providers that Hugging Face supports.
+/// </summary>
+public enum HFInstanceProvider
+{
+    NONE,
+    
+    CEREBRAS,
+    NEBIUS_AI_STUDIO,
+    SAMBANOVA,
+    NOVITA,
+    HYPERBOLIC,
+    TOGETHER_AI,
+    FIREWORKS,
+    HF_INFERENCE_API,
+}

app/MindWork AI Studio/Provider/HuggingFace/HFInstanceProviderExtensions.cs

@@ -0,0 +1,43 @@
+namespace AIStudio.Provider.HuggingFace;
+
+public static class HFInstanceProviderExtensions
+{
+    public static string Endpoints(this HFInstanceProvider provider, Model model) => provider switch
+    {
+        HFInstanceProvider.CEREBRAS => "cerebras/v1/",
+        HFInstanceProvider.NEBIUS_AI_STUDIO => "nebius/v1/",
+        HFInstanceProvider.SAMBANOVA => "sambanova/v1/",
+        HFInstanceProvider.NOVITA => "novita/v3/openai/",
+        HFInstanceProvider.HYPERBOLIC => "hyperbolic/v1/",
+        HFInstanceProvider.TOGETHER_AI => "together/v1/",
+        HFInstanceProvider.FIREWORKS => "fireworks-ai/inference/v1/",
+        HFInstanceProvider.HF_INFERENCE_API => $"hf-inference/models/{model.ToString()}/v1/",
+        _ => string.Empty,
+    };
+    
+    public static string EndpointsId(this HFInstanceProvider provider) => provider switch
+    {
+        HFInstanceProvider.CEREBRAS => "cerebras",
+        HFInstanceProvider.NEBIUS_AI_STUDIO => "nebius",
+        HFInstanceProvider.SAMBANOVA => "sambanova",
+        HFInstanceProvider.NOVITA => "novita",
+        HFInstanceProvider.HYPERBOLIC => "hyperbolic",
+        HFInstanceProvider.TOGETHER_AI => "together",
+        HFInstanceProvider.FIREWORKS => "fireworks",
+        HFInstanceProvider.HF_INFERENCE_API => "hf-inference",
+        _ => string.Empty,
+    };
+    
+    public static string ToName(this HFInstanceProvider provider) => provider switch
+    {
+        HFInstanceProvider.CEREBRAS => "Cerebras",
+        HFInstanceProvider.NEBIUS_AI_STUDIO => "Nebius AI Studio",
+        HFInstanceProvider.SAMBANOVA => "Sambanova",
+        HFInstanceProvider.NOVITA => "Novita",
+        HFInstanceProvider.HYPERBOLIC => "Hyperbolic",
+        HFInstanceProvider.TOGETHER_AI => "Together AI",
+        HFInstanceProvider.FIREWORKS => "Fireworks AI",
+        HFInstanceProvider.HF_INFERENCE_API => "Hugging Face Inference API",
+        _ => string.Empty,
+    };
+}

app/MindWork AI Studio/Provider/HuggingFace/ProviderHuggingFace.cs

@@ -0,0 +1,115 @@
+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.HuggingFace;
+
+public sealed class ProviderHuggingFace : BaseProvider
+{
+    public ProviderHuggingFace(ILogger logger, HFInstanceProvider hfProvider, Model model) : base($"https://router.huggingface.co/{hfProvider.Endpoints(model)}", logger)
+    {
+        logger.LogInformation($"We use the instance provider '{hfProvider}'. Thus we use the base URL 'https://router.huggingface.co/{hfProvider.Endpoints(model)}'.");
+    }
+
+    #region Implementation of IProvider
+
+    /// <inheritdoc />
+    public override string Id => LLMProviders.HUGGINGFACE.ToName();
+
+    /// <inheritdoc />
+    public override string InstanceName { get; set; } = "HuggingFace";
+
+    /// <inheritdoc />
+    public override async IAsyncEnumerable<string> 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, this.logger),
+        };
+        
+        // Prepare the HuggingFace HTTP chat request:
+        var huggingfaceChatRequest = JsonSerializer.Serialize(new ChatRequest
+        {
+            Model = chatModel.Id,
+            
+            // Build the messages:
+            // - First of all the system prompt
+            // - Then none-empty user and AI messages
+            Messages = [systemPrompt, ..chatThread.Blocks.Where(n => n.ContentType is ContentType.TEXT && !string.IsNullOrWhiteSpace((n.Content as ContentText)?.Text)).Select(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 => text.Text,
+                    _ => string.Empty,
+                }
+            }).ToList()],
+            Stream = true,
+        }, 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 the content:
+            request.Content = new StringContent(huggingfaceChatRequest, Encoding.UTF8, "application/json");
+            return request;
+        }
+        
+        await foreach (var content in this.StreamChatCompletionInternal<ResponseStreamLine>("HuggingFace", 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 Task.FromResult(Enumerable.Empty<Model>());
+    }
+
+    /// <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 Task.FromResult(Enumerable.Empty<Model>());
+    }
+
+    #endregion
+}

app/MindWork AI Studio/Provider/LLMProviders.cs

@@ -17,6 +17,7 @@ public enum LLMProviders
 
     FIREWORKS = 5,
     GROQ = 6,
+    HUGGINGFACE = 13,
 
     SELF_HOSTED = 4,