Merge branch 'main' into smoke-test-automation

Author: Vamshi-Microsoft

.github/workflows/broken-links-checker.yml

@@ -37,7 +37,7 @@ jobs:
         uses: lycheeverse/lychee-action@v2.6.1
         with:
           args: >
-            --verbose --exclude-mail --no-progress --exclude ^https?://
+            --verbose --no-progress --exclude ^https?://
             ${{ steps.changed-markdown-files.outputs.all_changed_files }}
           failIfEmpty: false
         env:
@@ -50,7 +50,7 @@ jobs:
         uses: lycheeverse/lychee-action@v2.6.1
         with:
           args: >
-            --verbose --exclude-mail --no-progress --exclude ^https?://
+            --verbose --no-progress --exclude ^https?://
             '**/*.md'
           failIfEmpty: false
         env:

docs/DeploymentGuide.md

@@ -62,7 +62,7 @@ You can run this solution using [GitHub Codespaces](https://docs.github.com/en/c
 </details>
 
 <details>
-  <summary><b>Deploy in VS Code</b></summary>
+  <summary><b>Deploy in VS Code Dev Containers</b></summary>
 
 ### VS Code Dev Containers
 
@@ -110,22 +110,7 @@ Consider the following settings during your deployment to modify specific settin
 <details>
   <summary><b>Configurable Deployment Settings</b></summary>
 
-When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md):
-
-| **Setting**                                 | **Description**                                                                             | **Default Value** |
-| ------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------- |
-| **Azure Region**                            | The region where resources will be created.                                                 | East US           |
-| **Azure AI Content Understanding Location** | Location for the **Content Understanding** service.                                         | Sweden Central    |
-| **Secondary Location**                      | A **less busy** region for **Azure Cosmos DB**, useful in case of availability constraints. | eastus2           |
-| **Deployment Type**                         | Select from a drop-down list.                                                               | GlobalStandard    |
-| **GPT Model**                               | Choose from **gpt-4o**.                                                                     | gpt-4o            |
-| **GPT Model Version**                       | GPT model version used in the deployment.                                                   | 2024-08-06        |
-| **GPT Model Deployment Capacity**           | Configure capacity for **GPT models**.                                                      | 30k               |
-| **Use Local Build**                         | Boolean flag to determine if local container builds should be used.                         | false             |
-| **Image Tag**                               | Image version for deployment (allowed values: `latest`, `dev`, `hotfix`).                   | latest            |
-| **Existing Log Analytics Workspace**        | To reuse an existing Log Analytics Workspace ID instead of creating a new one.              | *(none)*          |
-| **Existing Azure AI Foundry Project**        | To reuse an existing Azure AI Foundry Project ID instead of creating a new one.              | *(none)*          |
-
+When you start the deployment, most parameters will have **default values**, but you can update the following settings by following the steps [here](../docs/CustomizingAzdParameters.md)
 
 </details>
 
@@ -213,12 +198,14 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
    - **Linux/macOS**:
      ```bash
      cd ./infra/scripts/
+
      ./docker-build.sh
      ```
 
    - **Windows (PowerShell)**:
      ```powershell
      cd .\infra\scripts\
+
      .\docker-build.ps1
      ```
 
@@ -239,19 +226,35 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
     - **Execute Script to registering Schemas**
         - Move the folder to samples/schemas in ContentProcessorApi - [/src/ContentProcessorApi/samples/schemas](/src/ContentProcessorApi/samples/schemas)  
 
-          Bash
+        
+          Git Bash
+
+          ```bash
+          cd src/ContentProcessorAPI/samples/schemas
+          ```  
+
+          Powershell
+
+          ```Powershell
+          cd .\src\ContentProcessorAPI\samples\schemas\
+          ```  
+
+        - Then use below command
+
+          Git Bash
 
           ```bash
           ./register_schema.sh https://<< API Service Endpoint>>/schemavault/ schema_info_sh.json
           ```  
 
-          Windows
+          Powershell
 
           ```Powershell
           ./register_schema.ps1 https://<< API Service Endpoint>>/schemavault/ .\schema_info_ps1.json
           ```  
 
     - **Verify Results**
+    
         ![schema file registration](./images/SchemaFileRegistration.png)  
 
 3. **Import Sample Data**  
@@ -285,9 +288,13 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
 4. **Deleting Resources After a Failed Deployment**  
 
      - Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.
+  
+## Running the application
+
+To help you get started, here's the [Sample Workflow](./SampleWorkflow.md) you can follow to try it out.
 
 ## Environment configuration for local development & debugging
-**Creatign env file**
+**Creating env file**
 
 > Navigate to the `src` folder of the project.
 

docs/SampleWorkflow.md

@@ -0,0 +1,43 @@
+
+# Sample Workflow
+
+To help you get started, here’s a **sample process** you can follow in the app.
+
+## **Process**
+
+> Note: Download sample data files for **Invoices** and **Property Claims** from [here](../src/ContentProcessorAPI/samples).
+
+### **API Documentation**
+
+- Click on **API Documentation** to view and explore the available API endpoints and their details.
+
+### **Upload**
+
+  > Note: Average response time is 01 minute.
+
+_Sample Operations:_
+
+- Select the **Schema** under the Processing Queue pane.
+- Click on the **Import Content** button.
+- Choose a file from the downloaded list for data extraction corresponding to the **Schema** selected.
+- Click the **Upload** button.
+
+### **Review and Process**
+
+_Sample Operation:_
+
+- Once the file status is marked as completed, click on the file.
+- Once the batch processing is done, the file is ready to review and the extracted data is displayed in the **Output Review** pane and corresponding file is visible in the **Source Document** pane.
+- Edit any incorrect data in the JSON which is shown in the **Output Review** pane under **Extracted Results** tab.
+- Add notes under the **Comments** and save the changes by clicking on the **Save** button.
+- You can view the process steps in the **Output Review** pane under the **Process Steps** tab and expand the extract, Map, and evaluate sections to see the outputs from each process step.
+
+ ![Application](images/sampleworkflow1.png)
+  
+### **Delete**
+
+_Sample operation:_
+
+- Click the **three-dot menu** at the end of the row to expand options, then select **Delete** to remove the item.
+  
+This structured approach ensures that users can efficiently extract key information, and organize structured outputs for easy search and analysis.

docs/images/sampleworkflow1.png

@@ -5,7 +5,9 @@ metadata name = 'Content Processing Solution Accelerator'
 metadata description = 'Bicep template to deploy the Content Processing Solution Accelerator with AVM compliance.'
 
 // ========== Parameters ========== //
-@description('Required. Name of the solution to deploy.')
+@minLength(3)
+@maxLength(20)
+@description('Required. Name of the solution to deploy. This should be 3-20 characters long.')
 param solutionName string = 'cps'
 @description('Optional. Location for all Resources.')
 param location string = resourceGroup().location

infra/main.bicep

@@ -6,7 +6,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.37.4.10188",
-      "templateHash": "14310770063360835011"
+      "templateHash": "11985360537269850534"
     },
     "name": "Content Processing Solution Accelerator",
     "description": "Bicep template to deploy the Content Processing Solution Accelerator with AVM compliance."
@@ -15,8 +15,10 @@
     "solutionName": {
       "type": "string",
       "defaultValue": "cps",
+      "minLength": 3,
+      "maxLength": 20,
       "metadata": {
-        "description": "Required. Name of the solution to deploy."
+        "description": "Required. Name of the solution to deploy. This should be 3-20 characters long:"
       }
     },
     "location": {
@@ -32964,8 +32966,8 @@
         "avmContainerApp",
         "avmContainerApp_API",
         "avmManagedIdentity",
-        "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').storageBlob)]",
         "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').storageQueue)]",
+        "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').storageBlob)]",
         "virtualNetwork"
       ]
     },
@@ -38706,10 +38708,10 @@
       "dependsOn": [
         "avmContainerApp",
         "avmManagedIdentity",
-        "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').aiServices)]",
         "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').contentUnderstanding)]",
         "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').openAI)]",
         "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').cognitiveServices)]",
+        "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').aiServices)]",
         "logAnalyticsWorkspace",
         "virtualNetwork"
       ]
@@ -41049,6 +41051,7 @@
         "avmManagedIdentity",
         "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').contentUnderstanding)]",
         "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').cognitiveServices)]",
+        "[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').cognitiveServices)]",
         "virtualNetwork"
       ]
     },