diff --git a/docs/DeploymentGuide.md b/docs/DeploymentGuide.md index ba4584a4..c57f2f0b 100644 --- a/docs/DeploymentGuide.md +++ b/docs/DeploymentGuide.md @@ -288,6 +288,10 @@ 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 **Creating env file** diff --git a/docs/SampleWorkflow.md b/docs/SampleWorkflow.md new file mode 100644 index 00000000..d31c7e63 --- /dev/null +++ b/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. diff --git a/docs/images/sampleworkflow1.png b/docs/images/sampleworkflow1.png new file mode 100644 index 00000000..1a3d851f Binary files /dev/null and b/docs/images/sampleworkflow1.png differ diff --git a/infra/main.bicep b/infra/main.bicep index 33bf049f..1b329d0a 100644 --- a/infra/main.bicep +++ b/infra/main.bicep @@ -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 diff --git a/infra/main.json b/infra/main.json index e8202bd8..1fd836ac 100644 --- a/infra/main.json +++ b/infra/main.json @@ -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" ] },