parameterize getApiKeyFromNvpOrEnv, allowing different env variables for API keys

Author: ccreutzi

+llms/+internal/getApiKeyFromNvpOrEnv.m

@@ -1,23 +1,23 @@
-function key = getApiKeyFromNvpOrEnv(nvp)
+function key = getApiKeyFromNvpOrEnv(nvp,envVarName)
 % This function is undocumented and will change in a future release
 
 %getApiKeyFromNvpOrEnv Retrieves an API key from a Name-Value Pair struct or environment variable.
 %
-%   This function takes a struct nvp containing name-value pairs and checks
-%   if it contains a field called "ApiKey". If the field is not found, 
-%   the function attempts to retrieve the API key from an environment
-%   variable called "OPENAI_API_KEY". If both methods fail, the function 
-%   throws an error.
+%   This function takes a struct nvp containing name-value pairs and checks if
+%   it contains a field called "ApiKey". If the field is not found, the
+%   function attempts to retrieve the API key from an environment variable
+%   whose name is given as the second argument. If both methods fail, the
+%   function throws an error.
 
-%   Copyright 2023 The MathWorks, Inc.
+%   Copyright 2023-2024 The MathWorks, Inc.
 
     if isfield(nvp, "ApiKey")
         key = nvp.ApiKey;
     else
-        if isenv("OPENAI_API_KEY")
-            key = getenv("OPENAI_API_KEY");
+        if isenv(envVarName)
+            key = getenv(envVarName);
         else
-            error("llms:keyMustBeSpecified", llms.utils.errorMessageCatalog.getMessage("llms:keyMustBeSpecified"));
+            error("llms:keyMustBeSpecified", llms.utils.errorMessageCatalog.getMessage("llms:keyMustBeSpecified", envVarName));
         end
     end
-end
+end

+llms/+utils/errorMessageCatalog.m

@@ -43,7 +43,7 @@
 catalog("llms:assistantMustHaveTextNameAndArguments") = "Fields 'name' and 'arguments' must be text with one or more characters.";
 catalog("llms:mustBeValidIndex") = "Value is larger than the number of elements in Messages ({1}).";
 catalog("llms:stopSequencesMustHaveMax4Elements") = "Number of elements must not be larger than 4.";
-catalog("llms:keyMustBeSpecified") = "API key not found as environment variable OPENAI_API_KEY and not specified via ApiKey parameter.";
+catalog("llms:keyMustBeSpecified") = "API key not found as environment variable {1} and not specified via ApiKey parameter.";
 catalog("llms:mustHaveMessages") = "Value must contain at least one message in Messages.";
 catalog("llms:mustSetFunctionsForCall") = "When no functions are defined, ToolChoice must not be specified.";
 catalog("llms:mustBeMessagesOrTxt") = "Messages must be text with one or more characters or an openAIMessages objects.";
@@ -58,4 +58,4 @@
 catalog("llms:invalidOptionsForAzureBackEnd") = "The parameter Model Name is not compatible with Azure.";
 catalog("llms:apiReturnedError") = "OpenAI API Error: {1}";
 catalog("llms:dimensionsMustBeSmallerThan") = "Dimensions must be less than or equal to {1}.";
-end
+end

.github/workflows/ci.yml

@@ -15,6 +15,9 @@ jobs:
       - name: Run tests and generate artifacts
         env:
             OPENAI_KEY: ${{ secrets.OPENAI_KEY }}
+            AZURE_OPENAI_DEPLOYMENT: ${{ secrets.AZURE_DEPLOYMENT }}
+            AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_ENDPOINT }}
+            AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_KEY }}
         uses: matlab-actions/run-tests@v2
         with:
           test-results-junit: test-results/results.xml

azureChat.m

@@ -132,7 +132,7 @@
             this.StopSequences = nvp.StopSequences;
             this.PresencePenalty = nvp.PresencePenalty;
             this.FrequencyPenalty = nvp.FrequencyPenalty;
-            this.ApiKey = llms.internal.getApiKeyFromNvpOrEnv(nvp);
+            this.ApiKey = llms.internal.getApiKeyFromNvpOrEnv(nvp,"AZURE_OPENAI_API_KEY");
             this.TimeOut = nvp.TimeOut;
         end
 

extractOpenAIEmbeddings.m

@@ -33,7 +33,7 @@
 
 END_POINT = "https://api.openai.com/v1/embeddings";
 
-key = llms.internal.getApiKeyFromNvpOrEnv(nvp);
+key = llms.internal.getApiKeyFromNvpOrEnv(nvp,"OPENAI_API_KEY");
 
 parameters = struct("input",text,"model",nvp.ModelName);
 

openAIChat.m

@@ -124,7 +124,7 @@
 
             this.PresencePenalty = nvp.PresencePenalty;
             this.FrequencyPenalty = nvp.FrequencyPenalty;
-            this.ApiKey = llms.internal.getApiKeyFromNvpOrEnv(nvp);
+            this.ApiKey = llms.internal.getApiKeyFromNvpOrEnv(nvp,"OPENAI_API_KEY");
             this.TimeOut = nvp.TimeOut;
         end
 

openAIImages.m

@@ -51,7 +51,7 @@
             end
 
             this.ModelName = nvp.ModelName;
-            this.ApiKey = llms.internal.getApiKeyFromNvpOrEnv(nvp);
+            this.ApiKey = llms.internal.getApiKeyFromNvpOrEnv(nvp,"OPENAI_API_KEY");
             this.TimeOut = nvp.TimeOut;
         end
 

tests/tazureChat.m

@@ -6,11 +6,11 @@
     methods (TestClassSetup)
         function saveEnvVar(testCase)
             % Ensures key is not in environment variable for tests
-            openAIEnvVar = "OPENAI_API_KEY";
-            if isenv(openAIEnvVar)
-                key = getenv(openAIEnvVar);
-                unsetenv(openAIEnvVar);
-                testCase.addTeardown(@(x) setenv(openAIEnvVar, x), key);
+            azureKeyVar = "AZURE_OPENAI_API_KEY";
+            if isenv(azureKeyVar)
+                key = getenv(azureKeyVar);
+                unsetenv(azureKeyVar);
+                testCase.addTeardown(@(x) setenv(azureKeyVar, x), key);
             end
         end
     end