Enable "Foundry Local" to run in local container environment

README.md

@@ -77,7 +77,7 @@ Open Chat Playground (OCP) is a web UI that is able to connect virtually any LLM
 - [Use Azure AI Foundry](./docs/azure-ai-foundry.md#run-in-local-container)
 - [Use GitHub Models](./docs/github-models.md#run-in-local-container)
 - [Use Docker Model Runner](./docs/docker-model-runner.md#run-in-local-container)
-- ~~Use Foundry Local~~ 👉 NOT SUPPORTED
+- [Use Foundry Local](./docs/foundry-local.md#run-in-local-container)
 - [Use Hugging Face](./docs/hugging-face.md#run-in-local-container)
 - [Use Ollama](./docs/ollama.md#run-on-local-container)
 - [Use LG](./docs/lg.md#run-in-local-container)

docs/foundry-local.md

@@ -74,4 +74,124 @@ This page describes how to run OpenChat Playground (OCP) with Foundry Local mode
         --alias qwen2.5-7b
     ```
 
-1. Open your web browser, navigate to `http://localhost:5280`, and enter prompts.
+1. Open your web browser, navigate to `http://localhost:5280`, and enter prompts.
+
+## Run in local container
+
+1. Make sure the Foundry Local server is up and running.
+
+    ```bash
+    foundry service start
+    ```
+
+1. Download the Foundry Local model. The default model OCP uses is `Phi-4-mini-instruct-generic-cpu:4`.
+
+    ```bash
+    foundry model download Phi-4-mini-instruct-generic-cpu:4
+    ```
+
+   Alternatively, if you want to run with a different model, say `qwen2.5-7b-instruct-generic-cpu:3`, other than the default one, download it first by running the following command.
+
+    ```bash
+    foundry model download qwen2.5-7b-instruct-generic-cpu:3
+    ```
+
+   Make sure to follow the model MUST be selected from the CLI output of `foundry model list`.
+
+1. Load the Foundry Local model. The default model OCP uses is `Phi-4-mini-instruct-generic-cpu:4`.
+
+    ```bash
+    foundry model load Phi-4-mini-instruct-generic-cpu:4
+    ```
+
+   Alternatively, if you want to run with a different model, say `qwen2.5-7b-instruct-generic-cpu:3`, other than the default one, download it first by running the following command.
+
+    ```bash
+    foundry model load qwen2.5-7b-instruct-generic-cpu:3
+    ```
+
+1. Make sure you are at the repository root.
+
+    ```bash
+    cd $REPOSITORY_ROOT
+    ```
+
+1. Build a container.
+
+    ```bash
+    docker build -f Dockerfile -t openchat-playground:latest .
+    ```
+
+ 1. Run the app. The default model OCP uses is `Phi-4-mini-instruct-generic-cpu:4`.
+
+    ```bash
+    # bash/zsh - from locally built container
+    docker run -i --rm -p 8080:8080 openchat-playground:latest \
+        --connector-type FoundryLocal \
+        --endpoint http://host.docker.internal:55438/v1 \
+        --disable-foundrylocal-manager
+    ```
+
+    ```powershell
+    # PowerShell - from locally built container
+    docker run -i --rm -p 8080:8080 openchat-playground:latest `
+        --connector-type FoundryLocal `
+        --endpoint http://host.docker.internal:55438/v1 `
+        --disable-foundrylocal-manager 
+    ```
+
+    ```bash
+    # bash/zsh - from GitHub Container Registry
+    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest \
+        --connector-type FoundryLocal \
+        --endpoint http://host.docker.internal:55438/v1 \
+        --disable-foundrylocal-manager
+    ```
+
+    ```powershell
+    # PowerShell - from GitHub Container Registry
+    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest `
+        --connector-type FoundryLocal `
+        --endpoint http://host.docker.internal:55438/v1 `
+        --disable-foundrylocal-manager 
+    ```
+
+   Alternatively, if you want to run with a different model, say `qwen2.5-7b-instruct-generic-cpu:3`, make sure you've already downloaded the model by running the `foundry model load qwen2.5-7b-instruct-generic-cpu:3` command.
+
+    ```bash
+    # bash/zsh - from locally built container
+    docker run -i --rm -p 8080:8080 openchat-playground:latest \
+        --connector-type FoundryLocal \
+        --endpoint http://host.docker.internal:55438/v1 \
+        --model-id qwen2.5-7b-instruct-generic-cpu:3 \
+        --disable-foundrylocal-manager
+    ```
+
+    ```powershell
+    # PowerShell - from locally built container
+    docker run -i --rm -p 8080:8080 openchat-playground:latest `
+        --connector-type FoundryLocal `
+        --endpoint http://host.docker.internal:55438/v1 `
+        --model-id qwen2.5-7b-instruct-generic-cpu:3 `
+        --disable-foundrylocal-manager
+    ```
+
+    ```bash
+    # bash/zsh - from GitHub Container Registry
+    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest \
+        --connector-type FoundryLocal \
+        --endpoint http://host.docker.internal:55438/v1 \
+        --model-id qwen2.5-7b-instruct-generic-cpu:3 \
+        --disable-foundrylocal-manager
+    ```
+
+    ```powershell
+    # PowerShell - from GitHub Container Registry
+    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest `
+        --connector-type FoundryLocal `
+        --endpoint http://host.docker.internal:55438/v1 `
+        --model-id qwen2.5-7b-instruct-generic-cpu:3 `
+        --disable-foundrylocal-manager
+    ```
+
+1. Open your web browser, navigate to `http://localhost:8080`, and enter prompts.

src/OpenChat.PlaygroundApp/Abstractions/ArgumentOptions.cs

@@ -33,6 +33,9 @@ private static readonly (ConnectorType ConnectorType, string Argument, bool IsSw
         (ConnectorType.DockerModelRunner, ArgumentOptionConstants.DockerModelRunner.Model, false),
         // Foundry Local
         (ConnectorType.FoundryLocal, ArgumentOptionConstants.FoundryLocal.Alias, false),
+        (ConnectorType.FoundryLocal, ArgumentOptionConstants.FoundryLocal.Endpoint, false),
+        (ConnectorType.FoundryLocal, ArgumentOptionConstants.FoundryLocal.ModelId, false),
+        (ConnectorType.FoundryLocal, ArgumentOptionConstants.FoundryLocal.DisableFoundryLocalManager, false),
         // Hugging Face
         (ConnectorType.HuggingFace, ArgumentOptionConstants.HuggingFace.BaseUrl, false),
         (ConnectorType.HuggingFace, ArgumentOptionConstants.HuggingFace.Model, false),
@@ -213,8 +216,13 @@ public static AppSettings Parse(IConfiguration config, string[] args)
             case FoundryLocalArgumentOptions foundryLocal:
                 settings.FoundryLocal ??= new FoundryLocalSettings();
                 settings.FoundryLocal.Alias = foundryLocal.Alias ?? settings.FoundryLocal.Alias;
+                settings.FoundryLocal.Endpoint = foundryLocal.Endpoint ?? settings.FoundryLocal.Endpoint;
+                settings.FoundryLocal.ModelId = foundryLocal.ModelId ?? settings.FoundryLocal.ModelId;
+                settings.FoundryLocal.DisableFoundryLocalManager = foundryLocal.DisableFoundryLocalManager;
 
-                settings.Model = foundryLocal.Alias ?? settings.FoundryLocal.Alias;
+                settings.Model = foundryLocal.DisableFoundryLocalManager
+                    ? foundryLocal.ModelId ?? settings.FoundryLocal.ModelId
+                    : foundryLocal.Alias ?? settings.FoundryLocal.Alias;
                 break;
 
             case HuggingFaceArgumentOptions huggingFace:
@@ -419,12 +427,15 @@ private static void DisplayHelpForDockerModelRunner()
 
     private static void DisplayHelpForFoundryLocal()
     {
+        //  --model              The OpenAI model name. Default to 'gpt-4.1-mini'
         var foregroundColor = Console.ForegroundColor;
         Console.ForegroundColor = ConsoleColor.DarkYellow;
         Console.WriteLine("  ** Foundry Local: **");
         Console.ForegroundColor = foregroundColor;
 
-        Console.WriteLine("  TBD");
+        Console.WriteLine($"  {ArgumentOptionConstants.FoundryLocal.Alias}              The alias. Default to 'phi-4-mini'");
+        Console.WriteLine($"  {ArgumentOptionConstants.FoundryLocal.Endpoint}           The endpoint URL. Default to 'http://127.0.0.1:55438/v1'");
+        Console.WriteLine($"  {ArgumentOptionConstants.FoundryLocal.ModelId}           The model ID. Default to 'Phi-4-mini-instruct-generic-cpu:4'");
         Console.WriteLine();
     }
 

src/OpenChat.PlaygroundApp/Configurations/FoundryLocalSettings.cs

@@ -20,4 +20,20 @@ public class FoundryLocalSettings : LanguageModelSettings
     /// Gets or sets the alias of FoundryLocal.
     /// </summary>
     public string? Alias { get; set; }
+
+    /// <summary>
+    /// Gets or sets the Endpoint of FoundryLocal.
+    /// </summary>
+    public string? Endpoint { get; set; }
+
+    /// <summary>
+    /// Gets or sets the model ID of FoundryLocal.
+    /// </summary>
+    public string? ModelId { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to disable the automatic FoundryLocal manager and use a manually configured endpoint.
+    /// </summary>
+    public bool DisableFoundryLocalManager { get; set; }
+
 }

src/OpenChat.PlaygroundApp/Connectors/FoundryLocalConnector.cs

@@ -18,6 +18,8 @@ public class FoundryLocalConnector(AppSettings settings) : LanguageModelConnecto
 {
     private readonly AppSettings _appSettings = settings ?? throw new ArgumentNullException(nameof(settings));
 
+    private const string ApiKey = "OPENAI_API_KEY";
+
     /// <inheritdoc/>
     public override bool EnsureLanguageModelSettingsValid()
     {
@@ -26,9 +28,24 @@ public override bool EnsureLanguageModelSettingsValid()
             throw new InvalidOperationException("Missing configuration: FoundryLocal.");
         }
 
-        if (string.IsNullOrWhiteSpace(settings.Alias!.Trim()))
+        if (settings.DisableFoundryLocalManager == true)
         {
-            throw new InvalidOperationException("Missing configuration: FoundryLocal:Alias.");
+            if (string.IsNullOrWhiteSpace(settings.Endpoint!.Trim()) == true)
+            {
+                throw new InvalidOperationException("Missing configuration: FoundryLocal:Endpoint is required when DisableFoundryLocalManager is enabled.");
+            }
+
+            if (string.IsNullOrWhiteSpace(settings.ModelId!.Trim()) == true)
+            {
+                throw new InvalidOperationException("Missing configuration: FoundryLocal:ModelId is required when DisableFoundryLocalManager is enabled.");
+            }
+        }
+        else
+        {
+            if (string.IsNullOrWhiteSpace(settings.Alias!.Trim()))
+            {
+                throw new InvalidOperationException("Missing configuration: FoundryLocal:Alias is required when DisableFoundryLocalManager is disabled.");
+            }
         }
 
         return true;
@@ -38,22 +55,41 @@ public override bool EnsureLanguageModelSettingsValid()
     public override async Task<IChatClient> GetChatClientAsync()
     {
         var settings = this.Settings as FoundryLocalSettings;
-        var alias = settings!.Alias!.Trim() ?? throw new InvalidOperationException("Missing configuration: FoundryLocal:Alias.");
 
-        var manager = await FoundryLocalManager.StartModelAsync(aliasOrModelId: alias).ConfigureAwait(false);
-        var model = await manager.GetModelInfoAsync(aliasOrModelId: alias).ConfigureAwait(false);
+        Uri endpoint;
+        string modelId;
+
+        if (settings!.DisableFoundryLocalManager == true)
+        {
+            var settingsEndpoint = settings.Endpoint!.Trim() ?? throw new InvalidOperationException("Missing configuration: FoundryLocal:Endpoint.");
+            if (Uri.IsWellFormedUriString(settingsEndpoint, UriKind.Absolute) == false)
+            {
+                throw new UriFormatException($"Invalid URI: The Foundry Local endpoint '{settingsEndpoint}' is not a valid URI.");
+            }
+            endpoint = new Uri(settingsEndpoint);
+            modelId = settings.ModelId!.Trim() ?? throw new InvalidOperationException("Missing configuration: FoundryLocal:ModelId.");
+        }
+        else
+        {
+            var alias = settings!.Alias!.Trim() ?? throw new InvalidOperationException("Missing configuration: FoundryLocal:Alias.");
+            var manager = await FoundryLocalManager.StartModelAsync(aliasOrModelId: alias).ConfigureAwait(false);
+            var model = await manager.GetModelInfoAsync(aliasOrModelId: alias).ConfigureAwait(false);
+
+            endpoint = manager.Endpoint;
+            modelId = model?.ModelId ?? alias;
+        }
 
-        var credential = new ApiKeyCredential(manager.ApiKey);
+        var credential = new ApiKeyCredential(ApiKey);
         var options = new OpenAIClientOptions()
         {
-            Endpoint = manager.Endpoint,
+            Endpoint = endpoint,
         };
 
         var client = new OpenAIClient(credential, options);
-        var chatClient = client.GetChatClient(model?.ModelId)
+        var chatClient = client.GetChatClient(modelId)
                                .AsIChatClient();
 
-        Console.WriteLine($"The {this._appSettings.ConnectorType} connector created with model: {alias}");
+        Console.WriteLine($"The {this._appSettings.ConnectorType} connector created with model: {modelId}");
 
         return chatClient;
     }

src/OpenChat.PlaygroundApp/Constants/ArgumentOptionConstants.cs

@@ -134,6 +134,21 @@ public static class FoundryLocal
         /// Defines the constant for '--alias'.
         /// </summary>
         public const string Alias = "--alias";
+
+        /// <summary>
+        /// Defines the constant for '--endpoint'.
+        /// </summary>
+        public const string Endpoint = "--endpoint";
+
+        /// <summary>
+        /// Defines the constant for '--model-id'.
+        /// </summary>
+        public const string ModelId = "--model-id";
+
+        /// <summary>
+        /// Defines the constant for '--disable-foundrylocal-manager'.
+        /// </summary>
+        public const string DisableFoundryLocalManager = "--disable-foundrylocal-manager";
     }
 
     /// <summary>

src/OpenChat.PlaygroundApp/Options/FoundryLocalArgumentOptions.cs

@@ -14,6 +14,21 @@ public class FoundryLocalArgumentOptions : ArgumentOptions
     /// </summary>
     public string? Alias { get; set; }
 
+    /// <summary>
+    /// Gets or sets the Endpoint of FoundryLocal.
+    /// </summary>
+    public string? Endpoint { get; set; }
+
+    /// <summary>
+    /// Gets or sets the model ID of FoundryLocal.
+    /// </summary>
+    public string? ModelId { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether to disable the automatic FoundryLocal manager and use a manually configured endpoint.
+    /// </summary>
+    public bool DisableFoundryLocalManager { get; set; }
+
     /// <inheritdoc/>
     protected override void ParseOptions(IConfiguration config, string[] args)
     {
@@ -23,6 +38,9 @@ protected override void ParseOptions(IConfiguration config, string[] args)
         var foundryLocal = settings.FoundryLocal;
 
         this.Alias ??= foundryLocal?.Alias;
+        this.Endpoint ??= foundryLocal?.Endpoint;
+        this.ModelId ??= foundryLocal?.ModelId;
+        this.DisableFoundryLocalManager = foundryLocal?.DisableFoundryLocalManager ?? false;
 
         for (var i = 0; i < args.Length; i++)
         {
@@ -35,6 +53,24 @@ protected override void ParseOptions(IConfiguration config, string[] args)
                     }
                     break;
 
+                case ArgumentOptionConstants.FoundryLocal.Endpoint:
+                    if (i + 1 < args.Length)
+                    {
+                        this.Endpoint = args[++i];
+                    }
+                    break;
+
+                case ArgumentOptionConstants.FoundryLocal.ModelId:
+                    if (i + 1 < args.Length)
+                    {
+                        this.ModelId = args[++i];
+                    }
+                    break;
+
+                case ArgumentOptionConstants.FoundryLocal.DisableFoundryLocalManager:
+                    this.DisableFoundryLocalManager = true;
+                    break;
+
                 default:
                     break;
             }

src/OpenChat.PlaygroundApp/appsettings.json

@@ -41,7 +41,9 @@
   },
 
   "FoundryLocal": {
-    "Alias": "phi-4-mini"
+    "Alias": "phi-4-mini",
+    "Endpoint": "http://127.0.0.1:55438/v1",
+    "ModelId": "Phi-4-mini-instruct-generic-cpu:4" 
   },
 
   "HuggingFace": {