Update docs & test methods

Author: justinyoo

docs/README.md

@@ -6,7 +6,7 @@
 - [Docker Model Runner](./docker-model-runner.md)
 - [Foundry Local](./foundry-local.md)
 - [Hugging Face](./hugging-face.md)
-- [Ollama](ollama.md)
+- [Ollama](./ollama.md)
 - [LG](./lg.md)
 - [OpenAI](./openai.md)
 - [Upstage](./upstage.md)

docs/ollama.md

@@ -18,31 +18,31 @@ This page describes how to run OpenChat Playground (OCP) with [Ollama](https://o
 
 ## Run on local machine
 
-1. Make sure Ollama is installed and running on your local machine. If not, install Ollama from [ollama.com](https://ollama.com/) and start the service.
+1. Make sure Ollama is installed and running on your local machine. If not, install Ollama from [ollama.com](https://ollama.com/search) and start the service.
 
     ```bash
     ollama serve
     ```
 
-1. Pull the model you want to use. The default model OCP uses is "llama3.2"
+1. Pull the model you want to use. The default model OCP uses is [llama3.2](https://ollama.com/library/llama3.2).
 
     ```bash
     ollama pull llama3.2
     ```
-    
-    Alternatively, if you want to run with a different model, say [qwen](https://ollama.com/library/qwen) other than the default one, download it first by running the following command.
+
+   Alternatively, if you want to run with a different model, say [qwen3](https://ollama.com/library/qwen3) other than the default one, download it first by running the following command.
 
     ```bash
-    ollama pull qwen
+    ollama pull qwen3
     ```
 
-2. Make sure you are at the repository root.
+1. Make sure you are at the repository root.
 
     ```bash
     cd $REPOSITORY_ROOT
     ```
 
-3. Run the app.
+1. Run the app.
 
     ```bash
     # bash/zsh
@@ -56,44 +56,42 @@ This page describes how to run OpenChat Playground (OCP) with [Ollama](https://o
         --connector-type Ollama
     ```
 
-    Alternatively, if you want to run with a different model, say [qwen](https://ollama.com/library/qwen) other than the default one, download it first by running the following command.
+   Alternatively, if you want to run with a different model, say [qwen3](https://ollama.com/library/qwen3), make sure you've already downloaded the model by running the `ollama pull qwen3` command.
 
     ```bash
     # bash/zsh
     dotnet run --project $REPOSITORY_ROOT/src/OpenChat.PlaygroundApp -- \
         --connector-type Ollama \
-        --model qwen
+        --model qwen3
     ```
 
     ```powershell
     # PowerShell
     dotnet run --project $REPOSITORY_ROOT\src\OpenChat.PlaygroundApp -- `
         --connector-type Ollama `
-        --model qwen
+        --model qwen3
     ```
 
-4. 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 on local container
 
-This approach runs OpenChat Playground in a container while connecting to Ollama running on the host machine.
-
-1. Configure Ollama to accept connections from containers.
+1. Make sure the Ollama server is up and running.
 
     ```bash
     ollama serve
     ```
 
-1. Pull the model you want to use, and verify Ollama is accessible
+1. Download the Ollama model. The default model OCP uses is [llama3.2](https://ollama.com/library/llama3.2).
 
     ```bash
     ollama pull llama3.2
-    curl http://localhost:11434/api/version
     ```
-    
-    ```powershell
-    ollama pull llama3.2
-    Invoke-RestMethod -Uri http://localhost:11434/api/version
+
+   Alternatively, if you want to run with a different model, say [qwen3](https://ollama.com/library/qwen3), other than the default one, download it first by running the following command.
+
+    ```bash
+    ollama pull qwen3
     ```
 
 1. Make sure you are at the repository root.
@@ -126,54 +124,54 @@ This approach runs OpenChat Playground in a container while connecting to Ollama
 
     ```bash
     # bash/zsh - from GitHub Container Registry
-    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest\
+    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest \
         --connector-type Ollama \
         --base-url http://host.docker.internal:11434
     ```
-    
+
     ```powershell
     # PowerShell - from GitHub Container Registry
     docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest `
         --connector-type Ollama `
         --base-url http://host.docker.internal:11434
     ```
 
-    Alternatively, if you want to run with a different model, say [qwen](https://ollama.com/library/qwen), make sure you've already downloaded the model by running the `ollama pull qwen` command.
+   Alternatively, if you want to run with a different model, say [qwen3](https://ollama.com/library/qwen), make sure you've already downloaded the model by running the `ollama pull qwen3` command.
 
     ```bash
-    ollama pull qwen
+    ollama pull qwen3
     ```
 
     ```bash
     # bash/zsh - from locally built container
     docker run -i --rm -p 8080:8080 openchat-playground:latest \
         --connector-type Ollama \
         --base-url http://host.docker.internal:11434 \
-        --model qwen
+        --model qwen3
     ```
 
     ```powershell
     # PowerShell - from locally built container
     docker run -i --rm -p 8080:8080 openchat-playground:latest `
         --connector-type Ollama `
         --base-url http://host.docker.internal:11434 `
-        --model qwen
+        --model qwen3
     ```
 
     ```bash
     # bash/zsh - from GitHub Container Registry
-    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest\
+    docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest \
         --connector-type Ollama \
         --base-url http://host.docker.internal:11434 \
-        --model qwen
+        --model qwen3
     ```
-    
+
     ```powershell
     # PowerShell - from GitHub Container Registry
     docker run -i --rm -p 8080:8080 ghcr.io/aliencube/open-chat-playground/openchat-playground:latest `
         --connector-type Ollama `
         --base-url http://host.docker.internal:11434 `
-        --model qwen
+        --model qwen3
     ```
 
    > **NOTE**: Use `host.docker.internal:11434` to connect to Ollama running on the host machine from inside the container.
@@ -216,21 +214,21 @@ This approach runs OpenChat Playground in a container while connecting to Ollama
     azd env set CONNECTOR_TYPE "Ollama"
     ```
 
-   The default model OCP uses is [llama3.2](https://ollama.com/library/llama3.2). If you want to run with a different model, say [qwen](https://ollama.com/library/qwen) other than the default one, add it to azd environment variables.
+   The default model OCP uses is [llama3.2](https://ollama.com/library/llama3.2). If you want to run with a different model, say [qwen3](https://ollama.com/library/qwen3) other than the default one, add it to azd environment variables.
 
     ```bash
-    azd env set OLLAMA_MODEL "qwen"
+    azd env set OLLAMA_MODEL "qwen3"
     ```
 
-2. As a default, the app uses a Serverless GPU with NVIDIA T4 (`NC8as-T4`). If you want to use NVIDIA A100, set the GPU profile.
+1. As a default, the app uses a Serverless GPU with NVIDIA T4 (`NC8as-T4`). If you want to use NVIDIA A100, set the GPU profile.
 
     ```bash
     azd env set GPU_PROFILE_NAME "NC24-A100"
     ```
 
    If you want to know more about Serverless GPU, visit [Using serverless GPUs in Azure Container Apps](https://learn.microsoft.com/azure/container-apps/gpu-serverless-overview#use-serverless-gpus).
 
-3. Run the following commands in order to provision and deploy the app.
+1. Run the following commands in order to provision and deploy the app.
 
     ```bash
     azd up
@@ -241,9 +239,9 @@ This approach runs OpenChat Playground in a container while connecting to Ollama
 
    Once deployed, you will be able to see the deployed OCP app URL.
 
-4. Open your web browser, navigate to the OCP app URL, and enter prompts.
+1. Open your web browser, navigate to the OCP app URL, and enter prompts.
 
-5. Clean up all the resources.
+1. Clean up all the resources.
 
     ```bash
     azd down --force --purge

src/OpenChat.PlaygroundApp/Connectors/HuggingFaceConnector.cs

@@ -53,6 +53,10 @@ public override async Task<IChatClient> GetChatClientAsync()
         var settings = this.Settings as HuggingFaceSettings;
 
         var baseUrl = settings!.BaseUrl!.Trim() ?? throw new InvalidOperationException("Missing configuration: HuggingFace:BaseUrl.");
+        if (Uri.IsWellFormedUriString(baseUrl, UriKind.Absolute) == false)
+        {
+            throw new UriFormatException($"Invalid URI: The Hugging Face base URL '{baseUrl}' is not a valid URI.");
+        }
         var model = settings!.Model!.Trim() ?? throw new InvalidOperationException("Missing configuration: HuggingFace:Model.");
 
         var config = new OllamaApiClient.Configuration

src/OpenChat.PlaygroundApp/Connectors/LGConnector.cs

@@ -47,6 +47,10 @@ public override async Task<IChatClient> GetChatClientAsync()
         var settings = this.Settings as LGSettings;
 
         var baseUrl = settings!.BaseUrl!.Trim() ?? throw new InvalidOperationException("Missing configuration: LG:BaseUrl.");
+        if (Uri.IsWellFormedUriString(baseUrl, UriKind.Absolute) == false)
+        {
+            throw new UriFormatException($"Invalid URI: The LG base URL '{baseUrl}' is not a valid URI.");
+        }
         var model = settings!.Model!.Trim() ?? throw new InvalidOperationException("Missing configuration: LG:Model.");
 
         var config = new OllamaApiClient.Configuration

src/OpenChat.PlaygroundApp/Connectors/OllamaConnector.cs

@@ -5,8 +5,6 @@
 using OpenChat.PlaygroundApp.Abstractions;
 using OpenChat.PlaygroundApp.Configurations;
 
-using System.Linq;
-
 namespace OpenChat.PlaygroundApp.Connectors;
 
 /// <summary>
@@ -15,11 +13,11 @@ namespace OpenChat.PlaygroundApp.Connectors;
 public class OllamaConnector(AppSettings settings) : LanguageModelConnector(settings.Ollama)
 {
     private readonly AppSettings _appSettings = settings ?? throw new ArgumentNullException(nameof(settings));
+
     /// <inheritdoc/>
     public override bool EnsureLanguageModelSettingsValid()
     {
-        var settings = this.Settings as OllamaSettings;
-        if (settings is null)
+        if (this.Settings is not OllamaSettings settings)
         {
             throw new InvalidOperationException("Missing configuration: Ollama.");
         }
@@ -41,8 +39,13 @@ public override bool EnsureLanguageModelSettingsValid()
     public override async Task<IChatClient> GetChatClientAsync()
     {
         var settings = this.Settings as OllamaSettings;
-        var baseUrl = settings!.BaseUrl!;
-        var model = settings!.Model!;
+
+        var baseUrl = settings!.BaseUrl!.Trim() ?? throw new InvalidOperationException("Missing configuration: Ollama:BaseUrl.");
+        if (Uri.IsWellFormedUriString(baseUrl, UriKind.Absolute) == false)
+        {
+            throw new UriFormatException($"Invalid URI: The Ollama base URL '{baseUrl}' is not a valid URI.");
+        }
+        var model = settings!.Model!.Trim() ?? throw new InvalidOperationException("Missing configuration: Ollama:Model.");
 
         var config = new OllamaApiClient.Configuration
         {
@@ -51,13 +54,15 @@ public override async Task<IChatClient> GetChatClientAsync()
         };
 
         var chatClient = new OllamaApiClient(config);
+
         var pulls = chatClient.PullModelAsync(model); 
         await foreach (var pull in pulls) 
         { 
             Console.WriteLine($"Pull status: {pull!.Status}"); 
         } 
 
-        Console.WriteLine($"The {this._appSettings.ConnectorType} connector created with model: {settings.Model}"); 
-        return await Task.FromResult(chatClient).ConfigureAwait(false);
+        Console.WriteLine($"The {this._appSettings.ConnectorType} connector created with model: {model}"); 
+
+        return chatClient;
     }
 }

src/OpenChat.PlaygroundApp/Connectors/UpstageConnector.cs

@@ -19,8 +19,7 @@ public class UpstageConnector(AppSettings settings) : LanguageModelConnector(set
     /// <inheritdoc/>
     public override bool EnsureLanguageModelSettingsValid()
     {
-        var settings = this.Settings as UpstageSettings;
-        if (settings is null)
+        if (this.Settings is not UpstageSettings settings)
         {
             throw new InvalidOperationException("Missing configuration: Upstage.");
         }

test/OpenChat.PlaygroundApp.Tests/Connectors/DockerModelRunnerConnectorTests.cs

@@ -217,11 +217,11 @@ public async Task Given_Valid_Settings_When_GetChatClient_Invoked_Then_It_Should
 
     [Trait("Category", "UnitTest")]
     [Theory]
-	[InlineData(null, Model, typeof(InvalidOperationException),"DockerModelRunner:BaseUrl")]
+    [InlineData(null, Model, typeof(InvalidOperationException),"DockerModelRunner:BaseUrl")]
     [InlineData("", Model, typeof(InvalidOperationException), "DockerModelRunner:BaseUrl")]
     [InlineData("   ", Model, typeof(InvalidOperationException), "DockerModelRunner:BaseUrl")]
     [InlineData("\t\r\n", Model, typeof(InvalidOperationException), "DockerModelRunner:BaseUrl")]
-	[InlineData(BaseUrl, null, typeof(InvalidOperationException), "DockerModelRunner:Model")]
+    [InlineData(BaseUrl, null, typeof(InvalidOperationException), "DockerModelRunner:Model")]
     [InlineData(BaseUrl, "", typeof(InvalidOperationException), "DockerModelRunner:Model")]
     [InlineData(BaseUrl, "   ", typeof(InvalidOperationException), "DockerModelRunner:Model")]
     [InlineData(BaseUrl, "\t\r\n", typeof(InvalidOperationException), "DockerModelRunner:Model")]

test/OpenChat.PlaygroundApp.Tests/Connectors/FoundryLocalConnectorTests.cs

@@ -137,15 +137,32 @@ public void Given_Null_FoundryLocalSettings_When_GetChatClient_Invoked_Then_It_S
             .Message.ShouldContain("Object reference not set to an instance of an object.");
     }
 
+    [Trait("Category", "UnitTest")]
+    [Theory]
+    [InlineData(null, typeof(NullReferenceException), "Object reference not set to an instance of an object")]
+    public void Given_Null_Alias_When_GetChatClient_Invoked_Then_It_Should_Throw(string? alias, Type expected, string message)
+    {
+        // Arrange
+        var settings = BuildAppSettings(alias: alias);
+        var connector = new FoundryLocalConnector(settings);
+
+        // Act
+        Func<Task> func = async () => await connector.GetChatClientAsync();
+
+        // Assert
+        func.ShouldThrow(expected)
+            .Message.ShouldContain(message);
+    }
+
     [Trait("Category", "IntegrationTest")]
     [Trait("Category", "LLMRequired")]
     [Trait("Category", "IgnoreGitHubActions")]
     [Theory]
-    [InlineData(null, typeof(InvalidOperationException), "not found in catalog.")]
-    [InlineData("", typeof(InvalidOperationException), "not found in catalog.")]
-    [InlineData("   ", typeof(InvalidOperationException), "not found in catalog.")]
-    [InlineData("\t\r\n", typeof(InvalidOperationException), "not found in catalog.")]
-    [InlineData("not-a-model", typeof(InvalidOperationException), "not found in catalog.")]
+    [InlineData(null, typeof(NullReferenceException), "Object reference not set to an instance of an object")]
+    [InlineData("", typeof(InvalidOperationException), "not found in catalog")]
+    [InlineData("   ", typeof(InvalidOperationException), "not found in catalog")]
+    [InlineData("\t\r\n", typeof(InvalidOperationException), "not found in catalog")]
+    [InlineData("not-a-model", typeof(InvalidOperationException), "not found in catalog")]
     public void Given_Invalid_Alias_When_GetChatClient_Invoked_Then_It_Should_Throw(string? alias, Type expected, string message)
     {
         // Arrange

test/OpenChat.PlaygroundApp.Tests/Connectors/HuggingFaceConnectorTests.cs

@@ -166,7 +166,7 @@ public void Given_Null_HuggingFaceSettings_When_GetChatClientAsync_Invoked_Then_
     [Trait("Category", "UnitTest")]
     [Theory]
     [InlineData(null, typeof(NullReferenceException), "Object reference not set to an instance of an object")]
-    [InlineData("", typeof(UriFormatException), "empty")]
+    [InlineData("", typeof(UriFormatException), "Invalid URI:")]
     [InlineData("   ", typeof(UriFormatException), "Invalid URI:")]
     [InlineData("\t\r\n", typeof(UriFormatException), "Invalid URI:")]
     [InlineData("invalid-uri-format", typeof(UriFormatException), "Invalid URI:")]
@@ -243,17 +243,17 @@ public async Task Given_Valid_Settings_When_GetChatClient_Invoked_Then_It_Should
 
     [Trait("Category", "UnitTest")]
     [Theory]
-	[InlineData(null, Model, typeof(NullReferenceException),"Object reference not set to an instance of an object")]
-	[InlineData("", Model, typeof(InvalidOperationException), "Missing configuration: HuggingFace:BaseUrl")]
-	[InlineData("   ", Model, typeof(InvalidOperationException), "Missing configuration: HuggingFace:BaseUrl")]
-	[InlineData("\t\r\n", Model, typeof(InvalidOperationException), "Missing configuration: HuggingFace:BaseUrl")]
-	[InlineData(BaseUrl, null, typeof(NullReferenceException), "Object reference not set to an instance of an object")]
-	[InlineData(BaseUrl, "", typeof(InvalidOperationException), "Missing configuration: HuggingFace:Model")]
-	[InlineData(BaseUrl, "   ", typeof(InvalidOperationException), "Missing configuration: HuggingFace:Model")]
-	[InlineData(BaseUrl, "\t\r\n", typeof(InvalidOperationException), "Missing configuration: HuggingFace:Model")]
-	[InlineData(BaseUrl, "hf.co/org/model", typeof(InvalidOperationException), "Invalid configuration: HuggingFace:Model format")]
-	[InlineData(BaseUrl, "org/model-gguf", typeof(InvalidOperationException), "Invalid configuration: HuggingFace:Model format")]
-	[InlineData(BaseUrl, "hf.co//model-gguf", typeof(InvalidOperationException), "Invalid configuration: HuggingFace:Model format")]
+    [InlineData(null, Model, typeof(NullReferenceException),"Object reference not set to an instance of an object")]
+    [InlineData("", Model, typeof(InvalidOperationException), "Missing configuration: HuggingFace:BaseUrl")]
+    [InlineData("   ", Model, typeof(InvalidOperationException), "Missing configuration: HuggingFace:BaseUrl")]
+    [InlineData("\t\r\n", Model, typeof(InvalidOperationException), "Missing configuration: HuggingFace:BaseUrl")]
+    [InlineData(BaseUrl, null, typeof(NullReferenceException), "Object reference not set to an instance of an object")]
+    [InlineData(BaseUrl, "", typeof(InvalidOperationException), "Missing configuration: HuggingFace:Model")]
+    [InlineData(BaseUrl, "   ", typeof(InvalidOperationException), "Missing configuration: HuggingFace:Model")]
+    [InlineData(BaseUrl, "\t\r\n", typeof(InvalidOperationException), "Missing configuration: HuggingFace:Model")]
+    [InlineData(BaseUrl, "hf.co/org/model", typeof(InvalidOperationException), "Invalid configuration: HuggingFace:Model format")]
+    [InlineData(BaseUrl, "org/model-gguf", typeof(InvalidOperationException), "Invalid configuration: HuggingFace:Model format")]
+    [InlineData(BaseUrl, "hf.co//model-gguf", typeof(InvalidOperationException), "Invalid configuration: HuggingFace:Model format")]
     public void Given_Invalid_Settings_When_CreateChatClientAsync_Invoked_Then_It_Should_Throw(string? baseUrl, string? model, Type expected, string expectedMessage)
     {
         // Arrange

test/OpenChat.PlaygroundApp.Tests/Connectors/LGConnectorTests.cs

@@ -151,7 +151,7 @@ public void Given_Valid_Model_Format_When_EnsureLanguageModelSettingsValid_Invok
     [Trait("Category", "UnitTest")]
     [Theory]
     [InlineData(null, typeof(NullReferenceException), "Object reference not set to an instance of an object")]
-    [InlineData("", typeof(UriFormatException), "empty")]
+    [InlineData("", typeof(UriFormatException), "Invalid URI:")]
     [InlineData("   ", typeof(UriFormatException), "Invalid URI:")]
     [InlineData("\t\r\n", typeof(UriFormatException), "Invalid URI:")]
     [InlineData("invalid-uri-format", typeof(UriFormatException), "Invalid URI:")]