Skip to content

Commit 1e3269f

Browse files
Merge pull request #310 from microsoft/dev
fix: merge from dev to main
2 parents cb0ec7c + 0aff3eb commit 1e3269f

File tree

5 files changed

+57
-5
lines changed

5 files changed

+57
-5
lines changed

docs/DeploymentGuide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,10 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
288288
4. **Deleting Resources After a Failed Deployment**
289289
290290
- Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.
291+
292+
## Running the application
293+
294+
To help you get started, here's the [Sample Workflow](./SampleWorkflow.md) you can follow to try it out.
291295
292296
## Environment configuration for local development & debugging
293297
**Creating env file**

docs/SampleWorkflow.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
# Sample Workflow
3+
4+
To help you get started, here’s a **sample process** you can follow in the app.
5+
6+
## **Process**
7+
8+
> Note: Download sample data files for **Invoices** and **Property Claims** from [here](../src/ContentProcessorAPI/samples).
9+
10+
### **API Documentation**
11+
12+
- Click on **API Documentation** to view and explore the available API endpoints and their details.
13+
14+
### **Upload**
15+
16+
> Note: Average response time is 01 minute.
17+
18+
_Sample Operations:_
19+
20+
- Select the **Schema** under the Processing Queue pane.
21+
- Click on the **Import Content** button.
22+
- Choose a file from the downloaded list for data extraction corresponding to the **Schema** selected.
23+
- Click the **Upload** button.
24+
25+
### **Review and Process**
26+
27+
_Sample Operation:_
28+
29+
- Once the file status is marked as completed, click on the file.
30+
- 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.
31+
- Edit any incorrect data in the JSON which is shown in the **Output Review** pane under **Extracted Results** tab.
32+
- Add notes under the **Comments** and save the changes by clicking on the **Save** button.
33+
- 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.
34+
35+
![Application](images/sampleworkflow1.png)
36+
37+
### **Delete**
38+
39+
_Sample operation:_
40+
41+
- Click the **three-dot menu** at the end of the row to expand options, then select **Delete** to remove the item.
42+
43+
This structured approach ensures that users can efficiently extract key information, and organize structured outputs for easy search and analysis.

docs/images/sampleworkflow1.png

238 KB
Loading

infra/main.bicep

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ metadata name = 'Content Processing Solution Accelerator'
55
metadata description = 'Bicep template to deploy the Content Processing Solution Accelerator with AVM compliance.'
66

77
// ========== Parameters ========== //
8-
@description('Required. Name of the solution to deploy.')
8+
@minLength(3)
9+
@maxLength(20)
10+
@description('Required. Name of the solution to deploy. This should be 3-20 characters long.')
911
param solutionName string = 'cps'
1012
@description('Optional. Location for all Resources.')
1113
param location string = resourceGroup().location

infra/main.json

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"_generator": {
77
"name": "bicep",
88
"version": "0.37.4.10188",
9-
"templateHash": "14310770063360835011"
9+
"templateHash": "11985360537269850534"
1010
},
1111
"name": "Content Processing Solution Accelerator",
1212
"description": "Bicep template to deploy the Content Processing Solution Accelerator with AVM compliance."
@@ -15,8 +15,10 @@
1515
"solutionName": {
1616
"type": "string",
1717
"defaultValue": "cps",
18+
"minLength": 3,
19+
"maxLength": 20,
1820
"metadata": {
19-
"description": "Required. Name of the solution to deploy."
21+
"description": "Required. Name of the solution to deploy. This should be 3-20 characters long:"
2022
}
2123
},
2224
"location": {
@@ -32964,8 +32966,8 @@
3296432966
"avmContainerApp",
3296532967
"avmContainerApp_API",
3296632968
"avmManagedIdentity",
32967-
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').storageBlob)]",
3296832969
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').storageQueue)]",
32970+
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').storageBlob)]",
3296932971
"virtualNetwork"
3297032972
]
3297132973
},
@@ -38706,10 +38708,10 @@
3870638708
"dependsOn": [
3870738709
"avmContainerApp",
3870838710
"avmManagedIdentity",
38709-
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').aiServices)]",
3871038711
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').contentUnderstanding)]",
3871138712
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').openAI)]",
3871238713
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').cognitiveServices)]",
38714+
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').aiServices)]",
3871338715
"logAnalyticsWorkspace",
3871438716
"virtualNetwork"
3871538717
]
@@ -41049,6 +41051,7 @@
4104941051
"avmManagedIdentity",
4105041052
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').contentUnderstanding)]",
4105141053
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').cognitiveServices)]",
41054+
"[format('avmPrivateDnsZones[{0}]', variables('dnsZoneIndex').cognitiveServices)]",
4105241055
"virtualNetwork"
4105341056
]
4105441057
},

0 commit comments

Comments
 (0)