Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator into psl-pk-aiagentPlugin

Author: Pavan-Microsoft

.devcontainer/devcontainer.json

@@ -16,7 +16,7 @@
             ]
         }
     },
-    "postStartCommand": "git pull origin main && 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 && curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash && chmod +x ./infra/scripts/quota_check_params.sh",
     "remoteUser": "vscode",
     "hostRequirements": {
         "memory": "4gb"

.github/dependabot.yml

@@ -11,7 +11,7 @@ updates:
    open-pull-requests-limit: 100
 
  - package-ecosystem: "pip"
-   directory: "/App"
+   directory: "/src/api"
    schedule:
      interval: "monthly"
    commit-message:
@@ -20,7 +20,7 @@ updates:
    open-pull-requests-limit: 100
 
  - package-ecosystem: "npm"
-   directory: "/App/frontend"
+   directory: "/src/App"
    schedule:
      interval: "monthly"
    commit-message:

.github/workflows/create-release.yml

@@ -0,0 +1,66 @@
+name: "Create Release"
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ github.sha }}
+
+    - uses: codfish/semantic-release-action@v3
+      id: semantic
+      with:
+        tag-format: 'v${version}'
+        additional-packages: |
+          ['conventional-changelog-conventionalcommits@7']
+        plugins: |
+          [
+            [
+              "@semantic-release/commit-analyzer",
+              {
+                "preset": "conventionalcommits"
+              }
+            ],
+            [
+              "@semantic-release/release-notes-generator",
+              {
+                "preset": "conventionalcommits",
+                "presetConfig": {
+                  "types": [
+                    { type: 'feat', section: 'Features', hidden: false },
+                    { type: 'fix', section: 'Bug Fixes', hidden: false },
+                    { type: 'perf', section: 'Performance Improvements', hidden: false },
+                    { type: 'revert', section: 'Reverts', hidden: false },
+                    { type: 'docs', section: 'Other Updates', hidden: false },
+                    { type: 'style', section: 'Other Updates', hidden: false },
+                    { type: 'chore', section: 'Other Updates', hidden: false },
+                    { type: 'refactor', section: 'Other Updates', hidden: false },
+                    { type: 'test', section: 'Other Updates', hidden: false },
+                    { type: 'build', section: 'Other Updates', hidden: false },
+                    { type: 'ci', section: 'Other Updates', hidden: false }
+                  ]
+                }
+              }
+            ],
+            '@semantic-release/github'
+          ]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - run: echo ${{ steps.semantic.outputs.release-version }}
+
+    - run: echo "$OUTPUTS"
+      env:
+        OUTPUTS: ${{ toJson(steps.semantic.outputs) }}

README.md

@@ -135,6 +135,7 @@ If you're not using one of the above options for opening the project, then you'l
     * [Python 3.9+](https://www.python.org/downloads/)
     * [Docker Desktop](https://www.docker.com/products/docker-desktop/)
     * [Git](https://git-scm.com/downloads)
+    * [Powershell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5)<br/>Required for Windows users only. Follow the steps [here](./docs/PowershellSetup.md) to add it to the Windows PATH.
 
 2. Download the project code:
 

docs/Images/git_bash.png

@@ -0,0 +1,54 @@
+# Add PowerShell 7 to PATH in Windows
+
+This guide will help you add **PowerShell 7** (PowerShell Core) to your system’s PATH variable on Windows, so you can easily run it from any Command Prompt or Run dialog.
+
+## Prerequisites
+
+- You should have **PowerShell 7** installed on your machine. If you haven’t installed it yet, you can download it following the guide here: [Installing PowerShell on Windows | Microsoft Learn](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5).
+- **Administrative privileges are not required** unless you're modifying system-wide environment variables. You can modify your **user-specific PATH** without admin rights.
+
+## Steps to Add PowerShell 7 to PATH
+
+### 1. Open **System Properties**
+   - Press `Win + X` and choose **System**.
+   - Click on **Advanced system settings** on the left sidebar. This will open the **System Properties** window.
+   - In the **System Properties** window, click on the **Environment Variables** button at the bottom.
+
+### 2. Edit User Environment Variables
+   - In the **Environment Variables** window, under **User variables**, find the `Path` variable.
+   - Select the `Path` variable and click **Edit**. (If the `Path` variable doesn’t exist, click **New** and name it `Path`.)
+
+### 3. Check if PowerShell 7 Path is Already in PATH
+   - Before adding the path, make sure the following path is not already present in the list:
+     ```
+     C:\Program Files\PowerShell\7\
+     ```
+   - If the path is already there, you don't need to add it again.
+
+### 4. Add PowerShell 7 Path
+   - If the path is not already in the list, click **New** in the **Edit Environment Variable** window.
+   - Add the following path to the list:
+
+     ```
+     C:\Program Files\PowerShell\7\
+     ```
+
+   > **Note:** If you installed PowerShell 7 in a custom location, replace the above path with the correct one.
+
+### 5. Save Changes
+   - After adding the path, click **OK** to close the **Edit Environment Variable** window.
+   - Click **OK** again to close the **Environment Variables** window.
+   - Finally, click **OK** to exit the **System Properties** window.
+
+### 6. Verify PowerShell 7 in PATH
+   - Open **Command Prompt** or **Run** (press `Win + R`).
+   - Type `pwsh` and press Enter.
+   - If PowerShell 7 opens, you've successfully added it to your PATH!
+
+---
+
+## Troubleshooting
+
+- **PowerShell 7 not opening:** Ensure the path to PowerShell 7 is entered correctly. If you're using a custom installation folder, check that the correct path is added to the `Path` variable.
+
+- **Changes not taking effect:** Try restarting your computer or logging out and logging back in for the changes to apply.

docs/Images/quota-check-output.png

@@ -1,57 +1,105 @@
 ## Check Quota Availability Before Deployment
 
-Before deploying the accelerator, **ensure sufficient quota availability** for the required model.  
-Use one of the following scripts based on your needs:  
+Before deploying the accelerator, **ensure sufficient quota availability** for the required model.
+> **We recommend increasing the capacity to 100k tokens for optimal performance.**
 
-- **`quota_check_params.sh`** → If you **know the model and capacity** required.  
-- **`quota_check_all_regions.sh`** → If you **want to check available capacity across all regions** for supported models.  
+### Login if you have not done so already
+```
+azd auth login
+```
+
+
+### Login if you have not done so already
+```
+azd auth login
+```
+
+### 📌 Default Models & Capacities:
+```
+gpt-4o:30, gpt-4o-mini:30, gpt-4:30, text-embedding-ada-002:80
+```
+### 📌 Default Regions:
+```
+eastus, uksouth, eastus2, northcentralus, swedencentral, westus, westus2, southcentralus, canadacentral
+```
+### 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-4o:30,text-embedding-ada-002:80
+  ```
+✔️ 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-4o:30 --regions eastus,westus2
+  ```
+✔️ All parameters combined:
+  ```
+ ./quota_check_params.sh --models gpt-4:30,text-embedding-ada-002:80 --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/quota-check-output.png)
 
 ---
-## **If using Azure Portal and Cloud Shell**
+### **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 a specific model and capacity:**  
+   **To check quota for the deployment**  
 
     ```sh
     curl -L -o quota_check_params.sh "https://raw.githubusercontent.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator/main/infra/scripts/quota_check_params.sh"
     chmod +x quota_check_params.sh
-    ./quota_check_params.sh <model_name:capacity> [<model_region>] (e.g., gpt-4o-mini:30,text-embedding-ada-002:20 eastus)
+    ./quota_check_params.sh
     ```
-
-   **To check available quota across all regions for supported models:**  
-
-    ```sh
-    curl -L -o quota_check_all_regions.sh "https://raw.githubusercontent.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator/main/infra/scripts/quota_check_all_regions.sh"
-    chmod +x quota_check_all_regions.sh
-    ./quota_check_all_regions.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
     ```
-    
-## **If using VS Code or Codespaces**
-
-1. Run the appropriate script based on your requirement:  
+4. Run the appropriate script based on your requirement:  
 
-   **To check quota for a specific model and capacity:**  
+   **To check quota for the deployment**  
 
     ```sh
-    ./quota_check_params.sh <model_name:capacity> [<model_region>] (e.g., gpt-4o-mini:30,text-embedding-ada-002:20 eastus)
+    ./quota_check_params.sh
     ```
+   - Refer to [Input Formats](#input-formats) for detailed commands.
 
-   **To check available quota across all regions for supported models:**  
-
-    ```sh
-    ./quota_check_all_regions.sh
-    ```
-2. If you see the error `_bash: az: command not found_`, install Azure CLI:  
+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
     ```
-3. Rerun the script after installing Azure CLI.
-   
-    **Parameters**
-    - `<model_name:capacity>`: The name and required capacity for each model, in the format model_name:capacity (**e.g., gpt-4o-mini:30,text-embedding-ada-002:20**).
-    - `[<model_region>] (optional)`: The Azure region to check first. If not provided, all supported regions will be checked (**e.g., eastus**).
+6. Rerun the script after installing Azure CLI.

docs/PowershellSetup.md

@@ -32,8 +32,8 @@ echo "✅ Azure subscription set successfully."
 
 # Define models and their minimum required capacities
 declare -A MIN_CAPACITY=(
-    ["OpenAI.Standard.gpt-4o-mini"]=$GPT_MIN_CAPACITY #km generic
-    ["OpenAI.Standard.text-embedding-ada-002"]=$TEXT_EMBEDDING_MIN_CAPACITY #km generic
+    ["OpenAI.GlobalStandard.gpt-4o-mini"]=$GPT_MIN_CAPACITY #km generic
+    ["OpenAI.GlobalStandard.text-embedding-ada-002"]=$TEXT_EMBEDDING_MIN_CAPACITY #km generic
 )
 
 VALID_REGION=""