fix: Merge pull request #252 from microsoft/dev

fix: Documentation and Configuration Settings

Author: Avijit-Microsoft

.devcontainer/devcontainer.json

@@ -16,9 +16,9 @@
             ]
         }
     },
-    "postCreateCommand": "python3 -m pip install -r infra/scripts/index_scripts/requirements.txt",
+    "postStartCommand": "git pull origin main && python3 -m pip install -r infra/scripts/index_scripts/requirements.txt",
     "remoteUser": "vscode",
     "hostRequirements": {
-        "memory": "8gb"
+        "memory": "4gb"
     }
 }

README.md

@@ -54,7 +54,7 @@ Please check the link [Azure Products by Region](https://azure.microsoft.com/en-
 
 -  Azure region where the resources will be created in
 
--  Environment name, a 3-10 characters alphanumeric value that will be used to prefix resources
+-  Environment name, a 3-20 characters alphanumeric value that will be used to prefix resources
 
 -  Content Understanding location from the drop-down list of values
 
@@ -70,6 +70,22 @@ Please check the link [Azure Products by Region](https://azure.microsoft.com/en-
 
 -  Embedding model capacity
 
+
+### Checking Resource Availability by Region
+
+Before deploying, ensure that the required Azure services are available in your region. Below are links to check service availability:
+
+- [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/)
+- [Semantic Search Availability](https://learn.microsoft.com/en-us/azure/search/search-region-support)
+
+    ## **Steps to Check Semantic Search Availability**
+    1. Open the [Semantic Search Availability](https://learn.microsoft.com/en-us/azure/search/search-region-support) page.
+    2. Scroll down to the **"Availability by Region"** section.
+    3. Use the table to find supported regions for **Azure AI Search** and its **Semantic Search** feature.
+    4. If your target region is not listed, choose a supported region for deployment.
+
+📌 **Note:** Some features may only be available in specific regions, so ensure compatibility before proceeding.
+
 ### [Optional]: Quota Recommendations
 - The default for the GPT model capacity in deployment is **30k tokens**.
     - For optimal performance, it is recommended to increase to **100k tokens**. 
@@ -183,12 +199,12 @@ You can view the permissions for your account and subscription by following the
 By default this template will use the environment name as the prefix to prevent naming collisions within Azure. The parameters below show the default values. You only need to run the statements below if you need to change the values. 
 
 
-> To override any of the parameters, run `azd env set <key> <value>` before running `azd up`. On the first azd command, it will prompt you for the environment name. Be sure to choose 3-10 charaters alphanumeric unique name. 
+> To override any of the parameters, run `azd env set <key> <value>` before running `azd up`. On the first azd command, it will prompt you for the environment name. Be sure to choose 3-20 charaters alphanumeric unique name. 
 
 Change the Content Understanding Location (allowed values: West US, Sweden Central, Australia East)
 
 ```shell
-azd env set AZURE_ENV_CU_LOCATION 'West US'
+azd env set AZURE_ENV_CU_LOCATION 'westus'
 ```
 
 Change the Secondary Location (example: eastus2, westus2, etc.)
@@ -235,6 +251,12 @@ azd env set AZURE_ENV_EMBEDDING_MODEL_CAPACITY 80
     azd auth login
     ```
 
+    #### To authenticate with Azure Developer CLI (`azd`), use the following command with your **Tenant ID**:
+
+    ```sh
+    azd auth login --tenant-id <tenant-id>
+
+
 2. Provision and deploy all the resources:
 
     ```shell
@@ -286,6 +308,21 @@ Additional Steps
 
     Note: Authentication changes can take up to 10 minutes 
 
+3. **Deleting Resources After a Failed Deployment**
+     Follow steps in [Delete Resource Group](./docs/DeleteResourceGroup.md) If your deployment fails and you need to clean up the resources.
+
+## Sample Questions
+
+To help you get started, here are some **Sample Questions** you can ask in the app:
+
+- Total number of calls by date for the last 7 days
+- Show average handling time by topics in minutes
+- What are the top 7 challenges users reported?
+- Give a summary of billing issues
+- When customers call in about unexpected charges, what types of charges are they seeing?
+
+These questions serve as a great starting point to explore insights from the data.
+</br>
 <h2>
 </br>
 Responsible AI Transparency FAQ 

azure.yaml

@@ -27,7 +27,22 @@ deployment:
     otherLocation: ${parameters.otherLocation}
     baseUrl: ${parameters.baseUrl}
 
-
+hooks:
+  postprovision:
+    windows:
+      run: |
+        Write-Host "Web app URL: "
+        Write-Host "$env:WEB_APP_URL" -ForegroundColor Cyan
+      shell: pwsh
+      continueOnError: false
+      interactive: true
+    posix:
+      run: |
+        echo "Web app URL: "
+        echo $WEB_APP_URL
+      shell: sh
+      continueOnError: false
+      interactive: true
 # environment:
 #   name: conversation-knowledge-mining-solution-accelerator
 #   location: eastus

docs/DeleteResourceGroup.md

@@ -0,0 +1,53 @@
+# Deleting Resources After a Failed Deployment in Azure Portal
+
+If your deployment fails and you need to clean up the resources manually, follow these steps in the Azure Portal.
+
+---
+
+## **1. Navigate to the Azure Portal**
+1. Open [Azure Portal](https://portal.azure.com/).
+2. Sign in with your Azure account.
+
+---
+
+## **2. Find the Resource Group**
+1. In the search bar at the top, type **"Resource groups"** and select it.
+2. Locate the **resource group** associated with the failed deployment.
+
+![Resource Groups](Images/resourcegroup.png)
+
+![Resource Groups](Images/resource-groups.png)
+
+---
+
+## **3. Delete the Resource Group**
+1. Click on the **resource group name** to open it.
+2. Click the **Delete resource group** button at the top.
+
+![Delete Resource Group](Images/DeleteRG.png)
+
+3. Type the resource group name in the confirmation box and click **Delete**.
+
+📌 **Note:** Deleting a resource group will remove all resources inside it.
+
+---
+
+## **4. Delete Individual Resources (If Needed)**
+If you don’t want to delete the entire resource group, follow these steps:
+
+1. Open **Azure Portal** and go to the **Resource groups** section.
+2. Click on the specific **resource group**.
+3. Select the **resource** you want to delete (e.g., App Service, Storage Account).
+4. Click **Delete** at the top.
+
+![Delete Individual Resource](Images/deleteservices.png)
+
+---
+
+## **5. Verify Deletion**
+- After a few minutes, refresh the **Resource groups** page.
+- Ensure the deleted resource or group no longer appears.
+
+📌 **Tip:** If a resource fails to delete, check if it's **locked** under the **Locks** section and remove the lock.
+
+

docs/Images/DeleteRG.png

@@ -80,7 +80,7 @@ resource containerRegistry 'Microsoft.ContainerRegistry/registries@2021-09-01' =
     name: 'Premium'
   }
   properties: {
-    adminUserEnabled: true
+    adminUserEnabled: false
     dataEndpointEnabled: false
     networkRuleBypassOptions: 'AzureServices'
     networkRuleSet: {

docs/Images/deleteservices.png

@@ -39,7 +39,7 @@ resource cosmos 'Microsoft.DocumentDB/databaseAccounts@2022-08-15' = {
     databaseAccountOfferType: 'Standard'
     enableAutomaticFailover: false
     enableMultipleWriteLocations: false
-    disableLocalAuth: false
+    disableLocalAuth: true
     apiProperties: (kind == 'MongoDB') ? { serverVersion: '4.0' } : {}
     capabilities: [ { name: 'EnableServerless' } ]
   }