Merge branch 'byoc-researcher' of https://github.com/microsoft/Build-your-own-copilot-Solution-Accelerator into byoc-researcher

Author: Roopan-Microsoft

README.md

@@ -66,6 +66,13 @@ For additional training and support, please see:
 1. Please check the link [Azure Products by Region](
 https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=all) and choose a region where Azure AI Search, Semantic Ranker, Azure OpenAI Service, and Azure AI Foundry are available. 
 
+<br/>
+
+> ⚠️ **Important: Check Azure OpenAI Quota Availability**
+ <br/>To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/QuotaCheck.md) before you deploy the solution.
+
+<br/>
+
 2. Click the following deployment button to create the required resources for this accelerator in your Azure Subscription.
 
    [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2FBuild-your-own-copilot-Solution-Accelerator%2Fbyoc-researcher%2Finfra%2Fbicep%2Fmain.json)

docs/QuotaCheck.md

@@ -0,0 +1,100 @@
+## Check Quota Availability Before Deployment
+
+Before deploying the accelerator, **ensure sufficient quota availability** for the required model.
+> **For Global Standard | GPT-35-turbo - increase the capacity to at least 50K tokens for optimal performance.**
+
+### Login if you have not done so already
+```
+azd auth login
+```
+
+
+### 📌 Default Models & Capacities:
+```
+gpt-35-turbo:30, text-embedding-ada-002:45
+```
+### 📌 Default Regions:
+```
+australiaeast, francecentral, japaneast, northcentralus, southcentralus, westus, eastus, uksouth
+```
+### Usage Scenarios:
+- No parameters passed → Default models and capacities will be checked in default regions.
+- Only model(s) provided → The script will check for those models in the default regions.
+- Only region(s) provided → The script will check default models in the specified regions.
+- Both models and regions provided → The script will check those models in the specified regions.
+- `--verbose` passed → Enables detailed logging output for debugging and traceability.
+  
+### **Input Formats**
+> Use the --models, --regions, and --verbose options for parameter handling:
+
+✔️ Run without parameters to check default models & regions without verbose logging:
+   ```
+  ./quota_check_params.sh
+   ```
+✔️ Enable verbose logging:
+   ```
+  ./quota_check_params.sh --verbose
+   ```
+✔️ Check specific model(s) in default regions:
+  ```
+  ./quota_check_params.sh --models gpt-35-turbo:30,text-embedding-ada-002:45
+  ```
+✔️ Check default models in specific region(s):
+  ```
+./quota_check_params.sh --regions eastus,westus
+  ```
+✔️ Passing Both models and regions:  
+  ```
+  ./quota_check_params.sh --models gpt-35-turbo:30 --regions eastus,westus
+  ```
+✔️ All parameters combined:
+  ```
+ ./quota_check_params.sh --models gpt-35-turbo:30,text-embedding-ada-002:45 --regions eastus,westus --verbose
+  ```
+
+### **Sample Output**
+The final table lists regions with available quota. You can select any of these regions for deployment.
+
+![quota-check-ouput](images/readMe/quota-check-output.png)
+
+---
+### **If using Azure Portal and Cloud Shell**
+
+1. Navigate to the [Azure Portal](https://portal.azure.com).
+2. Click on **Azure Cloud Shell** in the top right navigation menu.
+3. Run the appropriate command based on your requirement:  
+
+   **To check quota for the deployment**  
+
+    ```sh
+    curl -L -o quota_check_params.sh "https://raw.githubusercontent.com/microsoft/Build-your-own-copilot-Solution-Accelerator/byoc-researcher/infra/scripts/quota_check_params.sh"
+    chmod +x quota_check_params.sh
+    ./quota_check_params.sh
+    ```
+    - Refer to [Input Formats](#input-formats) for detailed commands.
+      
+### **If using VS Code or Codespaces**
+1. Open the terminal in VS Code or Codespaces.
+2. If you're using VS Code, click the dropdown on the right side of the terminal window, and select `Git Bash`.
+   ![git_bash](images/git_bash.png)
+3. Navigate to the `scripts` folder where the script files are located and make the script as executable:
+   ```sh
+    cd infra/scripts
+    chmod +x quota_check_params.sh
+    ```
+4. Run the appropriate script based on your requirement:  
+
+   **To check quota for the deployment**  
+
+    ```sh
+    ./quota_check_params.sh
+    ```
+   - Refer to [Input Formats](#input-formats) for detailed commands.
+
+5. If you see the error `_bash: az: command not found_`, install Azure CLI:  
+
+    ```sh
+    curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+    az login
+    ```
+6. Rerun the script after installing Azure CLI.

docs/images/git_bash.png

@@ -47,7 +47,7 @@ resource accounts_byc_openai_name_text_embedding_ada_002 'Microsoft.CognitiveSer
   parent: accounts_byc_openai_name_resource
   name: 'text-embedding-ada-002'
   sku: {
-    name: 'Standard'
+    name: 'GlobalStandard'
     capacity: 45
   }
   properties: {

docs/images/readMe/quota-check-output.png

@@ -29,17 +29,17 @@ param enableForDiskEncryption bool = true
 @description('Enabled For Template Deployment. Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.')
 param enableForTemplateDeployment bool = true
 
-@description('Enable Purge Protection. Property specifying whether protection against purge is enabled for this vault.')
-param enablePurgeProtection bool = true
+// @description('Enable Purge Protection. Property specifying whether protection against purge is enabled for this vault.')
+// param enablePurgeProtection bool = false
 
 @description('Enable RBAC Authorization. Property that controls how data actions are authorized.')
 param enableRBACAuthorization bool = true
 
 @description('Enable Soft Delete. Property to specify whether the "soft delete" functionality is enabled for this key vault.')
-param enableSoftDelete bool = false
+param enableSoftDelete bool = true
 
 @description('Soft Delete Retention in Days. softDelete data retention days. It accepts >=7 and <=90.')
-param softDeleteRetentionInDays int = 30
+param softDeleteRetentionInDays int = 7
 
 @description('Public Network Access, Property to specify whether the vault will accept traffic from public internet.')
 @allowed([
@@ -117,7 +117,6 @@ resource keyVault 'Microsoft.KeyVault/vaults@2022-07-01' = {
     enabledForDeployment: enableForDeployment
     enabledForDiskEncryption: enableForDiskEncryption
     enabledForTemplateDeployment: enableForTemplateDeployment
-    enablePurgeProtection: enablePurgeProtection
     enableRbacAuthorization: enableRBACAuthorization
     enableSoftDelete: enableSoftDelete
     softDeleteRetentionInDays: softDeleteRetentionInDays

infra/bicep/deploy_azure_open_ai.bicep

@@ -16,6 +16,16 @@ var subscriptionId  = subscription().subscriptionId
 var solutionLocation = resourceGroupLocation
 var baseUrl = 'https://raw.githubusercontent.com/microsoft/Build-your-own-copilot-Solution-Accelerator/byoc-researcher/'
 
+// ========== Resource Group Tag ========== //
+resource resourceGroupTags 'Microsoft.Resources/tags@2021-04-01' = {
+  name: 'default'
+  properties: {
+    tags: {
+      TemplateName: 'Research Assistant'
+    }
+  }
+}
+
 // ========== Managed Identity ========== //
 module managedIdentityModule 'deploy_managed_identity.bicep' = {
   name: 'deploy_managed_identity'
@@ -103,7 +113,7 @@ module keyvaultModule 'deploy_keyvault.bicep' = {
     cogServiceEndpoint:azAIMultiServiceAccount.outputs.cogSearchOutput.cogServiceEndpoint
     cogServiceName:azAIMultiServiceAccount.outputs.cogSearchOutput.cogServiceName
     cogServiceKey:azAIMultiServiceAccount.outputs.cogSearchOutput.cogServiceKey
-    enableSoftDelete:false
+    enableSoftDelete:true
     kvName:'${abbrs.security.keyVault}${solutionPrefix}'
   }
   scope: resourceGroup(resourceGroup().name)

infra/bicep/deploy_keyvault.bicep

@@ -4,8 +4,8 @@
   "metadata": {
     "_generator": {
       "name": "bicep",
-      "version": "0.33.93.31351",
-      "templateHash": "11265523479637142038"
+      "version": "0.36.177.2456",
+      "templateHash": "5350056575239104697"
     }
   },
   "parameters": {
@@ -254,6 +254,16 @@
     "baseUrl": "https://raw.githubusercontent.com/microsoft/Build-your-own-copilot-Solution-Accelerator/byoc-researcher/"
   },
   "resources": [
+    {
+      "type": "Microsoft.Resources/tags",
+      "apiVersion": "2021-04-01",
+      "name": "default",
+      "properties": {
+        "tags": {
+          "TemplateName": "Research Assistant"
+        }
+      }
+    },
     {
       "type": "Microsoft.Resources/deployments",
       "apiVersion": "2022-09-01",
@@ -281,8 +291,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "3549852852043024047"
+              "version": "0.36.177.2456",
+              "templateHash": "5332626978409423867"
             }
           },
           "parameters": {
@@ -375,8 +385,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "8889843082343700750"
+              "version": "0.36.177.2456",
+              "templateHash": "17058490450155567892"
             }
           },
           "parameters": {
@@ -530,8 +540,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "8677612668500685472"
+              "version": "0.36.177.2456",
+              "templateHash": "8150060114150668487"
             }
           },
           "parameters": {
@@ -614,8 +624,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "7933821472451505808"
+              "version": "0.36.177.2456",
+              "templateHash": "9833067354967795959"
             }
           },
           "parameters": {
@@ -704,8 +714,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "2542745894645743448"
+              "version": "0.36.177.2456",
+              "templateHash": "670869423023255449"
             }
           },
           "parameters": {
@@ -770,7 +780,7 @@
               "apiVersion": "2023-05-01",
               "name": "[format('{0}/{1}', parameters('accounts_byc_openai_name'), 'text-embedding-ada-002')]",
               "sku": {
-                "name": "Standard",
+                "name": "GlobalStandard",
                 "capacity": 45
               },
               "properties": {
@@ -834,8 +844,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "11820826519517140279"
+              "version": "0.36.177.2456",
+              "templateHash": "7600099653925911474"
             }
           },
           "parameters": {
@@ -954,7 +964,7 @@
             "value": "[reference(resourceId('Microsoft.Resources/deployments', 'deploy_azure_ai_service'), '2022-09-01').outputs.cogSearchOutput.value.cogServiceKey]"
           },
           "enableSoftDelete": {
-            "value": false
+            "value": true
           },
           "kvName": {
             "value": "[format('{0}{1}', variables('abbrs').security.keyVault, parameters('solutionPrefix'))]"
@@ -966,8 +976,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "11754214044693385671"
+              "version": "0.36.177.2456",
+              "templateHash": "10856957659409783194"
             }
           },
           "parameters": {
@@ -1029,13 +1039,6 @@
                 "description": "Enabled For Template Deployment. Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault."
               }
             },
-            "enablePurgeProtection": {
-              "type": "bool",
-              "defaultValue": true,
-              "metadata": {
-                "description": "Enable Purge Protection. Property specifying whether protection against purge is enabled for this vault."
-              }
-            },
             "enableRBACAuthorization": {
               "type": "bool",
               "defaultValue": true,
@@ -1045,14 +1048,14 @@
             },
             "enableSoftDelete": {
               "type": "bool",
-              "defaultValue": false,
+              "defaultValue": true,
               "metadata": {
                 "description": "Enable Soft Delete. Property to specify whether the \"soft delete\" functionality is enabled for this key vault."
               }
             },
             "softDeleteRetentionInDays": {
               "type": "int",
-              "defaultValue": 30,
+              "defaultValue": 7,
               "metadata": {
                 "description": "Soft Delete Retention in Days. softDelete data retention days. It accepts >=7 and <=90."
               }
@@ -1166,7 +1169,6 @@
                 "enabledForDeployment": "[parameters('enableForDeployment')]",
                 "enabledForDiskEncryption": "[parameters('enableForDiskEncryption')]",
                 "enabledForTemplateDeployment": "[parameters('enableForTemplateDeployment')]",
-                "enablePurgeProtection": "[parameters('enablePurgeProtection')]",
                 "enableRbacAuthorization": "[parameters('enableRBACAuthorization')]",
                 "enableSoftDelete": "[parameters('enableSoftDelete')]",
                 "softDeleteRetentionInDays": "[parameters('softDeleteRetentionInDays')]",
@@ -1428,8 +1430,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "16955379019952955448"
+              "version": "0.36.177.2456",
+              "templateHash": "1868340155585734116"
             }
           },
           "parameters": {
@@ -1517,8 +1519,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "11770710119826170681"
+              "version": "0.36.177.2456",
+              "templateHash": "8680654928688163301"
             }
           },
           "parameters": {
@@ -1733,8 +1735,8 @@
           "metadata": {
             "_generator": {
               "name": "bicep",
-              "version": "0.33.93.31351",
-              "templateHash": "152810904339282293"
+              "version": "0.36.177.2456",
+              "templateHash": "243417282923124605"
             }
           },
           "parameters": {

infra/bicep/main.bicep

@@ -33,7 +33,7 @@ echo "✅ Azure subscription set successfully."
 # Define models and their minimum required capacities
 declare -A MIN_CAPACITY=(
     ["OpenAI.Standard.gpt-35-turbo"]=$GPT_MIN_CAPACITY
-    ["OpenAI.Standard.text-embedding-ada-002"]=$TEXT_EMBEDDING_MIN_CAPACITY
+    ["OpenAI.GlobalStandard.text-embedding-ada-002"]=$TEXT_EMBEDDING_MIN_CAPACITY
 )
 
 VALID_REGION=""