Merge branch 'dev' of https://github.com/microsoft/document-generation-solution-accelerator into rc-aiexisting-project

Author: Ragini-Microsoft

.github/workflows/deploy.yml

@@ -14,8 +14,8 @@ on:
       - cron: '0 9,21 * * *'  # Runs at 9:00 AM and 9:00 PM GMT
 
 env:
-  GPT_MIN_CAPACITY: 250
-  TEXT_EMBEDDING_MIN_CAPACITY: 40
+  GPT_MIN_CAPACITY: 150
+  TEXT_EMBEDDING_MIN_CAPACITY: 80
   BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
 
 jobs:
@@ -148,6 +148,7 @@ jobs:
                 gptDeploymentCapacity=${{ env.GPT_MIN_CAPACITY }} \
                 embeddingModel="text-embedding-ada-002" \
                 embeddingDeploymentCapacity=${{ env.TEXT_EMBEDDING_MIN_CAPACITY }} \
+                aiDeploymentsLocation=${{ env.AZURE_LOCATION }} \
                 imageTag="${IMAGE_TAG}"
 
       - name: Get Deployment Output and extract Values
@@ -169,6 +170,8 @@ jobs:
           echo "COSMOSDB_ACCOUNT_NAME=$COSMOSDB_ACCOUNT_NAME" >> $GITHUB_ENV
           AI_FOUNDRY_NAME=$(echo $BICEP_OUTPUT | jq -r '.aI_FOUNDRY_NAME.value')
           echo "AI_FOUNDRY_NAME=$AI_FOUNDRY_NAME" >> $GITHUB_ENV
+          AI_SEARCH_SERVICE_NAME=$(echo $BICEP_OUTPUT | jq -r '.aI_SEARCH_SERVICE_NAME.value')
+          echo "AI_SEARCH_SERVICE_NAME=$AI_SEARCH_SERVICE_NAME" >> $GITHUB_ENV
           echo "Deployment output: $BICEP_OUTPUT"
 
       - name: Run Post-Deployment Script
@@ -186,6 +189,7 @@ jobs:
             "${{ env.KEY_VAULT_NAME }}" \
             "${{ env.RESOURCE_GROUP_NAME }}" \
             "${{ env.AI_FOUNDRY_NAME }}" \
+            "${{ env.AI_SEARCH_SERVICE_NAME }}" \
             "${{ secrets.AZURE_CLIENT_ID }}"
 
       - name: Logout from Azure

.github/workflows/pylint.yml

@@ -29,5 +29,5 @@ jobs:
       - name: Pylint
         run: |
           echo "Running Pylint..."
-          python -m flake8 --config=.flake8 --verbose .
+          python -m flake8 --config=.flake8 --exclude=tests --verbose .
           

.github/workflows/telemetry-template-check.yml

@@ -0,0 +1,30 @@
+name: validate template property for telemetry
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'azure.yaml'
+
+jobs:
+  validate-template-property:
+    name: validate-template-property
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check for required metadata template line
+        run: |
+          if grep -E '^\s*#\s*template:\s*document-generation@1\.0' azure.yaml; then
+            echo "ERROR: 'template' line is commented out in azure.yaml! Please uncomment template line."
+            exit 1
+          fi
+
+          if ! grep -E '^\s*template:\s*document-generation@1\.0' azure.yaml; then
+            echo "ERROR: Required 'template' line is missing in azure.yaml! Please add template line for telemetry."
+            exit 1
+          fi
+          echo "template line is present and not commented."

azure.yaml

@@ -6,6 +6,9 @@ name: document-generation
 metadata:
   template: [email protected]
 
+requiredVersions:
+  azd: '>= 1.15.0'
+
 parameters:
   solutionPrefix:
     type: string

docs/DeploymentGuide.md

@@ -74,7 +74,7 @@ If you're not using one of the above options for opening the project, then you'l
 
 1. Make sure the following tools are installed:
     - [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.5) <small>(v7.0+)</small> - available for Windows, macOS, and Linux. (Required for Windows users only. Follow the steps [here](./PowershellSetup.md) to add it to the Windows PATH.)
-    - [Azure Developer CLI (azd)](https://aka.ms/install-azd)
+    - [Azure Developer CLI (azd)](https://aka.ms/install-azd) <small>(v1.15.0+)</small> - version
     - [Python 3.9+](https://www.python.org/downloads/)
     - [Docker Desktop](https://www.docker.com/products/docker-desktop/)
     - [Git](https://git-scm.com/downloads)
@@ -175,7 +175,7 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
     ```
     If you don't have azd env then you need to pass parameters along with the command. Then the command will look like the following:
     ```shell 
-    bash ./infra/scripts/process_sample_data.sh <Storage-Account-name> <Storage-Account-container-name> <Key-Vault-name> <CosmosDB-Account-name> <Resource-Group-name> <aiFoundryResourceName>
+    bash ./infra/scripts/process_sample_data.sh <Storage-Account-name> <Storage-Account-container-name> <Key-Vault-name> <CosmosDB-Account-name> <Resource-Group-name> <aiFoundryResourceName> <aiSearchResourceName>
     ```
 
 6. Open the [Azure Portal](https://portal.azure.com/), go to the deployed resource group, find the App Service and get the app URL from `Default domain`.

docs/QuotaCheck.md

@@ -14,11 +14,11 @@ azd auth login
 
 ### 📌 Default Models & Capacities:
 ```
-gpt-4.1:30, text-embedding-ada-002:80, gpt-4:30
+gpt4.1:150, text-embedding-ada-002:80, gpt-4:150
 ```
 ### 📌 Default Regions:
 ```
-eastus, uksouth, eastus2, northcentralus, swedencentral, westus, westus2, southcentralus, canadacentral
+francecentral, australiaeast, uksouth, eastus2, northcentralus, swedencentral, westus, westus2, southcentralus
 ```
 ### Usage Scenarios:
 - No parameters passed → Default models and capacities will be checked in default regions.
@@ -40,19 +40,19 @@ eastus, uksouth, eastus2, northcentralus, swedencentral, westus, westus2, southc
    ```
 ✔️ Check specific model(s) in default regions:
   ```
-  ./quota_check_params.sh --models gpt-4.1:30,text-embedding-ada-002:80
+  ./quota_check_params.sh --models gpt4.1:150,text-embedding-ada-002:80
   ```
 ✔️ Check default models in specific region(s):
   ```
-./quota_check_params.sh --regions eastus,westus
+./quota_check_params.sh --regions eastus2,westus
   ```
 ✔️ Passing Both models and regions:  
   ```
-  ./quota_check_params.sh --models gpt-4.1:30 --regions eastus,westus2
+  ./quota_check_params.sh --models gpt4.1:150 --regions eastus2,westus2
   ```
 ✔️ All parameters combined:
   ```
- ./quota_check_params.sh --models gpt-4:30,text-embedding-ada-002:80 --regions eastus,westus --verbose
+ ./quota_check_params.sh --models gpt-4:150,text-embedding-ada-002:80 --regions eastus2,westus --verbose
   ```
 
 ### **Sample Output**

docs/README_LOCAL.md

@@ -32,7 +32,6 @@ NOTE: You may find you need to set: MacOS: `export NODE_OPTIONS="--max-old-space
     - `DATASOURCE_TYPE` (should be set to `AzureCognitiveSearch`)
     - `AZURE_SEARCH_SERVICE`
     - `AZURE_SEARCH_INDEX`
-    - `AZURE_SEARCH_KEY`
 
     These variables are optional:
     - `AZURE_SEARCH_USE_SEMANTIC_SEARCH`
@@ -178,7 +177,6 @@ Note: settings starting with `AZURE_SEARCH` are only needed when using Azure Ope
 |AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME||The name of the gpt model|
 |AZURE_SEARCH_SERVICE||The name of your Azure AI Search resource|
 |AZURE_SEARCH_INDEX||The name of your Azure AI Search Index|
-|AZURE_SEARCH_KEY||An **admin key** for your Azure AI Search resource|
 |AZURE_SEARCH_USE_SEMANTIC_SEARCH|False|Whether or not to use semantic search|
 |AZURE_SEARCH_QUERY_TYPE|simple|Query type: simple, semantic, vector, vectorSimpleHybrid, or vectorSemanticHybrid. Takes precedence over AZURE_SEARCH_USE_SEMANTIC_SEARCH|
 |AZURE_SEARCH_SEMANTIC_SEARCH_CONFIG||The name of the semantic search configuration to use if using semantic search.|
@@ -212,7 +210,6 @@ Note: settings starting with `AZURE_SEARCH` are only needed when using Azure Ope
 |UI_SHOW_SHARE_BUTTON|True|Share button (right-top)
 |SANITIZE_ANSWER|False|Whether to sanitize the answer from Azure OpenAI. Set to True to remove any HTML tags from the response.|
 |USE_PROMPTFLOW|False|Use existing Promptflow deployed endpoint. If set to `True` then both `PROMPTFLOW_ENDPOINT` and `PROMPTFLOW_API_KEY` also need to be set.|
-|USE_AI_FOUNDRY_SDK|False|Boolean flag to determine whether to use the AI Foundry SDK instead of the OpenAI SDK.|
 |PROMPTFLOW_ENDPOINT||URL of the deployed Promptflow endpoint e.g. https://pf-deployment-name.region.inference.ml.azure.com/score|
 |PROMPTFLOW_API_KEY||Auth key for deployed Promptflow endpoint. Note: only Key-based authentication is supported.|
 |PROMPTFLOW_RESPONSE_TIMEOUT|120|Timeout value in seconds for the Promptflow endpoint to respond.|

infra/deploy_ai_foundry.bicep

@@ -24,6 +24,7 @@ var aiProjectFriendlyName = aiProjectName
 var aiProjectDescription = 'AI Foundry Project'
 var aiSearchName = '${abbrs.ai.aiSearch}${solutionName}'
 var workspaceName = '${abbrs.managementGovernance.logAnalyticsWorkspace}${solutionName}'
+// var aiSearchConnectionName = 'myVectorStoreProjectConnectionName-${solutionName}'
 
 var useExisting = !empty(existingLogAnalyticsWorkspaceId)
 var existingLawSubscription = useExisting ? split(existingLogAnalyticsWorkspaceId, '/')[2] : ''
@@ -148,49 +149,50 @@ resource aiFoundryProject 'Microsoft.CognitiveServices/accounts/projects@2025-04
 }
 
 @batchSize(1)
-resource aiFModelDeployments 'Microsoft.CognitiveServices/accounts/deployments@2025-04-01-preview' = [for aiModeldeployment in aiModelDeployments: if (empty(azureExistingAIProjectResourceId))   {
-  parent: aiFoundry
-  name: aiModeldeployment.name
-  properties: {
-    model: {
-      format: 'OpenAI'
-      name: aiModeldeployment.model
+resource aiFModelDeployments 'Microsoft.CognitiveServices/accounts/deployments@2025-04-01-preview' = [
+  for aiModeldeployment in aiModelDeployments: if (empty(azureExistingAIProjectResourceId))   {
+    parent: aiFoundry
+    name: aiModeldeployment.name
+    properties: {
+      model: {
+        format: 'OpenAI'
+        name: aiModeldeployment.model
+      }
+      raiPolicyName: aiModeldeployment.raiPolicyName
+    }
+    sku: {
+      name: aiModeldeployment.sku.name
+      capacity: aiModeldeployment.sku.capacity
     }
-    raiPolicyName: aiModeldeployment.raiPolicyName
-  }
-  sku:{
-    name: aiModeldeployment.sku.name
-    capacity: aiModeldeployment.sku.capacity
   }
-}]
+]
 
 resource aiSearch 'Microsoft.Search/searchServices@2024-06-01-preview' = {
-    name: aiSearchName
-    location: solutionLocation
-    sku: {
-      name: 'basic'
+  name: aiSearchName
+  location: solutionLocation
+  sku: {
+    name: 'basic'
+  }
+  identity: {
+    type: 'SystemAssigned'
+  }
+  properties: {
+    replicaCount: 1
+    partitionCount: 1
+    hostingMode: 'default'
+    publicNetworkAccess: 'enabled'
+    networkRuleSet: {
+      ipRules: []
     }
-    properties: {
-      replicaCount: 1
-      partitionCount: 1
-      hostingMode: 'default'
-      publicNetworkAccess: 'enabled'
-      networkRuleSet: {
-        ipRules: []
-      }
-      encryptionWithCmk: {
-        enforcement: 'Unspecified'
-      }
-      disableLocalAuth: false
-      authOptions: {
-        apiKeyOnly: {}
-      }
-      semanticSearch: 'free'
+    encryptionWithCmk: {
+      enforcement: 'Unspecified'
     }
+    disableLocalAuth: true
+    semanticSearch: 'free'
   }
+}
 
 resource aiSearchFoundryConnection 'Microsoft.CognitiveServices/accounts/projects/connections@2025-04-01-preview' = if (empty(azureExistingAIProjectResourceId))   {
-  // name: 'foundry-search-connection'
   name: aiSearchConnectionName
   parent: aiFoundryProject
   properties: {
@@ -308,7 +310,7 @@ resource azureOpenAIApiVersionEntry 'Microsoft.KeyVault/vaults/secrets@2021-11-0
   parent: keyVault
   name: 'AZURE-OPENAI-PREVIEW-API-VERSION'
   properties: {
-    value: azureOpenaiAPIVersion  //'2024-02-15-preview'
+    value: azureOpenaiAPIVersion //'2024-02-15-preview'
   }
 }
 
@@ -322,12 +324,11 @@ resource azureOpenAIEndpointEntry 'Microsoft.KeyVault/vaults/secrets@2021-11-01-
   }
   }
 
-
-resource azureSearchAdminKeyEntry 'Microsoft.KeyVault/vaults/secrets@2021-11-01-preview' = {
+resource azureOpenAIEmbeddingDeploymentModel 'Microsoft.KeyVault/vaults/secrets@2021-11-01-preview' = {
   parent: keyVault
-  name: 'AZURE-SEARCH-KEY'
+  name: 'AZURE-OPENAI-EMBEDDING-MODEL'
   properties: {
-    value: aiSearch.listAdminKeys().primaryKey
+    value: embeddingModel
   }
 }
 
@@ -414,6 +415,7 @@ output aiSearchName string = aiSearchName
 output aiSearchId string = aiSearch.id
 output aiSearchTarget string = 'https://${aiSearch.name}.search.windows.net'
 output aiSearchService string = aiSearch.name
+output aiSearchConnectionName string = aiSearchConnectionName
 output aiFoundryProjectName string = !empty(existingAIProjectName) ? existingAIProjectName : aiFoundryProject.name
 // output aiFoundryProjectEndpoint string = aiFoundryProject.properties.endpoints['AI Foundry API']
 output aiFoundryProjectEndpoint string = !empty(existingProjEndpoint)