Rename Azure OpenAI key variable (#1880)

Author: pamelafox

app/backend/app.py

@@ -541,8 +541,8 @@ async def setup_clients():
             if not AZURE_OPENAI_SERVICE:
                 raise ValueError("AZURE_OPENAI_SERVICE must be set when OPENAI_HOST is azure")
             endpoint = f"https://{AZURE_OPENAI_SERVICE}.openai.azure.com"
-        if api_key := os.getenv("AZURE_OPENAI_API_KEY"):
-            current_app.logger.info("AZURE_OPENAI_API_KEY found, using as value for api_key for Azure OpenAI client")
+        if api_key := os.getenv("AZURE_OPENAI_API_KEY_OVERRIDE"):
+            current_app.logger.info("AZURE_OPENAI_API_KEY_OVERRIDE found, using as api_key for Azure OpenAI client")
             openai_client = AsyncAzureOpenAI(api_version=api_version, azure_endpoint=endpoint, api_key=api_key)
         else:
             current_app.logger.info("Using Azure credential (passwordless authentication) for Azure OpenAI client")

infra/main.bicep

@@ -307,7 +307,7 @@ module backend 'core/host/appservice.bicep' = {
       AZURE_OPENAI_EMB_DEPLOYMENT: embedding.deploymentName
       AZURE_OPENAI_GPT4V_DEPLOYMENT: useGPT4V ? gpt4vDeploymentName : ''
       AZURE_OPENAI_API_VERSION: azureOpenAiApiVersion
-      AZURE_OPENAI_API_KEY: azureOpenAiApiKey
+      AZURE_OPENAI_API_KEY_OVERRIDE: azureOpenAiApiKey
       AZURE_OPENAI_CUSTOM_URL: azureOpenAiCustomUrl
       // Used only with non-Azure OpenAI deployments
       OPENAI_API_KEY: openAiApiKey

infra/main.parameters.json

@@ -126,7 +126,7 @@
       "value": "${AZURE_OPENAI_API_VERSION}"
     },
     "azureOpenAiApiKey":{
-      "value": "${AZURE_OPENAI_API_KEY}"
+      "value": "${AZURE_OPENAI_API_KEY_OVERRIDE}"
     },
     "openAiApiKey": {
       "value": "${OPENAI_API_KEY}"

scripts/prepdocs.ps1

@@ -65,8 +65,8 @@ if ($env:USE_FEATURE_INT_VECTORIZATION) {
   $integratedVectorizationArg = "--useintvectorization $env:USE_FEATURE_INT_VECTORIZATION"
 }
 
-if ($env:AZURE_OPENAI_API_KEY) {
-  $openaiApiKeyArg = "--openaikey $env:AZURE_OPENAI_API_KEY"
+if ($env:AZURE_OPENAI_API_KEY_OVERRIDE) {
+  $openaiApiKeyArg = "--openaikey $env:AZURE_OPENAI_API_KEY_OVERRIDE"
 } elseif ($env:OPENAI_API_KEY) {
   $openaiApiKeyArg = "--openaikey $env:OPENAI_API_KEY"
 }

scripts/prepdocs.sh

@@ -63,8 +63,8 @@ if [ -n "$USE_FEATURE_INT_VECTORIZATION" ]; then
   integratedVectorizationArg="--useintvectorization $USE_FEATURE_INT_VECTORIZATION"
 fi
 
-if [ -n "$AZURE_OPENAI_API_KEY" ]; then
-  openAiApiKeyArg="--openaikey $AZURE_OPENAI_API_KEY"
+if [ -n "$AZURE_OPENAI_API_KEY_OVERRIDE" ]; then
+  openAiApiKeyArg="--openaikey $AZURE_OPENAI_API_KEY_OVERRIDE"
 elif [ -n "$OPENAI_API_KEY" ]; then
   openAiApiKeyArg="--openaikey $OPENAI_API_KEY"
 fi

tests/test_app_config.py

@@ -33,7 +33,7 @@ async def test_app_local_openai(monkeypatch, minimal_env):
 async def test_app_azure_custom_key(monkeypatch, minimal_env):
     monkeypatch.setenv("OPENAI_HOST", "azure_custom")
     monkeypatch.setenv("AZURE_OPENAI_CUSTOM_URL", "http://azureapi.com/api/v1")
-    monkeypatch.setenv("AZURE_OPENAI_API_KEY", "azure-api-key")
+    monkeypatch.setenv("AZURE_OPENAI_API_KEY_OVERRIDE", "azure-api-key")
 
     quart_app = app.create_app()
     async with quart_app.test_app():