Merge branch 'main' into OllamaRAGExample

Author: ccreutzi

azureChat.m

@@ -103,11 +103,11 @@
         function this = azureChat(systemPrompt, nvp)
             arguments
                 systemPrompt                       {llms.utils.mustBeTextOrEmpty} = []
-                nvp.Endpoint                       {mustBeNonzeroLengthTextScalar}
-                nvp.Deployment                     {mustBeNonzeroLengthTextScalar}
+                nvp.Endpoint                 (1,1) string {mustBeNonzeroLengthTextScalar}
+                nvp.Deployment               (1,1) string {mustBeNonzeroLengthTextScalar}
                 nvp.APIKey                         {mustBeNonzeroLengthTextScalar}
                 nvp.Tools                    (1,:) {mustBeA(nvp.Tools, "openAIFunction")} = openAIFunction.empty
-                nvp.APIVersion               (1,1) {mustBeAPIVersion} = "2024-02-01"
+                nvp.APIVersion               (1,1) string {mustBeAPIVersion} = "2024-02-01"
                 nvp.Temperature                    {llms.utils.mustBeValidTemperature} = 1
                 nvp.TopP                           {llms.utils.mustBeValidTopP} = 1
                 nvp.StopSequences                  {llms.utils.mustBeValidStop} = {}

tests/tazureChat.m

@@ -8,6 +8,7 @@
         InvalidGenerateInput = iGetInvalidGenerateInput;
         InvalidValuesSetters = iGetInvalidValuesSetters;
         StringInputs = struct('string',{"hi"},'char',{'hi'},'cellstr',{{'hi'}});
+        APIVersions = iGetAPIVersions();
     end
 
     methods(Test)
@@ -40,6 +41,14 @@ function doGenerate(testCase,StringInputs)
             testCase.verifyGreaterThan(strlength(response),0);
         end
 
+        function doGenerateUsingSystemPrompt(testCase)
+            testCase.assumeTrue(isenv("AZURE_OPENAI_API_KEY"),"end-to-end test requires environment variables AZURE_OPENAI_API_KEY, AZURE_OPENAI_ENDPOINT, and AZURE_OPENAI_DEPLOYMENT.");
+            chat = azureChat("You are a helpful assistant");
+            response = testCase.verifyWarningFree(@() generate(chat,"Hi"));
+            testCase.verifyClass(response,'string');
+            testCase.verifyGreaterThan(strlength(response),0);
+        end
+
         function generateMultipleResponses(testCase)
             chat = azureChat;
             [~,~,response] = generate(chat,"What is a cat?",NumCompletions=3);
@@ -150,6 +159,38 @@ function keyNotFound(testCase)
             unsetenv("AZURE_OPENAI_API_KEY");
             testCase.verifyError(@()azureChat, "llms:keyMustBeSpecified");
         end
+
+        function canUseAPIVersions(testCase, APIVersions)
+            % Test that we can use different APIVersion value to call 
+            % azureChat.generate
+
+            testCase.assumeTrue(isenv("AZURE_OPENAI_API_KEY"),"end-to-end test requires environment variables AZURE_OPENAI_API_KEY, AZURE_OPENAI_ENDPOINT, and AZURE_OPENAI_DEPLOYMENT.");
+            chat = azureChat("APIVersion", APIVersions);
+
+            response = testCase.verifyWarningFree(@() generate(chat,"How similar is the DNA of a cat and a tiger?"));
+            testCase.verifyClass(response,'string');
+            testCase.verifyGreaterThan(strlength(response),0);
+        end
+
+        function endpointNotFound(testCase)
+            % to verify the error, we need to unset the environment variable
+            % AZURE_OPENAI_ENDPOINT, if given. Use a fixture to restore the
+            % value on leaving the test point
+            import matlab.unittest.fixtures.EnvironmentVariableFixture
+            testCase.applyFixture(EnvironmentVariableFixture("AZURE_OPENAI_ENDPOINT","dummy"));
+            unsetenv("AZURE_OPENAI_ENDPOINT");
+            testCase.verifyError(@()azureChat, "llms:endpointMustBeSpecified");
+        end
+
+        function deploymentNotFound(testCase)
+            % to verify the error, we need to unset the environment variable
+            % AZURE_OPENAI_DEPLOYMENT, if given. Use a fixture to restore the
+            % value on leaving the test point
+            import matlab.unittest.fixtures.EnvironmentVariableFixture
+            testCase.applyFixture(EnvironmentVariableFixture("AZURE_OPENAI_DEPLOYMENT","dummy"));
+            unsetenv("AZURE_OPENAI_DEPLOYMENT");
+            testCase.verifyError(@()azureChat, "llms:deploymentMustBeSpecified");
+        end
     end
 end
 
@@ -446,3 +487,7 @@ function keyNotFound(testCase)
             "Input",{{ validMessages  "ToolChoice" ["validfunction", "validfunction"] }},...
             "Error","MATLAB:validators:mustBeTextScalar"));
 end
+
+function apiVersions = iGetAPIVersions()
+apiVersions = cellstr(llms.azure.apiVersions);
+end

tests/tollamaChat.m

@@ -39,6 +39,13 @@ function doGenerate(testCase,StringInputs)
             testCase.verifyGreaterThan(strlength(response),0);
         end
 
+        function doGenerateUsingSystemPrompt(testCase)
+            chat = ollamaChat("mistral","You are a helpful assistant");
+            response = testCase.verifyWarningFree(@() generate(chat,"Hi"));
+            testCase.verifyClass(response,'string');
+            testCase.verifyGreaterThan(strlength(response),0);
+        end
+
         function extremeTopK(testCase)
             % setting top-k to k=1 leaves no random choice,
             % so we expect to get a fixed response.