Merge pull request #482 from microsoft/psl-pk-km-fdp

refactor: Configuration and Deployment Adjustments, Standardization of Azure OpenAI Naming Conventions

Author: Avijit-Microsoft

docs/workshop/docs/workshop/.env.sample

@@ -1,3 +1,2 @@
 AZURE_AI_SEARCH_API_KEY=""
-AZURE_OPENAI_API_KEY=""
 

docs/workshop/docs/workshop/Challenge-3-and-4/Challenge-3.md

@@ -57,10 +57,8 @@ One of the easiest and most fun changes you can make to the app is updating the
    ![Azure Portal Settings > Configuration](../img/portal-app-api-env.png)
 5. Locate the following environment variables:
    - `AZURE_AI_SEARCH_API_KEY`
-   - `AZURE_OPENAI_API_KEY`
 6. Copy their values and paste them into your local `\workshop\docs\workshop\.env.sample` file:
    `AZURE_AI_SEARCH_API_KEY=your-key-from-portal`
-   `AZURE_OPENAI_API_KEY=your-other-key-from-portal`
 7. Rename the .env.sample file to .env
 8. Open a terminal or command prompt.
 9. Navigate to the project directory where `start.cmd` is located:

docs/workshop/docs/workshop/Challenge-3-and-4/knowledge_mining_api.ipynb

@@ -113,9 +113,8 @@
     "# Define a chat with data plugin for the conversational data\n",
     "class ChatWithDataPlugin:\n",
     "    def __init__(self):\n",
-    "        self.azure_openai_deployment_model = os.getenv(\"AZURE_OPEN_AI_DEPLOYMENT_MODEL\")\n",
-    "        self.azure_openai_endpoint = os.getenv(\"AZURE_OPEN_AI_ENDPOINT\")\n",
-    "        self.azure_openai_api_key = os.getenv(\"AZURE_OPENAI_API_KEY\")\n",
+    "        self.azure_openai_deployment_model = os.getenv(\"AZURE_OPENAI_DEPLOYMENT_MODEL\")\n",
+    "        self.azure_openai_endpoint = os.getenv(\"AZURE_OPENAI_ENDPOINT\")\n",
     "        self.azure_openai_api_version = os.getenv(\"AZURE_OPENAI_API_VERSION\")\n",
     "        self.azure_ai_search_endpoint = os.getenv(\"AZURE_AI_SEARCH_ENDPOINT\")\n",
     "        self.azure_ai_search_api_key = os.getenv(\"AZURE_AI_SEARCH_API_KEY\")\n",

docs/workshop/docs/workshop/Challenge-6/Content_safety_evaluation.ipynb

@@ -209,9 +209,8 @@
    "outputs": [],
    "source": [
     "model_config = {\n",
-    "    \"azure_endpoint\": os.environ.get(\"AZURE_OPEN_AI_ENDPOINT\"),\n",
-    "    \"api_key\": os.environ.get(\"AZURE_OPENAI_API_KEY\"),\n",
-    "    \"azure_deployment\": os.environ.get(\"AZURE_OPEN_AI_DEPLOYMENT_MODEL\"),\n",
+    "    \"azure_endpoint\": os.environ.get(\"AZURE_OPENAI_ENDPOINT\"),\n",
+    "    \"azure_deployment\": os.environ.get(\"AZURE_OPENAI_DEPLOYMENT_MODEL\"),\n",
     "    \"api_version\": os.environ.get(\"AZURE_OPENAI_API_VERSION\"),\n",
     "}"
    ]

documents/CustomizingAzdParameters.md

@@ -13,11 +13,11 @@ By default this template will use the environment name as the prefix to prevent
 | `AZURE_ENV_NAME`                          | string  | `env_name`               | Sets the environment name prefix for all Azure resources.                  |
 | `AZURE_CONTENT_UNDERSTANDING_LOCATION`    | string  | `swedencentral`          | Specifies the region for content understanding resources.                  |
 | `AZURE_SECONDARY_LOCATION`                | string  | `eastus2`                | Specifies a secondary Azure region.                                        |
-| `AZURE_OPEN_AI_MODEL_DEPLOYMENT_TYPE`     | string  | `GlobalStandard`         | Defines the model deployment type (allowed: `Standard`, `GlobalStandard`). |
-| `AZURE_OPEN_AI_DEPLOYMENT_MODEL`          | string  | `gpt-4o-mini`            | Specifies the GPT model name (e.g., `gpt-4`, `gpt-4o-mini`).               |
+| `AZURE_OPENAI_MODEL_DEPLOYMENT_TYPE`     | string  | `GlobalStandard`         | Defines the model deployment type (allowed: `Standard`, `GlobalStandard`). |
+| `AZURE_OPENAI_DEPLOYMENT_MODEL`          | string  | `gpt-4o-mini`            | Specifies the GPT model name (e.g., `gpt-4`, `gpt-4o-mini`).               |
 | `AZURE_ENV_MODEL_VERSION`                 | string  | `2024-07-18`             | Sets the Azure model version (allowed: `2024-08-06`, etc.).                |
 | `AZURE_OPENAI_API_VERSION`            | string  | `2025-01-01-preview`     | Specifies the API version for Azure OpenAI.                                |
-| `AZURE_OPEN_AI_DEPLOYMENT_MODEL_CAPACITY` | integer | `30`                     | Sets the GPT model capacity.                                               |
+| `AZURE_OPENAI_DEPLOYMENT_MODEL_CAPACITY` | integer | `30`                     | Sets the GPT model capacity.                                               |
 | `AZURE_OPENAI_EMBEDDING_MODEL`            | string  | `text-embedding-ada-002` | Sets the name of the embedding model to use.                               |
 | `AZURE_ENV_IMAGETAG`                      | string  | `latest`        | Sets the image tag (`latest`, `dev`, `hotfix`, etc.).   |
 | `AZURE_OPENAI_EMBEDDING_MODEL_CAPACITY`   | integer | `80`                     | Sets the capacity for the embedding model deployment.                      |

documents/DeploymentGuide.md

@@ -118,7 +118,7 @@ When you start the deployment, most parameters will have **default values**, but
 | **GPT Model Deployment Capacity**           | Configure capacity for **GPT models** (in thousands).                                                     | 30k                    |
 | **Embedding Model**                         | Default: **text-embedding-ada-002**.                                                                      | text-embedding-ada-002 |
 | **Embedding Model Capacity**                | Set the capacity for **embedding models** (in thousands).                                                 | 80k                    |
-| **Image Tag**                               | Docker image tag to deploy. Common values: `latest`, `dev`, `hotfix`.                  | latest\_migrated       |
+| **Image Tag**                               | Docker image tag to deploy. Common values: `latest`, `dev`, `hotfix`.                  | latest       |
 | **Existing Log Analytics Workspace**        | To reuse an existing Log Analytics Workspace ID.                                                          | *(empty)*              |
 
 

infra/deploy_ai_foundry.bicep

@@ -409,7 +409,7 @@ resource azureOpenAIApiKeyEntry 'Microsoft.KeyVault/vaults/secrets@2021-11-01-pr
 
 resource azureOpenAIDeploymentModel 'Microsoft.KeyVault/vaults/secrets@2021-11-01-preview' = {
   parent: keyVault
-  name: 'AZURE-OPEN-AI-DEPLOYMENT-MODEL'
+  name: 'AZURE-OPENAI-DEPLOYMENT-MODEL'
   properties: {
     value: gptModelName
   }

infra/main.bicep

@@ -204,8 +204,8 @@ module backend_docker 'deploy_backend_docker.bicep' = {
     keyVaultName: kvault.outputs.keyvaultName
     aiServicesName: aifoundry.outputs.aiServicesName
     appSettings: {
-      AZURE_OPEN_AI_DEPLOYMENT_MODEL: gptModelName
-      AZURE_OPEN_AI_ENDPOINT: aifoundry.outputs.aiServicesTarget
+      AZURE_OPENAI_DEPLOYMENT_MODEL: gptModelName
+      AZURE_OPENAI_ENDPOINT: aifoundry.outputs.aiServicesTarget
       AZURE_OPENAI_API_VERSION: azureOpenAIApiVersion
       AZURE_OPENAI_RESOURCE: aifoundry.outputs.aiServicesName
       AZURE_AI_AGENT_ENDPOINT: aifoundry.outputs.projectEndpoint
@@ -220,7 +220,6 @@ module backend_docker 'deploy_backend_docker.bicep' = {
       SQLDB_USERNAME: sqlDBModule.outputs.sqlDbUser
       SQLDB_USER_MID: managedIdentityModule.outputs.managedIdentityBackendAppOutput.clientId
 
-      OPENAI_API_VERSION: azureOpenAIApiVersion
       AZURE_AI_SEARCH_ENDPOINT: aifoundry.outputs.aiSearchTarget
       AZURE_AI_SEARCH_API_KEY: '@Microsoft.KeyVault(SecretUri=${kvault.outputs.keyvaultUri}secrets/AZURE-SEARCH-KEY/)'
       AZURE_AI_SEARCH_INDEX: 'call_transcripts_index'
@@ -264,15 +263,14 @@ output AZURE_COSMOSDB_ACCOUNT string = cosmosDBModule.outputs.cosmosAccountName
 output AZURE_COSMOSDB_CONVERSATIONS_CONTAINER string = 'conversations'
 output AZURE_COSMOSDB_DATABASE string = 'db_conversation_history'
 output AZURE_COSMOSDB_ENABLE_FEEDBACK string = 'True'
-output AZURE_OPEN_AI_DEPLOYMENT_MODEL string = gptModelName
-output AZURE_OPEN_AI_DEPLOYMENT_MODEL_CAPACITY int = gptDeploymentCapacity
-output AZURE_OPEN_AI_ENDPOINT string = aifoundry.outputs.aiServicesTarget
-output AZURE_OPEN_AI_MODEL_DEPLOYMENT_TYPE string = deploymentType
+output AZURE_OPENAI_DEPLOYMENT_MODEL string = gptModelName
+output AZURE_OPENAI_DEPLOYMENT_MODEL_CAPACITY int = gptDeploymentCapacity
+output AZURE_OPENAI_ENDPOINT string = aifoundry.outputs.aiServicesTarget
+output AZURE_OPENAI_MODEL_DEPLOYMENT_TYPE string = deploymentType
 output AZURE_OPENAI_EMBEDDING_MODEL string = embeddingModel
 output AZURE_OPENAI_EMBEDDING_MODEL_CAPACITY int = embeddingDeploymentCapacity
 output AZURE_OPENAI_API_VERSION string = azureOpenAIApiVersion
 output AZURE_OPENAI_RESOURCE string = aifoundry.outputs.aiServicesName
-output OPENAI_API_VERSION string = azureOpenAIApiVersion
 output REACT_APP_LAYOUT_CONFIG string = backend_docker.outputs.reactAppLayoutConfig
 output SQLDB_DATABASE string = sqlDBModule.outputs.sqlDbName
 output SQLDB_SERVER string = sqlDBModule.outputs.sqlServerName

infra/main.bicepparam

@@ -4,11 +4,11 @@ param AZURE_LOCATION = readEnvironmentVariable('AZURE_LOCATION', '')
 param environmentName = readEnvironmentVariable('AZURE_ENV_NAME', 'env_name')
 param contentUnderstandingLocation = readEnvironmentVariable('AZURE_CONTENT_UNDERSTANDING_LOCATION', 'swedencentral')
 param secondaryLocation = readEnvironmentVariable('AZURE_SECONDARY_LOCATION', 'eastus2')
-param deploymentType = readEnvironmentVariable('AZURE_OPEN_AI_MODEL_DEPLOYMENT_TYPE', 'GlobalStandard')
-param gptModelName = readEnvironmentVariable('AZURE_OPEN_AI_DEPLOYMENT_MODEL', 'gpt-4o-mini')
+param deploymentType = readEnvironmentVariable('AZURE_OPENAI_MODEL_DEPLOYMENT_TYPE', 'GlobalStandard')
+param gptModelName = readEnvironmentVariable('AZURE_OPENAI_DEPLOYMENT_MODEL', 'gpt-4o-mini')
 param gptModelVersion = readEnvironmentVariable('AZURE_ENV_MODEL_VERSION', '2024-07-18')
 param azureOpenAIApiVersion = readEnvironmentVariable('AZURE_OPENAI_API_VERSION', '2025-01-01-preview')
-param gptDeploymentCapacity = int(readEnvironmentVariable('AZURE_OPEN_AI_DEPLOYMENT_MODEL_CAPACITY', '30'))
+param gptDeploymentCapacity = int(readEnvironmentVariable('AZURE_OPENAI_DEPLOYMENT_MODEL_CAPACITY', '30'))
 param embeddingModel = readEnvironmentVariable('AZURE_OPENAI_EMBEDDING_MODEL', 'text-embedding-ada-002')
 param imageTag = readEnvironmentVariable('AZURE_ENV_IMAGETAG', 'latest')
 param embeddingDeploymentCapacity = int(readEnvironmentVariable('AZURE_OPENAI_EMBEDDING_MODEL_CAPACITY', '80'))

infra/main.json

@@ -5,7 +5,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.36.1.42791",
-      "templateHash": "2363441728169448979"
+      "templateHash": "13054052551237865749"
     }
   },
   "parameters": {
@@ -629,7 +629,7 @@
             "_generator": {
               "name": "bicep",
               "version": "0.36.1.42791",
-              "templateHash": "18372336587051722949"
+              "templateHash": "1417417976966483720"
             }
           },
           "parameters": {
@@ -1325,7 +1325,7 @@
             {
               "type": "Microsoft.KeyVault/vaults/secrets",
               "apiVersion": "2021-11-01-preview",
-              "name": "[format('{0}/{1}', parameters('keyVaultName'), 'AZURE-OPEN-AI-DEPLOYMENT-MODEL')]",
+              "name": "[format('{0}/{1}', parameters('keyVaultName'), 'AZURE-OPENAI-DEPLOYMENT-MODEL')]",
               "properties": {
                 "value": "[parameters('gptModelName')]"
               }
@@ -2493,8 +2493,8 @@
           },
           "appSettings": {
             "value": {
-              "AZURE_OPEN_AI_DEPLOYMENT_MODEL": "[parameters('gptModelName')]",
-              "AZURE_OPEN_AI_ENDPOINT": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_ai_foundry'), '2022-09-01').outputs.aiServicesTarget.value]",
+              "AZURE_OPENAI_DEPLOYMENT_MODEL": "[parameters('gptModelName')]",
+              "AZURE_OPENAI_ENDPOINT": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_ai_foundry'), '2022-09-01').outputs.aiServicesTarget.value]",
               "AZURE_OPENAI_API_VERSION": "[parameters('azureOpenAIApiVersion')]",
               "AZURE_OPENAI_RESOURCE": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_ai_foundry'), '2022-09-01').outputs.aiServicesName.value]",
               "AZURE_AI_AGENT_ENDPOINT": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_ai_foundry'), '2022-09-01').outputs.projectEndpoint.value]",
@@ -2508,7 +2508,6 @@
               "SQLDB_SERVER": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_sql_db'), '2022-09-01').outputs.sqlServerName.value]",
               "SQLDB_USERNAME": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_sql_db'), '2022-09-01').outputs.sqlDbUser.value]",
               "SQLDB_USER_MID": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_managed_identity'), '2022-09-01').outputs.managedIdentityBackendAppOutput.value.clientId]",
-              "OPENAI_API_VERSION": "[parameters('azureOpenAIApiVersion')]",
               "AZURE_AI_SEARCH_ENDPOINT": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_ai_foundry'), '2022-09-01').outputs.aiSearchTarget.value]",
               "AZURE_AI_SEARCH_API_KEY": "[format('@Microsoft.KeyVault(SecretUri={0}secrets/AZURE-SEARCH-KEY/)', reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_keyvault'), '2022-09-01').outputs.keyvaultUri.value)]",
               "AZURE_AI_SEARCH_INDEX": "call_transcripts_index",
@@ -3217,19 +3216,19 @@
       "type": "string",
       "value": "True"
     },
-    "AZURE_OPEN_AI_DEPLOYMENT_MODEL": {
+    "AZURE_OPENAI_DEPLOYMENT_MODEL": {
       "type": "string",
       "value": "[parameters('gptModelName')]"
     },
-    "AZURE_OPEN_AI_DEPLOYMENT_MODEL_CAPACITY": {
+    "AZURE_OPENAI_DEPLOYMENT_MODEL_CAPACITY": {
       "type": "int",
       "value": "[parameters('gptDeploymentCapacity')]"
     },
-    "AZURE_OPEN_AI_ENDPOINT": {
+    "AZURE_OPENAI_ENDPOINT": {
       "type": "string",
       "value": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_ai_foundry'), '2022-09-01').outputs.aiServicesTarget.value]"
     },
-    "AZURE_OPEN_AI_MODEL_DEPLOYMENT_TYPE": {
+    "AZURE_OPENAI_MODEL_DEPLOYMENT_TYPE": {
       "type": "string",
       "value": "[parameters('deploymentType')]"
     },
@@ -3249,10 +3248,6 @@
       "type": "string",
       "value": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_ai_foundry'), '2022-09-01').outputs.aiServicesName.value]"
     },
-    "OPENAI_API_VERSION": {
-      "type": "string",
-      "value": "[parameters('azureOpenAIApiVersion')]"
-    },
     "REACT_APP_LAYOUT_CONFIG": {
       "type": "string",
       "value": "[reference(extensionResourceId(format('/subscriptions/{0}/resourceGroups/{1}', subscription().subscriptionId, resourceGroup().name), 'Microsoft.Resources/deployments', 'deploy_backend_docker'), '2022-09-01').outputs.reactAppLayoutConfig.value]"